Updated API from documentation release

commercetools · Dec 8, 2023 · 42782cb · 42782cb
1 parent 325c65b
commit 42782cb
Show file tree

Hide file tree

Showing 25 changed files with 63 additions and 65 deletions.
diff --git a/api-specs/history/types/change/AddAddressChange.raml b/api-specs/history/types/change/AddAddressChange.raml
@@ -13,9 +13,6 @@ properties:
     type: string
     enum:
       - AddAddressChange
-  previousValue:
-    type: Address
-    description: Value before the change.
   nextValue:
     type: Address
     description: Value after the change.
diff --git a/api-specs/history/types/change/AddChannelRolesChange.raml b/api-specs/history/types/change/AddChannelRolesChange.raml
@@ -16,10 +16,10 @@ properties:
   previousValue:
     type: array
     items:
-      type: ChannelRole
+      type: ChannelRoleEnum
     description: Value before the change.
   nextValue:
     type: array
     items:
-      type: ChannelRole
+      type: ChannelRoleEnum
     description: Value after the change.
diff --git a/api-specs/history/types/change/AddLocalizedEnumValueChange.raml b/api-specs/history/types/change/AddLocalizedEnumValueChange.raml
@@ -18,7 +18,7 @@ properties:
     enum:
       - addLocalizedEnumValue
   nextValue:
-    type: LocalizedEnumValue
+    type: AttributeLocalizedEnumValue
     description: Value after the change.
   fieldName:
     type: string

diff --git a/api-specs/history/types/change/AddLocationChange.raml b/api-specs/history/types/change/AddLocationChange.raml
@@ -13,9 +13,6 @@ properties:
     type: string
     enum:
       - addLocation
-  previousValue:
-    type: Location
-    description: Value before the change.
   nextValue:
     type: Location
     description: Value after the change.
diff --git a/api-specs/history/types/change/AddPlainEnumValueChange.raml b/api-specs/history/types/change/AddPlainEnumValueChange.raml
@@ -14,7 +14,7 @@ properties:
     enum:
       - addPlainEnumValue
   nextValue:
-    type: EnumValue
+    type: AttributePlainEnumValue
     description: Value after the change.
   attributeName:
     type: string

diff --git a/api-specs/history/types/change/AddStateRolesChange.raml b/api-specs/history/types/change/AddStateRolesChange.raml
@@ -16,10 +16,10 @@ properties:
   previousValue:
     type: array
     items:
-      type: StateRole
+      type: StateRoleEnum
     description: Value before the change.
   nextValue:
     type: array
     items:
-      type: StateRole
+      type: StateRoleEnum
     description: Value after the change.
diff --git a/api-specs/history/types/change/ChangeDescriptionChange.raml b/api-specs/history/types/change/ChangeDescriptionChange.raml
@@ -4,10 +4,8 @@ type: Change
 displayName: ChangeDescriptionChange
 discriminatorValue: ChangeDescriptionChange
 description: |
-  Change triggered by the following update actions:
+  Change triggered by the [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) update action.
 
-  - [Change Description](ctp:api:type:ChannelChangeDescriptionAction) on Channels.
-  - [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) on Product Types.
 properties:
   type:
     type: string

diff --git a/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml b/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml
@@ -4,10 +4,8 @@ type: Change
 displayName: ChangeLocalizedDescriptionChange
 discriminatorValue: ChangeLocalizedDescriptionChange
 description: |
-  Change triggered by the following update actions:
+  Change triggered by the [Change Description](ctp:api:type:ChannelChangeDescriptionAction) update action.
 
-  - [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) on Product Types.
-  - [Change Description](ctp:api:type:ChannelChangeDescriptionAction) on Channels.
 properties:
   type:
     type: string

diff --git a/api-specs/history/types/change/ChangeLocalizedNameChange.raml b/api-specs/history/types/change/ChangeLocalizedNameChange.raml
@@ -9,14 +9,10 @@ description: |
   - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts.
   - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories.
   - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels.
-  - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups.
   - [Change Name](ctp:api:type:ProductChangeNameAction) on Products.
   - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts.
   - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections.
-  - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types.
   - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists.
-  - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories.
-  - [Change Name](ctp:api:type:TypeChangeNameAction) on Types.
   - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones.
 properties:
   type:

diff --git a/api-specs/history/types/change/ChangeNameChange.raml b/api-specs/history/types/change/ChangeNameChange.raml
@@ -6,17 +6,9 @@ discriminatorValue: ChangeNameChange
 description: |
   Change triggered by the following update actions:
 
-  - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts.
-  - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories.
-  - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels.
   - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups.
-  - [Change Name](ctp:api:type:ProductChangeNameAction) on Products.
-  - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts.
-  - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections.
   - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types.
-  - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists.
   - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories.
-  - [Change Name](ctp:api:type:TypeChangeNameAction) on Types.
   - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones.
 properties:
   type:

diff --git a/api-specs/history/types/change/ChangeStateTypeChange.raml b/api-specs/history/types/change/ChangeStateTypeChange.raml
@@ -14,8 +14,8 @@ properties:
     enum:
       - changeType
   previousValue:
-    type: StateType
+    type: StateTypeEnum
     description: Value before the change.
   nextValue:
-    type: StateType
+    type: StateTypeEnum
     description: Value after the change.
diff --git a/api-specs/history/types/change/RemoveChannelRolesChange.raml b/api-specs/history/types/change/RemoveChannelRolesChange.raml
@@ -16,10 +16,10 @@ properties:
   previousValue:
     type: array
     items:
-      type: ChannelRole
+      type: ChannelRoleEnum
     description: Value before the change.
   nextValue:
     type: array
     items:
-      type: ChannelRole
+      type: ChannelRoleEnum
     description: Value after the change.
diff --git a/api-specs/history/types/change/RemoveLocationChange.raml b/api-specs/history/types/change/RemoveLocationChange.raml
@@ -16,6 +16,3 @@ properties:
   previousValue:
     type: Location
     description: Value before the change.
-  nextValue:
-    type: Location
-    description: Value after the change.
diff --git a/api-specs/history/types/change/RemoveStateRolesChange.raml b/api-specs/history/types/change/RemoveStateRolesChange.raml
@@ -16,10 +16,10 @@ properties:
   previousValue:
     type: array
     items:
-      type: StateRole
+      type: StateRoleEnum
     description: Value before the change.
   nextValue:
     type: array
     items:
-      type: StateRole
+      type: StateRoleEnum
     description: Value after the change.
diff --git a/api-specs/history/types/change/RemoveTaxRateChange.raml b/api-specs/history/types/change/RemoveTaxRateChange.raml
@@ -16,6 +16,3 @@ properties:
   previousValue:
     type: TaxRate
     description: Value before the change.
-  nextValue:
-    type: TaxRate
-    description: Value after the change.
diff --git a/api-specs/history/types/change/SetChannelRolesChange.raml b/api-specs/history/types/change/SetChannelRolesChange.raml
@@ -16,10 +16,10 @@ properties:
   previousValue:
     type: array
     items:
-      type: ChannelRole
+      type: ChannelRoleEnum
     description: Value before the change.
   nextValue:
     type: array
     items:
-      type: ChannelRole
+      type: ChannelRoleEnum
     description: Value after the change.
diff --git a/api-specs/history/types/change/SetDescriptionChange.raml b/api-specs/history/types/change/SetDescriptionChange.raml
@@ -6,15 +6,7 @@ discriminatorValue: SetDescriptionChange
 description: |
   Change triggered by the following update actions:
 
-  - [Set Description](ctp:api:type:CartDiscountSetDescriptionAction) on Cart Discounts.
-  - [Set Description](ctp:api:type:CategorySetDescriptionAction) on Categories.
-  - [Set Description](ctp:api:type:DiscountCodeSetDescriptionAction) on Discount Codes.
-  - [Set Description](ctp:api:type:ProductSetDescriptionAction) on Products.
-  - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts.
-  - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists.
-  - [Set Description](ctp:api:type:StateSetDescriptionAction) on States.
   - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories.
-  - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types.
   - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones.
 properties:
   type:

diff --git a/api-specs/history/types/change/SetLocalizedDescriptionChange.raml b/api-specs/history/types/change/SetLocalizedDescriptionChange.raml
@@ -13,9 +13,7 @@ description: |
   - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts.
   - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists.
   - [Set Description](ctp:api:type:StateSetDescriptionAction) on States.
-  - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories.
   - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types.
-  - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones.
 properties:
   type:
     type: string

diff --git a/api-specs/history/types/change/SetStateRolesChange.raml b/api-specs/history/types/change/SetStateRolesChange.raml
@@ -16,10 +16,10 @@ properties:
   previousValue:
     type: array
     items:
-      type: StateRole
+      type: StateRoleEnum
     description: Value before the change.
   nextValue:
     type: array
     items:
-      type: StateRole
+      type: StateRoleEnum
     description: Value after the change.
diff --git a/api-specs/history/types/common/AttributeLocalizedEnumValue.raml b/api-specs/history/types/common/AttributeLocalizedEnumValue.raml
@@ -0,0 +1,15 @@
+#%RAML 1.0 DataType
+(package): Common
+type: object
+displayName: AttributeLocalizedEnumValue
+description: |
+  A localized enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned.
+properties:
+  key:
+    type: string
+    description: |
+      Key of the value used as a programmatic identifier, for example in facets & filters.
+  label:
+    type: LocalizedString
+    description: |
+      Descriptive, localized label of the value.
diff --git a/api-specs/history/types/common/AttributePlainEnumValue.raml b/api-specs/history/types/common/AttributePlainEnumValue.raml
@@ -0,0 +1,15 @@
+#%RAML 1.0 DataType
+(package): Common
+type: object
+displayName: AttributePlainEnumValue
+description: |
+  A plain enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned.
+properties:
+  key:
+    type: string
+    description: |
+      Key of the value used as a programmatic identifier, for example in facets & filters.
+  label:
+    type: string
+    description: |
+      Descriptive label of the value.
diff --git a/...ecs/history/types/common/ChannelRole.raml → ...history/types/common/ChannelRoleEnum.raml b/...ecs/history/types/common/ChannelRole.raml → ...history/types/common/ChannelRoleEnum.raml
@@ -1,8 +1,9 @@
 #%RAML 1.0 DataType
 (package): Common
+displayName: ChannelRoleEnum
 type: string
-displayName: ChannelRole
-description:
+description: |
+  Describes the purpose and type of the Channel. A Channel can have one or more roles.
 enum:
   - InventorySupply
   - ProductDistribution

diff --git a/...specs/history/types/common/StateRole.raml → ...s/history/types/common/StateRoleEnum.raml b/...specs/history/types/common/StateRole.raml → ...s/history/types/common/StateRoleEnum.raml
@@ -1,8 +1,8 @@
 #%RAML 1.0 DataType
 (package): Common
 type: string
-displayName: StateRole
-description:
+description: |
+  For some resource types, a State can fulfill the following predefined roles:
 enum:
   - ReviewIncludedInStatistics
   - Return
diff --git a/...specs/history/types/common/StateType.raml → ...s/history/types/common/StateTypeEnum.raml b/...specs/history/types/common/StateType.raml → ...s/history/types/common/StateTypeEnum.raml
@@ -1,11 +1,14 @@
 #%RAML 1.0 DataType
 (package): Common
 type: string
-displayName: StateType
-description:
+description: |
+  Resource or object type the State can be assigned to.
 enum:
   - OrderState
   - LineItemState
   - ProductState
   - ReviewState
   - PaymentState
+  - QuoteRequestState
+  - StagedQuoteState
+  - QuoteState
diff --git a/api-specs/history/types/types.raml b/api-specs/history/types/types.raml
@@ -59,6 +59,8 @@ AssociateRoleInheritanceMode: !include common/AssociateRoleInheritanceMode.raml
 AssociateRoleLabel: !include label/AssociateRoleLabel.raml
 AttributeConstraintEnum: !include common/AttributeConstraintEnum.raml
 AttributeDefinition: !include common/AttributeDefinition.raml
+AttributeLocalizedEnumValue: !include common/AttributeLocalizedEnumValue.raml
+AttributePlainEnumValue: !include common/AttributePlainEnumValue.raml
 AttributeType: !include common/AttributeType.raml
 AttributeValue: !include change/change-value/AttributeValue.raml
 AuthenticationMode: !include common/AuthenticationMode.raml
@@ -144,7 +146,7 @@ ChangeValueChange: !include change/ChangeValueChange.raml
 ChangeValueExternalChangeValue: !include change/change-value/ChangeValueExternalChangeValue.raml
 ChangeValueGiftLineItemChangeValue: !include change/change-value/ChangeValueGiftLineItemChangeValue.raml
 ChangeValueRelativeChangeValue: !include change/change-value/ChangeValueRelativeChangeValue.raml
-ChannelRole: !include common/ChannelRole.raml
+ChannelRoleEnum: !include common/ChannelRoleEnum.raml
 CountryCode: !include common/CountryCode.raml
 CurrencyCode: !include common/CurrencyCode.raml
 CustomFieldExpandedValue: !include change/change-value/CustomFieldExpandedValue.raml
@@ -408,8 +410,8 @@ ShoppingListLineItemValue: !include change/change-value/ShoppingListLineItemValu
 StackingMode: !include common/StackingMode.raml
 StagedQuoteLabel: !include label/StagedQuoteLabel.raml
 StagedQuoteState: !include common/StagedQuoteState.raml
-StateRole: !include common/StateRole.raml
-StateType: !include common/StateType.raml
+StateRoleEnum: !include common/StateRoleEnum.raml
+StateTypeEnum: !include common/StateTypeEnum.raml
 StoreCountry: !include common/StoreCountry.raml
 StringLabel: !include label/StringLabel.raml
 SubRate: !include common/SubRate.raml