From efe74ff3931aae55e055d243f79065c8fc69ec33 Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Fri, 10 Nov 2023 15:53:15 +0000 Subject: [PATCH] Updated API from documentation release --- .../associate-role/AssociateRoleResourceIdentifier.raml | 6 +++--- .../attribute-group/AttributeGroupResourceIdentifier.raml | 6 +++--- .../types/business-unit/BusinessUnitResourceIdentifier.raml | 6 +++--- .../types/cart-discount/CartDiscountResourceIdentifier.raml | 6 +++--- api-specs/api/types/cart/CartResourceIdentifier.raml | 6 +++--- .../api/types/category/CategoryResourceIdentifier.raml | 6 +++--- api-specs/api/types/channel/ChannelResourceIdentifier.raml | 6 +++--- .../customer-group/CustomerGroupResourceIdentifier.raml | 6 +++--- .../api/types/customer/CustomerResourceIdentifier.raml | 6 +++--- .../types/discount-code/DiscountCodeResourceIdentifier.raml | 6 +++--- .../types/inventory/InventoryEntryResourceIdentifier.raml | 6 +++--- .../api/types/order-edit/OrderEditResourceIdentifier.raml | 6 +++--- api-specs/api/types/payment/PaymentResourceIdentifier.raml | 6 +++--- .../product-discount/ProductDiscountResourceIdentifier.raml | 6 +++--- .../ProductSelectionResourceIdentifier.raml | 6 +++--- .../types/product-type/ProductTypeResourceIdentifier.raml | 6 +++--- api-specs/api/types/product/ProductResourceIdentifier.raml | 6 +++--- api-specs/api/types/review/ReviewResourceIdentifier.raml | 6 +++--- .../shipping-method/ShippingMethodResourceIdentifier.raml | 6 +++--- .../types/shopping-list/ShoppingListResourceIdentifier.raml | 6 +++--- api-specs/api/types/state/StateResourceIdentifier.raml | 6 +++--- api-specs/api/types/store/StoreResourceIdentifier.raml | 6 +++--- .../types/tax-category/TaxCategoryResourceIdentifier.raml | 6 +++--- api-specs/api/types/type/TypeResourceIdentifier.raml | 6 +++--- api-specs/api/types/zone/ZoneResourceIdentifier.raml | 6 +++--- 25 files changed, 75 insertions(+), 75 deletions(-) diff --git a/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml b/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml index 2a22e4f67..19b0659a8 100644 --- a/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml +++ b/api-specs/api/types/associate-role/AssociateRoleResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: AssociateRoleResourceIdentifier discriminatorValue: associate-role description: | - [ResourceIdentifier](ctp:api:type:TypeResourceIdentifier) of an [AssociateRole](ctp:api:type:AssociateRole). + [ResourceIdentifier](ctp:api:type:TypeResourceIdentifier) of an [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required. + Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole). Required if `key` is absent. key?: type: string description: | - Unique key of the referenced [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required. + Unique key of the referenced [AssociateRole](ctp:api:type:AssociateRole). Required if `id` is absent. diff --git a/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml b/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml index c5f06de93..720ff313d 100644 --- a/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml +++ b/api-specs/api/types/attribute-group/AttributeGroupResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: AttributeGroupResourceIdentifier discriminatorValue: attribute-group description: | - [ResourceIdentifier](/../api/types#resourceidentifier) to an [AttributeGroup](ctp:api:type:AttributeGroup). + [ResourceIdentifier](/../api/types#resourceidentifier) to an [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required. + Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Required if `key` is absent. key?: type: string description: | - User-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required. + User-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Required if `id` is absent. diff --git a/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml b/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml index 83f529df7..92c878384 100644 --- a/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml +++ b/api-specs/api/types/business-unit/BusinessUnitResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: BusinessUnitResourceIdentifier discriminatorValue: business-unit description: | - [ResourceIdentifier](/../api/types#resourceidentifier) to a [BusinessUnit](ctp:api:type:BusinessUnit). + [ResourceIdentifier](/../api/types#resourceidentifier) to a [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required. + Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `key` is absent. key?: type: string description: | - Unique key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required. + Unique key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `id` is absent. diff --git a/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml b/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml index 7c9a14ddf..4a78c524f 100644 --- a/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml +++ b/api-specs/api/types/cart-discount/CartDiscountResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CartDiscountResourceIdentifier discriminatorValue: cart-discount description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CartDiscount](ctp:api:type:CartDiscount). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required. + Unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Either `id` or `key` is required. + User-defined unique identifier of the referenced [CartDiscount](ctp:api:type:CartDiscount). Required if `id` is absent. diff --git a/api-specs/api/types/cart/CartResourceIdentifier.raml b/api-specs/api/types/cart/CartResourceIdentifier.raml index dba4a7dd7..06d1376dd 100644 --- a/api-specs/api/types/cart/CartResourceIdentifier.raml +++ b/api-specs/api/types/cart/CartResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CartResourceIdentifier discriminatorValue: cart description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Cart](ctp:api:type:Cart). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Cart](ctp:api:type:Cart). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Cart](ctp:api:type:Cart). Either `id` or `key` is required. + Unique identifier of the referenced [Cart](ctp:api:type:Cart). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Cart](ctp:api:type:Cart). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Cart](ctp:api:type:Cart). Required if `id` is absent. diff --git a/api-specs/api/types/category/CategoryResourceIdentifier.raml b/api-specs/api/types/category/CategoryResourceIdentifier.raml index 33a987d08..0cd0863a4 100644 --- a/api-specs/api/types/category/CategoryResourceIdentifier.raml +++ b/api-specs/api/types/category/CategoryResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CategoryResourceIdentifier discriminatorValue: category description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Category](ctp:api:type:Category). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Category](ctp:api:type:Category). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Category](ctp:api:type:Channel). Either `id` or `key` is required. + Unique identifier of the referenced [Category](ctp:api:type:Channel). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Category](ctp:api:type:Category). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Category](ctp:api:type:Category). Required if `id` is absent. diff --git a/api-specs/api/types/channel/ChannelResourceIdentifier.raml b/api-specs/api/types/channel/ChannelResourceIdentifier.raml index c23c7a369..e0797ee90 100644 --- a/api-specs/api/types/channel/ChannelResourceIdentifier.raml +++ b/api-specs/api/types/channel/ChannelResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ChannelResourceIdentifier discriminatorValue: channel description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Channel](ctp:api:type:Channel). Either `id` or `key` is required. + Unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Channel](ctp:api:type:Channel). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `id` is absent. diff --git a/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml b/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml index a2591f96f..082b98bc9 100644 --- a/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml +++ b/api-specs/api/types/customer-group/CustomerGroupResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CustomerGroupResourceIdentifier discriminatorValue: customer-group description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CustomerGroup](ctp:api:type:CustomerGroup). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required. + Unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Either `id` or `key` is required. + User-defined unique identifier of the referenced [CustomerGroup](ctp:api:type:CustomerGroup). Required if `id` is absent. diff --git a/api-specs/api/types/customer/CustomerResourceIdentifier.raml b/api-specs/api/types/customer/CustomerResourceIdentifier.raml index 4aa426234..a7b90bd90 100644 --- a/api-specs/api/types/customer/CustomerResourceIdentifier.raml +++ b/api-specs/api/types/customer/CustomerResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: CustomerResourceIdentifier discriminatorValue: customer description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Customer](ctp:api:type:Customer). Either `id` or `key` is required. + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Customer](ctp:api:type:Customer). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Customer](ctp:api:type:Customer). + Unique identifier of the referenced [Customer](ctp:api:type:Customer). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Customer](ctp:api:type:Customer). + User-defined unique identifier of the referenced [Customer](ctp:api:type:Customer). Required if `id` is absent. diff --git a/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml b/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml index 4a576ca32..a447f8cce 100644 --- a/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml +++ b/api-specs/api/types/discount-code/DiscountCodeResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: DiscountCodeResourceIdentifier discriminatorValue: discount-code description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [DiscountCode](ctp:api:type:DiscountCode). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required. + Unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Either `id` or `key` is required. + User-defined unique identifier of the referenced [DiscountCode](ctp:api:type:DiscountCode). Required if `id` is absent. diff --git a/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml b/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml index 92c0eeae3..83ee2199f 100644 --- a/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml +++ b/api-specs/api/types/inventory/InventoryEntryResourceIdentifier.raml @@ -4,13 +4,13 @@ type: ResourceIdentifier displayName: InventoryEntryResourceIdentifier discriminatorValue: inventory-entry description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required. + Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required. + User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Required if `id` is absent. diff --git a/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml b/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml index d9834d2ca..102d9cd88 100644 --- a/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml +++ b/api-specs/api/types/order-edit/OrderEditResourceIdentifier.raml @@ -4,13 +4,13 @@ type: ResourceIdentifier displayName: OrderEditResourceIdentifier discriminatorValue: order-edit description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required. + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). + Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). + User-defined unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `id` is absent. diff --git a/api-specs/api/types/payment/PaymentResourceIdentifier.raml b/api-specs/api/types/payment/PaymentResourceIdentifier.raml index deb6eaab8..5e657a7c8 100644 --- a/api-specs/api/types/payment/PaymentResourceIdentifier.raml +++ b/api-specs/api/types/payment/PaymentResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: PaymentResourceIdentifier discriminatorValue: payment description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Payment](ctp:api:type:Payment). Either `id` or `key` is required. + Unique identifier of the referenced [Payment](ctp:api:type:Payment). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Payment](ctp:api:type:Payment). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Payment](ctp:api:type:Payment). Required if `id` is absent. diff --git a/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml b/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml index 704da82d0..02bc4697d 100644 --- a/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml +++ b/api-specs/api/types/product-discount/ProductDiscountResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ProductDiscountResourceIdentifier discriminatorValue: product-discount description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductDiscount](ctp:api:type:ProductDiscount). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required. + Unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ProductDiscount](ctp:api:type:ProductDiscount). Required if `id` is absent. diff --git a/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml b/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml index daecdf269..03773fda0 100644 --- a/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml +++ b/api-specs/api/types/product-selection/ProductSelectionResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ProductSelectionResourceIdentifier discriminatorValue: product-selection description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductSelection](ctp:api:type:ProductSelection). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required. + Unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ProductSelection](ctp:api:type:ProductSelection). Required if `id` is absent. diff --git a/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml b/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml index 691181b3c..71765becd 100644 --- a/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml +++ b/api-specs/api/types/product-type/ProductTypeResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ProductTypeResourceIdentifier discriminatorValue: product-type description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductType](ctp:api:type:ProductType). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required. + Unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ProductType](ctp:api:type:ProductType). Required if `id` is absent. diff --git a/api-specs/api/types/product/ProductResourceIdentifier.raml b/api-specs/api/types/product/ProductResourceIdentifier.raml index 811d14660..8a0d36847 100644 --- a/api-specs/api/types/product/ProductResourceIdentifier.raml +++ b/api-specs/api/types/product/ProductResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ProductResourceIdentifier discriminatorValue: product description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Product](ctp:api:type:Product). Either `id` or `key` is required. + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Product](ctp:api:type:Product). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Product](ctp:api:type:Product). + Unique identifier of the referenced [Product](ctp:api:type:Product). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Product](ctp:api:type:Product). + User-defined unique identifier of the referenced [Product](ctp:api:type:Product). Required if `id` is absent. diff --git a/api-specs/api/types/review/ReviewResourceIdentifier.raml b/api-specs/api/types/review/ReviewResourceIdentifier.raml index 3c6f124ec..d20d98c8d 100644 --- a/api-specs/api/types/review/ReviewResourceIdentifier.raml +++ b/api-specs/api/types/review/ReviewResourceIdentifier.raml @@ -4,13 +4,13 @@ type: ResourceIdentifier displayName: ReviewResourceIdentifier discriminatorValue: review description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Review](ctp:api:type:Review). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Review](ctp:api:type:Review). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Review](ctp:api:type:Review). Either `id` or `key` is required. + Unique identifier of the referenced [Review](ctp:api:type:Review). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Review](ctp:api:type:Review). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Review](ctp:api:type:Review). Required if `id` is absent. diff --git a/api-specs/api/types/shipping-method/ShippingMethodResourceIdentifier.raml b/api-specs/api/types/shipping-method/ShippingMethodResourceIdentifier.raml index 21e4efe0d..20d661974 100644 --- a/api-specs/api/types/shipping-method/ShippingMethodResourceIdentifier.raml +++ b/api-specs/api/types/shipping-method/ShippingMethodResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ShippingMethodResourceIdentifier discriminatorValue: shipping-method description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShippingMethod](ctp:api:type:ShippingMethod). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShippingMethod](ctp:api:type:ShippingMethod). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Either `id` or `key` is required. + Unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ShippingMethod](ctp:api:type:ShippingMethod). Required if `id` is absent. diff --git a/api-specs/api/types/shopping-list/ShoppingListResourceIdentifier.raml b/api-specs/api/types/shopping-list/ShoppingListResourceIdentifier.raml index 1faf51511..67475e34c 100644 --- a/api-specs/api/types/shopping-list/ShoppingListResourceIdentifier.raml +++ b/api-specs/api/types/shopping-list/ShoppingListResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ShoppingListResourceIdentifier discriminatorValue: shopping-list description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShoppingList](ctp:api:type:ShoppingList). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShoppingList](ctp:api:type:ShoppingList). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Either `id` or `key` is required. + Unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Either `id` or `key` is required. + User-defined unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Required if `id` is absent. diff --git a/api-specs/api/types/state/StateResourceIdentifier.raml b/api-specs/api/types/state/StateResourceIdentifier.raml index dbe2fd41f..69a845fd6 100644 --- a/api-specs/api/types/state/StateResourceIdentifier.raml +++ b/api-specs/api/types/state/StateResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: StateResourceIdentifier discriminatorValue: state description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [State](ctp:api:type:State). Either `id` or `key` is required. + Unique identifier of the referenced [State](ctp:api:type:State). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [State](ctp:api:type:State). Either `id` or `key` is required. + User-defined unique identifier of the referenced [State](ctp:api:type:State). Required if `id` is absent. diff --git a/api-specs/api/types/store/StoreResourceIdentifier.raml b/api-specs/api/types/store/StoreResourceIdentifier.raml index 1ff3c3689..332d6b308 100644 --- a/api-specs/api/types/store/StoreResourceIdentifier.raml +++ b/api-specs/api/types/store/StoreResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: StoreResourceIdentifier discriminatorValue: store description: | - [ResourceIdentifier](/../api/types#resourceidentifier) to a [Store](ctp:api:type:Store). + [ResourceIdentifier](/../api/types#resourceidentifier) to a [Store](ctp:api:type:Store). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique ID of the referenced [Store](ctp:api:type:Store). Either `id` or `key` is required. + Unique ID of the referenced [Store](ctp:api:type:Store). Required if `key` is absent. key?: type: string description: | - Unique key of the referenced [Store](ctp:api:type:Store). Either `id` or `key` is required. + Unique key of the referenced [Store](ctp:api:type:Store). Required if `id` is absent. diff --git a/api-specs/api/types/tax-category/TaxCategoryResourceIdentifier.raml b/api-specs/api/types/tax-category/TaxCategoryResourceIdentifier.raml index 40ee1b911..5b79bdce4 100644 --- a/api-specs/api/types/tax-category/TaxCategoryResourceIdentifier.raml +++ b/api-specs/api/types/tax-category/TaxCategoryResourceIdentifier.raml @@ -5,16 +5,16 @@ type: ResourceIdentifier displayName: TaxCategoryResourceIdentifier discriminatorValue: tax-category description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [TaxCategory](ctp:api:type:TaxCategory). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [TaxCategory](ctp:api:type:TaxCategory). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Either `id` or `key` is required. + Unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Either `id` or `key` is required. + User-defined unique identifier of the referenced [TaxCategory](ctp:api:type:TaxCategory). Required if `id` is absent. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 diff --git a/api-specs/api/types/type/TypeResourceIdentifier.raml b/api-specs/api/types/type/TypeResourceIdentifier.raml index d97e0e568..1dbeedcdf 100644 --- a/api-specs/api/types/type/TypeResourceIdentifier.raml +++ b/api-specs/api/types/type/TypeResourceIdentifier.raml @@ -5,16 +5,16 @@ type: ResourceIdentifier displayName: TypeResourceIdentifier discriminatorValue: type description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Type](ctp:api:type:Type). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Type](ctp:api:type:Type). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Type](ctp:api:type:Type). Either `id` or `key` is required. + Unique identifier of the referenced [Type](ctp:api:type:Type). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Type](ctp:api:type:Type). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Type](ctp:api:type:Type). Required if `id` is absent. pattern: ^[A-Za-z0-9_-]+$ minLength: 2 maxLength: 256 diff --git a/api-specs/api/types/zone/ZoneResourceIdentifier.raml b/api-specs/api/types/zone/ZoneResourceIdentifier.raml index 12de49ede..34019aaeb 100644 --- a/api-specs/api/types/zone/ZoneResourceIdentifier.raml +++ b/api-specs/api/types/zone/ZoneResourceIdentifier.raml @@ -5,13 +5,13 @@ type: ResourceIdentifier displayName: ZoneResourceIdentifier discriminatorValue: zone description: | - [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Zone](ctp:api:type:Zone). + [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Zone](ctp:api:type:Zone). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned. properties: id?: type: string description: | - Unique identifier of the referenced [Zone](ctp:api:type:Zone). Either `id` or `key` is required. + Unique identifier of the referenced [Zone](ctp:api:type:Zone). Required if `key` is absent. key?: type: string description: | - User-defined unique identifier of the referenced [Zone](ctp:api:type:Zone). Either `id` or `key` is required. + User-defined unique identifier of the referenced [Zone](ctp:api:type:Zone). Required if `id` is absent.