TASK: Updating RAML types, Postman and OAS definition

commercetools · Jan 12, 2024 · 13961e9 · 13961e9
1 parent 24801f9
commit 13961e9
Show file tree

Hide file tree

Showing 212 changed files with 6,805 additions and 3,280 deletions.
diff --git a/oas/api/openapi.yaml b/oas/api/openapi.yaml
diff --git a/oas/history/openapi.yaml b/oas/history/openapi.yaml
@@ -1555,12 +1555,15 @@ components:
           required:
             - change
             - nextValue
+            - previousValue
             - type
           properties:
             type:
               type: "string"
             change:
               type: "string"
+            previousValue:
+              $ref: '#/components/schemas/Address'
             nextValue:
               $ref: '#/components/schemas/Address'
     AddAssetChange:
@@ -1653,11 +1656,11 @@ components:
             previousValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/ChannelRoleEnum'
+                $ref: '#/components/schemas/ChannelRole'
             nextValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/ChannelRoleEnum'
+                $ref: '#/components/schemas/ChannelRole'
     AddCustomLineItemChange:
       allOf:
         - $ref: '#/components/schemas/Change'
@@ -1831,7 +1834,7 @@ components:
             change:
               type: "string"
             nextValue:
-              $ref: '#/components/schemas/AttributeLocalizedEnumValue'
+              $ref: '#/components/schemas/LocalizedEnumValue'
             fieldName:
               type: "string"
             attributeName:
@@ -1843,12 +1846,15 @@ components:
           required:
             - change
             - nextValue
+            - previousValue
             - type
           properties:
             type:
               type: "string"
             change:
               type: "string"
+            previousValue:
+              $ref: '#/components/schemas/Location'
             nextValue:
               $ref: '#/components/schemas/Location'
     AddOrderLineItemChange:
@@ -1920,7 +1926,7 @@ components:
             change:
               type: "string"
             nextValue:
-              $ref: '#/components/schemas/AttributePlainEnumValue'
+              $ref: '#/components/schemas/EnumValue'
             attributeName:
               type: "string"
     AddPriceChange:
@@ -2073,11 +2079,11 @@ components:
             previousValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/StateRoleEnum'
+                $ref: '#/components/schemas/StateRole'
             nextValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/StateRoleEnum'
+                $ref: '#/components/schemas/StateRole'
     AddTaxRateChange:
       allOf:
         - $ref: '#/components/schemas/Change'
@@ -2384,26 +2390,6 @@ components:
           $ref: '#/components/schemas/TextInputHint'
         isSearchable:
           type: "boolean"
-    AttributeLocalizedEnumValue:
-      type: "object"
-      required:
-        - key
-        - label
-      properties:
-        key:
-          type: "string"
-        label:
-          $ref: '#/components/schemas/LocalizedString'
-    AttributePlainEnumValue:
-      type: "object"
-      required:
-        - key
-        - label
-      properties:
-        key:
-          type: "string"
-        label:
-          type: "string"
     AttributeType:
       type: "object"
       required:
@@ -3594,9 +3580,9 @@ components:
             change:
               type: "string"
             previousValue:
-              $ref: '#/components/schemas/StateTypeEnum'
+              $ref: '#/components/schemas/StateType'
             nextValue:
-              $ref: '#/components/schemas/StateTypeEnum'
+              $ref: '#/components/schemas/StateType'
     ChangeStatusChange:
       allOf:
         - $ref: '#/components/schemas/Change'
@@ -3978,7 +3964,7 @@ components:
             permyriad:
               type: "integer"
               format: "int32"
-    ChannelRoleEnum:
+    ChannelRole:
       type: "string"
       enum:
         - InventorySupply
@@ -4918,11 +4904,11 @@ components:
             previousValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/ChannelRoleEnum'
+                $ref: '#/components/schemas/ChannelRole'
             nextValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/ChannelRoleEnum'
+                $ref: '#/components/schemas/ChannelRole'
     RemoveCustomLineItemChange:
       allOf:
         - $ref: '#/components/schemas/Change'
@@ -5111,6 +5097,7 @@ components:
         - type: "object"
           required:
             - change
+            - nextValue
             - previousValue
             - type
           properties:
@@ -5120,6 +5107,8 @@ components:
               type: "string"
             previousValue:
               $ref: '#/components/schemas/Location'
+            nextValue:
+              $ref: '#/components/schemas/Location'
     RemoveOrderLineItemChange:
       allOf:
         - $ref: '#/components/schemas/Change'
@@ -5306,17 +5295,18 @@ components:
             previousValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/StateRoleEnum'
+                $ref: '#/components/schemas/StateRole'
             nextValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/StateRoleEnum'
+                $ref: '#/components/schemas/StateRole'
     RemoveTaxRateChange:
       allOf:
         - $ref: '#/components/schemas/Change'
         - type: "object"
           required:
             - change
+            - nextValue
             - previousValue
             - type
           properties:
@@ -5326,6 +5316,8 @@ components:
               type: "string"
             previousValue:
               $ref: '#/components/schemas/TaxRate'
+            nextValue:
+              $ref: '#/components/schemas/TaxRate'
     RemoveTextLineItemChange:
       allOf:
         - $ref: '#/components/schemas/Change'
@@ -5945,11 +5937,11 @@ components:
             previousValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/ChannelRoleEnum'
+                $ref: '#/components/schemas/ChannelRole'
             nextValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/ChannelRoleEnum'
+                $ref: '#/components/schemas/ChannelRole'
     SetCompanyNameChange:
       allOf:
         - $ref: '#/components/schemas/Change'
@@ -8122,11 +8114,11 @@ components:
             previousValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/StateRoleEnum'
+                $ref: '#/components/schemas/StateRole'
             nextValue:
               type: "array"
               items:
-                $ref: '#/components/schemas/StateRoleEnum'
+                $ref: '#/components/schemas/StateRole'
     SetStatusInterfaceCodeChange:
       allOf:
         - $ref: '#/components/schemas/Change'
@@ -8684,23 +8676,20 @@ components:
         - Sent
         - Closed
       x-annotation-package: "Common"
-    StateRoleEnum:
+    StateRole:
       type: "string"
       enum:
         - ReviewIncludedInStatistics
         - Return
       x-annotation-package: "Common"
-    StateTypeEnum:
+    StateType:
       type: "string"
       enum:
         - OrderState
         - LineItemState
         - ProductState
         - ReviewState
         - PaymentState
-        - QuoteRequestState
-        - StagedQuoteState
-        - QuoteState
       x-annotation-package: "Common"
     StoreCountry:
       type: "object"

diff --git a/uml/api/ApprovalFlow.puml b/uml/api/ApprovalFlow.puml
@@ -24,7 +24,6 @@ interface ApprovalFlow [[ApprovalFlow.svg]] extends BaseResource {
     eligibleApprovers: [[RuleApprover.svg List<RuleApprover>]]
     pendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
     currentTierPendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
-    custom: [[CustomFields.svg CustomFields]]
 }
 interface BaseResource [[BaseResource.svg]]  {
     id: String

diff --git a/uml/api/ApprovalFlowApproval.puml b/uml/api/ApprovalFlowApproval.puml
@@ -31,7 +31,6 @@ interface ApprovalFlow [[ApprovalFlow.svg]]  {
     eligibleApprovers: [[RuleApprover.svg List<RuleApprover>]]
     pendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
     currentTierPendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
-    custom: [[CustomFields.svg CustomFields]]
 }
 
 ApprovalFlowApproval --> ApprovalFlow #green;text:green : "approvals"

diff --git a/uml/api/ApprovalFlowRejection.puml b/uml/api/ApprovalFlowRejection.puml
@@ -32,7 +32,6 @@ interface ApprovalFlow [[ApprovalFlow.svg]]  {
     eligibleApprovers: [[RuleApprover.svg List<RuleApprover>]]
     pendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
     currentTierPendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
-    custom: [[CustomFields.svg CustomFields]]
 }
 
 ApprovalFlowRejection --> ApprovalFlow #green;text:green : "rejection"

diff --git a/uml/api/ApprovalFlowSetCustomTypeAction.puml b/uml/api/ApprovalFlowSetCustomTypeAction.puml
diff --git a/uml/api/ApprovalFlowStatus.puml b/uml/api/ApprovalFlowStatus.puml
@@ -22,7 +22,6 @@ interface ApprovalFlow [[ApprovalFlow.svg]]  {
     eligibleApprovers: [[RuleApprover.svg List<RuleApprover>]]
     pendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
     currentTierPendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
-    custom: [[CustomFields.svg CustomFields]]
 }
 interface ApprovalFlowCompletedMessage [[ApprovalFlowCompletedMessage.svg]]  {
     id: String

diff --git a/uml/api/ApprovalFlowUpdateAction.puml b/uml/api/ApprovalFlowUpdateAction.puml
@@ -20,23 +20,11 @@ interface ApprovalFlowRejectAction [[ApprovalFlowRejectAction.svg]]  {
     action: String
     reason: String
 }
-interface ApprovalFlowSetCustomFieldAction [[ApprovalFlowSetCustomFieldAction.svg]]  {
-    action: String
-    name: String
-    value: [[Object.svg Object]]
-}
-interface ApprovalFlowSetCustomTypeAction [[ApprovalFlowSetCustomTypeAction.svg]]  {
-    action: String
-    type: [[TypeResourceIdentifier.svg TypeResourceIdentifier]]
-    fields: [[FieldContainer.svg FieldContainer]]
-}
 interface ApprovalFlowUpdate [[ApprovalFlowUpdate.svg]]  {
     version: Long
     actions: [[ApprovalFlowUpdateAction.svg List<ApprovalFlowUpdateAction>]]
 }
 ApprovalFlowUpdateAction --> ApprovalFlowApproveAction #blue;text:blue : "action : approve"
 ApprovalFlowUpdateAction --> ApprovalFlowRejectAction #blue;text:blue : "action : reject"
-ApprovalFlowUpdateAction --> ApprovalFlowSetCustomFieldAction #blue;text:blue : "action : setCustomField"
-ApprovalFlowUpdateAction --> ApprovalFlowSetCustomTypeAction #blue;text:blue : "action : setCustomType"
 ApprovalFlowUpdateAction --> ApprovalFlowUpdate #green;text:green : "actions"
 @enduml
diff --git a/uml/api/ApprovalRule.puml b/uml/api/ApprovalRule.puml
@@ -48,7 +48,6 @@ interface ApprovalFlow [[ApprovalFlow.svg]]  {
     eligibleApprovers: [[RuleApprover.svg List<RuleApprover>]]
     pendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
     currentTierPendingApprovers: [[RuleApprover.svg List<RuleApprover>]]
-    custom: [[CustomFields.svg CustomFields]]
 }
 interface ApprovalRulePagedQueryResponse [[ApprovalRulePagedQueryResponse.svg]]  {
     limit: Long

diff --git a/uml/api/AttributeReferenceTypeId.puml b/uml/api/AttributeReferenceTypeId.puml
@@ -2,10 +2,7 @@
 
 hide methods
 enum AttributeReferenceTypeId {
-    ASSOCIATE_ROLE
-    BUSINESS_UNIT
     CART
-    CART_DISCOUNT
     CATEGORY
     CHANNEL
     CUSTOMER