From 95a0e9a4da4d93d49c362d63aa3f0a8a7dbda1b3 Mon Sep 17 00:00:00 2001 From: Ren Chaturvedi Date: Mon, 9 Mar 2026 16:15:20 -0400 Subject: [PATCH 1/2] Revise API names to align with new nav experience --- .../docs/surfaces/checkout/reference/apis/address.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/analytics.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/attributes.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts | 2 +- .../surfaces/checkout/reference/apis/cart-instructions.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/cart-lines.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/checkout-token.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/cost.doc.ts | 2 +- .../surfaces/checkout/reference/apis/customer-privacy.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/delivery.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/discounts.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/extension-meta.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/gift-cards.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/localization.doc.ts | 2 +- .../surfaces/checkout/reference/apis/localized-fields.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/metafields.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/note.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/order.doc.ts | 2 +- .../surfaces/checkout/reference/apis/payment-options.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/session-token.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/settings.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/shop.doc.ts | 2 +- .../docs/surfaces/checkout/reference/apis/storage.doc.ts | 2 +- 24 files changed, 24 insertions(+), 24 deletions(-) diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts index fc49bc9db2..83ad515b6a 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts @@ -8,7 +8,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Addresses', + name: 'Addresses API', description: 'The API for interacting with addresses.', isVisualComponent: false, requires: REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2, diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts index 4439fdf4c7..1fb2dc5741 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Analytics', + name: 'Analytics API', description: 'The API for interacting with web pixels.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts index 0dfa4e2789..07b4fd77c3 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts @@ -9,7 +9,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Attributes', + name: 'Attributes API', description: 'The API for interacting with cart and checkout attributes.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts index ac5a92e7d4..a65ac2fb63 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Buyer Identity', + name: 'Buyer Identity API', description: 'The API for interacting with the buyer identity.', requires: REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2, isVisualComponent: false, diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts index 8c4cd2bdc5..53fc443d86 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Buyer Journey', + name: 'Buyer Journey API', description: 'The API for interacting with the buyer journey.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts index 2164708cc2..9ce9056373 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Cart Instructions', + name: 'Cart Instructions API', description: 'Instructions used to create the checkout.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts index c205cf10a3..dc2ef41b62 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts @@ -8,7 +8,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Cart Lines', + name: 'Cart Lines API', description: 'The API for interacting with the cart lines.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts index 7e8bdcbdf9..1f742facaf 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts @@ -6,7 +6,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Checkout Token', + name: 'Checkout Token API', description: 'The API for interacting with the token of a checkout.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts index 31f6d5e39f..e8cc94c13d 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts @@ -6,7 +6,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Cost', + name: 'Cost API', description: 'The API for interacting with the cost of a checkout.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts index f784c52de9..ac1f08cf94 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts @@ -8,7 +8,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Customer Privacy', + name: 'Customer Privacy API', description: "The API for interacting with a customer's privacy consent. It is similar to the [Customer Privacy API in storefront](/docs/api/customer-privacy).", isVisualComponent: false, diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts index 975eb9af94..082306a1e0 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts @@ -8,7 +8,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Delivery', + name: 'Delivery API', description: ` The APIs for interacting with delivery and shipping options. diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts index e7a61d82d4..22a3463c1f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Discounts', + name: 'Discounts API', description: 'The API for interacting with discounts.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts index a764fc0fa6..5f615c0ad5 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts @@ -6,7 +6,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Extension', + name: 'Extension API', description: 'The API for interacting with the metadata of an extension.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts index daa8a766f9..614a77d965 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Gift Cards', + name: 'Gift Cards API', description: 'The API for interacting with gift cards.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts index af53ca9a2f..d344f90794 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Localization', + name: 'Localization API', description: 'The APIs for localizing your extension.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts index 29ede432a3..0bcd69030c 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts @@ -8,7 +8,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Localized Fields', + name: 'Localized Fields API', description: 'The API for interacting with localized fields.', isVisualComponent: false, requires: REQUIRES_PROTECTED_CUSTOMER_DATA, diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts index 02fed0fdae..85c9709efd 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts @@ -9,7 +9,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Metafields', + name: 'Metafields API', description: 'The API for interacting with metafields.', isVisualComponent: false, requires: REQUIRES_PROTECTED_CUSTOMER_DATA, diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts index 1b791f3bfa..6fd9e6d910 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Note', + name: 'Note API', description: 'The API for interacting with the note applied to checkout.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts index fccd57fdd6..452e3d5781 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts @@ -16,7 +16,7 @@ import { interface OrderStatusApiEmpty {} const data: ReferenceEntityTemplateSchema = { - name: 'Order', + name: 'Order API', description: 'The API for interacting with the order confirmation, available on the **Thank You** page.', isVisualComponent: false, diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts index 147bc74e3b..d17054b568 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Payments', + name: 'Payments API', description: 'The API for interacting with the payment options.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts index 959677586f..8f6b995bec 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Session Token', + name: 'Session Token API', description: 'The API for interacting with session tokens.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts index 07add9ec5a..9a8145b2ec 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Settings', + name: 'Settings API', description: 'The API for interacting with merchant settings.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts index cf475536b8..03de64b905 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts @@ -6,7 +6,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Shop', + name: 'Shop API', description: 'The API for interacting with shop.', isVisualComponent: false, category: 'APIs', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts index 931efadbfa..63be565eed 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts @@ -7,7 +7,7 @@ import { } from '../helper.docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Storage', + name: 'Storage API', description: 'The API for interacting with local storage.', isVisualComponent: false, category: 'APIs', From 75c1bbdd16e93cb8ca6bfe1735cce323b662576b Mon Sep 17 00:00:00 2001 From: Ren Chaturvedi Date: Wed, 11 Mar 2026 12:10:32 -0400 Subject: [PATCH 2/2] Add category/subCategory fields to checkout API doc.ts files --- .../docs/surfaces/checkout/reference/apis/address.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/analytics.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/attributes.doc.ts | 3 ++- .../surfaces/checkout/reference/apis/buyer-identity.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts | 3 ++- .../surfaces/checkout/reference/apis/cart-instructions.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/cart-lines.doc.ts | 3 ++- .../surfaces/checkout/reference/apis/checkout-token.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/cost.doc.ts | 3 ++- .../surfaces/checkout/reference/apis/customer-privacy.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/delivery.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/discounts.doc.ts | 3 ++- .../surfaces/checkout/reference/apis/extension-meta.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/gift-cards.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/localization.doc.ts | 3 ++- .../surfaces/checkout/reference/apis/localized-fields.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/metafields.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/note.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/order.doc.ts | 3 ++- .../surfaces/checkout/reference/apis/payment-options.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/query.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/session-token.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/settings.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/shop.doc.ts | 3 ++- .../docs/surfaces/checkout/reference/apis/storage.doc.ts | 3 ++- 25 files changed, 50 insertions(+), 25 deletions(-) diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts index 83ad515b6a..213a5b3674 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts @@ -12,7 +12,8 @@ const data: ReferenceEntityTemplateSchema = { description: 'The API for interacting with addresses.', isVisualComponent: false, requires: REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts index 1fb2dc5741..b09edcd99f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Analytics API', description: 'The API for interacting with web pixels.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts index 07b4fd77c3..c782713338 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts @@ -12,7 +12,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Attributes API', description: 'The API for interacting with cart and checkout attributes.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts index a65ac2fb63..6bf23cc51b 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts @@ -11,7 +11,8 @@ const data: ReferenceEntityTemplateSchema = { description: 'The API for interacting with the buyer identity.', requires: REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2, isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts index 53fc443d86..50e1524a35 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Buyer Journey API', description: 'The API for interacting with the buyer journey.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts index 9ce9056373..2e8f67f1c2 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Cart Instructions API', description: 'Instructions used to create the checkout.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts index dc2ef41b62..8c4186036d 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts @@ -11,7 +11,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Cart Lines API', description: 'The API for interacting with the cart lines.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts index 1f742facaf..b5d7d260b7 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts @@ -9,7 +9,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Checkout Token API', description: 'The API for interacting with the token of a checkout.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts index e8cc94c13d..19ec36bd62 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts @@ -9,7 +9,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Cost API', description: 'The API for interacting with the cost of a checkout.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts index ac1f08cf94..265a9db438 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts @@ -13,7 +13,8 @@ const data: ReferenceEntityTemplateSchema = { "The API for interacting with a customer's privacy consent. It is similar to the [Customer Privacy API in storefront](/docs/api/customer-privacy).", isVisualComponent: false, requires: REQUIRES_PROTECTED_CUSTOMER_DATA, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts index 082306a1e0..69d60717a1 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts @@ -17,7 +17,8 @@ const data: ReferenceEntityTemplateSchema = { overviewPreviewDescription: 'The APIs for interacting with delivery and shipping options.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts index 22a3463c1f..aead1ea837 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Discounts API', description: 'The API for interacting with discounts.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts index 5f615c0ad5..00187fff95 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts @@ -9,7 +9,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Extension API', description: 'The API for interacting with the metadata of an extension.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts index 614a77d965..778671d4e6 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Gift Cards API', description: 'The API for interacting with gift cards.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts index d344f90794..ad9b689254 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Localization API', description: 'The APIs for localizing your extension.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts index 0bcd69030c..fb512922d0 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts @@ -12,7 +12,8 @@ const data: ReferenceEntityTemplateSchema = { description: 'The API for interacting with localized fields.', isVisualComponent: false, requires: REQUIRES_PROTECTED_CUSTOMER_DATA, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts index 85c9709efd..4770d9b940 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts @@ -13,7 +13,8 @@ const data: ReferenceEntityTemplateSchema = { description: 'The API for interacting with metafields.', isVisualComponent: false, requires: REQUIRES_PROTECTED_CUSTOMER_DATA, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts index 6fd9e6d910..1f2af6f39f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Note API', description: 'The API for interacting with the note applied to checkout.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts index 452e3d5781..03d95ba829 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts @@ -20,7 +20,8 @@ const data: ReferenceEntityTemplateSchema = { description: 'The API for interacting with the order confirmation, available on the **Thank You** page.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', defaultExample: getExample('order-confirmation/default', ['jsx']), definitions: [ diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts index d17054b568..76ea061338 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Payments API', description: 'The API for interacting with the payment options.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Checkout APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts index 4bd6446adc..a873ed768f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Storefront API', description: 'Querying the Storefront API.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts index 8f6b995bec..68cdfed1d1 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Session Token API', description: 'The API for interacting with session tokens.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts index 9a8145b2ec..bd4fc6ec5d 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Settings API', description: 'The API for interacting with merchant settings.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts index 03de64b905..987c926d69 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts @@ -9,7 +9,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Shop API', description: 'The API for interacting with shop.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ { diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts index 63be565eed..6197e0f716 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts @@ -10,7 +10,8 @@ const data: ReferenceEntityTemplateSchema = { name: 'Storage API', description: 'The API for interacting with local storage.', isVisualComponent: false, - category: 'APIs', + category: 'Target APIs', + subCategory: 'Platform APIs', type: 'API', definitions: [ {