TASK: Updating RAML types, Postman and OAS definition

commercetools · Feb 5, 2025 · a980bcc · a980bcc
1 parent b71e64c
commit a980bcc
Show file tree

Hide file tree

Showing 55 changed files with 822 additions and 561 deletions.
diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetBusinessUnit.bru b/bruno/api/Project/Shopping-lists/Update actions/SetBusinessUnit.bru
@@ -0,0 +1,57 @@
+meta {
+  name: SetBusinessUnit
+  type: http
+  seq: 727
+}
+
+post {
+  url: {{apiUrl}}/{{project-key}}/shopping-lists/{{shopping-list-id}}
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+      "version": {{shopping-list-version}},
+      "actions": [
+          {
+              "action" : "setBusinessUnit",
+              "businessUnit" : {
+                "key" : "{{business-unit-key}}",
+                "typeId" : "business-unit"
+              }
+            }
+      ]
+  }
+}  
+
+query {
+  ~expand: 
+}
+
+script:post-response {
+  var data = res.body;
+  if(res.status == 200 || res.status == 201) {
+      if(data.results && data.results[0] && data.results[0].id && data.results[0].version){
+          bru.setEnvVar("shopping-list-id", data.results[0].id); 
+          bru.setEnvVar("shopping-list-version", data.results[0].version);
+      }
+      if(data.results && data.results[0] && data.results[0].key){
+          bru.setEnvVar("shopping-list-key", data.results[0].key); 
+      }
+      if(data.version){
+          bru.setEnvVar("shopping-list-version", data.version);
+      }
+      if(data.id){
+          bru.setEnvVar("shopping-list-id", data.id); 
+      }
+      if(data.key){
+          bru.setEnvVar("shopping-list-key", data.key);
+      }
+
+  }
+}
+
+assert {
+  res.status: in [200, 201]
+}
diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetCustomField.bru b/bruno/api/Project/Shopping-lists/Update actions/SetCustomField.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetCustomField
   type: http
-  seq: 727
+  seq: 728
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetCustomType.bru b/bruno/api/Project/Shopping-lists/Update actions/SetCustomType.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetCustomType
   type: http
-  seq: 728
+  seq: 729
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetCustomer.bru b/bruno/api/Project/Shopping-lists/Update actions/SetCustomer.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetCustomer
   type: http
-  seq: 729
+  seq: 730
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetDeleteDaysAfterLastModification.bru b/bruno/api/Project/Shopping-lists/Update actions/SetDeleteDaysAfterLastModification.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetDeleteDaysAfterLastModification
   type: http
-  seq: 730
+  seq: 731
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetDescription.bru b/bruno/api/Project/Shopping-lists/Update actions/SetDescription.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetDescription
   type: http
-  seq: 731
+  seq: 732
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetKey.bru b/bruno/api/Project/Shopping-lists/Update actions/SetKey.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetKey
   type: http
-  seq: 732
+  seq: 733
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetLineItemCustomField.bru b/bruno/api/Project/Shopping-lists/Update actions/SetLineItemCustomField.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetLineItemCustomField
   type: http
-  seq: 733
+  seq: 734
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetLineItemCustomType.bru b/bruno/api/Project/Shopping-lists/Update actions/SetLineItemCustomType.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetLineItemCustomType
   type: http
-  seq: 734
+  seq: 735
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetSlug.bru b/bruno/api/Project/Shopping-lists/Update actions/SetSlug.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetSlug
   type: http
-  seq: 735
+  seq: 736
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetStore.bru b/bruno/api/Project/Shopping-lists/Update actions/SetStore.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetStore
   type: http
-  seq: 736
+  seq: 737
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetTextLineItemCustomField.bru b/bruno/api/Project/Shopping-lists/Update actions/SetTextLineItemCustomField.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetTextLineItemCustomField
   type: http
-  seq: 737
+  seq: 738
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetTextLineItemCustomType.bru b/bruno/api/Project/Shopping-lists/Update actions/SetTextLineItemCustomType.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetTextLineItemCustomType
   type: http
-  seq: 738
+  seq: 739
 }
 
 post {

diff --git a/bruno/api/Project/Shopping-lists/Update actions/SetTextLineItemDescription.bru b/bruno/api/Project/Shopping-lists/Update actions/SetTextLineItemDescription.bru
@@ -1,7 +1,7 @@
 meta {
   name: SetTextLineItemDescription
   type: http
-  seq: 739
+  seq: 740
 }
 
 post {

diff --git a/oas/api/openapi.yaml b/oas/api/openapi.yaml
@@ -75285,6 +75285,8 @@ components:
               type: "string"
             store:
               $ref: '#/components/schemas/StoreKeyReference'
+            businessUnit:
+              $ref: '#/components/schemas/BusinessUnitKeyReference'
             custom:
               $ref: '#/components/schemas/CustomFields'
             lastModifiedBy:
@@ -75321,6 +75323,8 @@ components:
             $ref: '#/components/schemas/TextLineItemDraft'
         store:
           $ref: '#/components/schemas/StoreResourceIdentifier'
+        businessUnit:
+          $ref: '#/components/schemas/BusinessUnitResourceIdentifier'
         custom:
           $ref: '#/components/schemas/CustomFieldsDraft'
     ShoppingListLineItem:
@@ -75458,6 +75462,7 @@ components:
           removeLineItem: '#/components/schemas/ShoppingListRemoveLineItemAction'
           removeTextLineItem: '#/components/schemas/ShoppingListRemoveTextLineItemAction'
           setAnonymousId: '#/components/schemas/ShoppingListSetAnonymousIdAction'
+          setBusinessUnit: '#/components/schemas/ShoppingListSetBusinessUnitAction'
           setCustomField: '#/components/schemas/ShoppingListSetCustomFieldAction'
           setCustomType: '#/components/schemas/ShoppingListSetCustomTypeAction'
           setCustomer: '#/components/schemas/ShoppingListSetCustomerAction'
@@ -75687,6 +75692,17 @@ components:
               type: "string"
             anonymousId:
               type: "string"
+    ShoppingListSetBusinessUnitAction:
+      allOf:
+        - $ref: '#/components/schemas/ShoppingListUpdateAction'
+        - type: "object"
+          required:
+            - businessUnit
+          properties:
+            action:
+              type: "string"
+            businessUnit:
+              $ref: '#/components/schemas/BusinessUnitResourceIdentifier'
     ShoppingListSetCustomFieldAction:
       allOf:
         - $ref: '#/components/schemas/ShoppingListUpdateAction'

diff --git a/uml/api/BaseResource.puml b/uml/api/BaseResource.puml
@@ -603,6 +603,7 @@ interface ShoppingList [[ShoppingList.svg]] extends BaseResource {
     deleteDaysAfterLastModification: Long
     anonymousId: String
     store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
     custom: [[CustomFields.svg CustomFields]]
     lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
     createdBy: [[CreatedBy.svg CreatedBy]]

diff --git a/uml/api/BusinessUnitKeyReference.puml b/uml/api/BusinessUnitKeyReference.puml
@@ -304,6 +304,26 @@ interface Quote [[Quote.svg]]  {
     purchaseOrderNumber: String
     businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
 }
+interface ShoppingList [[ShoppingList.svg]]  {
+    id: String
+    version: Long
+    createdAt: DateTime
+    lastModifiedAt: DateTime
+    name: [[LocalizedString.svg LocalizedString]]
+    key: String
+    customer: [[CustomerReference.svg CustomerReference]]
+    slug: [[LocalizedString.svg LocalizedString]]
+    description: [[LocalizedString.svg LocalizedString]]
+    lineItems: [[ShoppingListLineItem.svg List<ShoppingListLineItem>]]
+    textLineItems: [[TextLineItem.svg List<TextLineItem>]]
+    deleteDaysAfterLastModification: Long
+    anonymousId: String
+    store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
+    custom: [[CustomFields.svg CustomFields]]
+    lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
+    createdBy: [[CreatedBy.svg CreatedBy]]
+}
 interface StagedQuote [[StagedQuote.svg]]  {
     id: String
     version: Long
@@ -339,5 +359,6 @@ BusinessUnitKeyReference --> BusinessUnitParentChangedMessagePayload #green;text
 BusinessUnitKeyReference --> Order #green;text:green : "businessUnit"
 BusinessUnitKeyReference --> QuoteRequest #green;text:green : "businessUnit"
 BusinessUnitKeyReference --> Quote #green;text:green : "businessUnit"
+BusinessUnitKeyReference --> ShoppingList #green;text:green : "businessUnit"
 BusinessUnitKeyReference --> StagedQuote #green;text:green : "businessUnit"
 @enduml
diff --git a/uml/api/BusinessUnitResourceIdentifier.puml b/uml/api/BusinessUnitResourceIdentifier.puml
@@ -166,6 +166,24 @@ interface OrderImportDraft [[OrderImportDraft.svg]]  {
     completedAt: DateTime
     custom: [[CustomFieldsDraft.svg CustomFieldsDraft]]
 }
+interface ShoppingListDraft [[ShoppingListDraft.svg]]  {
+    name: [[LocalizedString.svg LocalizedString]]
+    slug: [[LocalizedString.svg LocalizedString]]
+    customer: [[CustomerResourceIdentifier.svg CustomerResourceIdentifier]]
+    key: String
+    description: [[LocalizedString.svg LocalizedString]]
+    anonymousId: String
+    deleteDaysAfterLastModification: Long
+    lineItems: [[ShoppingListLineItemDraft.svg List<ShoppingListLineItemDraft>]]
+    textLineItems: [[TextLineItemDraft.svg List<TextLineItemDraft>]]
+    store: [[StoreResourceIdentifier.svg StoreResourceIdentifier]]
+    businessUnit: [[BusinessUnitResourceIdentifier.svg BusinessUnitResourceIdentifier]]
+    custom: [[CustomFieldsDraft.svg CustomFieldsDraft]]
+}
+interface ShoppingListSetBusinessUnitAction [[ShoppingListSetBusinessUnitAction.svg]]  {
+    action: String
+    businessUnit: [[BusinessUnitResourceIdentifier.svg BusinessUnitResourceIdentifier]]
+}
 BusinessUnitResourceIdentifier --> BusinessUnitResourceIdentifier #blue;text:blue : "typeId : business-unit"
 BusinessUnitResourceIdentifier --> DivisionDraft #green;text:green : "parentUnit"
 BusinessUnitResourceIdentifier --> BusinessUnitChangeParentUnitAction #green;text:green : "parentUnit"
@@ -178,4 +196,6 @@ BusinessUnitResourceIdentifier --> MyDivisionDraft #green;text:green : "parentUn
 BusinessUnitResourceIdentifier --> MyBusinessUnitChangeParentUnitAction #green;text:green : "parentUnit"
 BusinessUnitResourceIdentifier --> MyCartSetBusinessUnitAction #green;text:green : "businessUnit"
 BusinessUnitResourceIdentifier --> OrderImportDraft #green;text:green : "businessUnit"
+BusinessUnitResourceIdentifier --> ShoppingListDraft #green;text:green : "businessUnit"
+BusinessUnitResourceIdentifier --> ShoppingListSetBusinessUnitAction #green;text:green : "businessUnit"
 @enduml
diff --git a/uml/api/CreatedBy.puml b/uml/api/CreatedBy.puml
@@ -629,6 +629,7 @@ interface ShoppingList [[ShoppingList.svg]]  {
     deleteDaysAfterLastModification: Long
     anonymousId: String
     store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
     custom: [[CustomFields.svg CustomFields]]
     lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
     createdBy: [[CreatedBy.svg CreatedBy]]

diff --git a/uml/api/CustomFields.puml b/uml/api/CustomFields.puml
@@ -906,6 +906,7 @@ interface ShoppingList [[ShoppingList.svg]]  {
     deleteDaysAfterLastModification: Long
     anonymousId: String
     store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
     custom: [[CustomFields.svg CustomFields]]
     lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
     createdBy: [[CreatedBy.svg CreatedBy]]

diff --git a/uml/api/CustomFieldsDraft.puml b/uml/api/CustomFieldsDraft.puml
@@ -712,6 +712,7 @@ interface ShoppingListDraft [[ShoppingListDraft.svg]]  {
     lineItems: [[ShoppingListLineItemDraft.svg List<ShoppingListLineItemDraft>]]
     textLineItems: [[TextLineItemDraft.svg List<TextLineItemDraft>]]
     store: [[StoreResourceIdentifier.svg StoreResourceIdentifier]]
+    businessUnit: [[BusinessUnitResourceIdentifier.svg BusinessUnitResourceIdentifier]]
     custom: [[CustomFieldsDraft.svg CustomFieldsDraft]]
 }
 interface ShoppingListLineItemDraft [[ShoppingListLineItemDraft.svg]]  {

diff --git a/uml/api/CustomerReference.puml b/uml/api/CustomerReference.puml
@@ -298,6 +298,7 @@ interface ShoppingList [[ShoppingList.svg]]  {
     deleteDaysAfterLastModification: Long
     anonymousId: String
     store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
     custom: [[CustomFields.svg CustomFields]]
     lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
     createdBy: [[CreatedBy.svg CreatedBy]]

diff --git a/uml/api/CustomerResourceIdentifier.puml b/uml/api/CustomerResourceIdentifier.puml
@@ -105,6 +105,7 @@ interface ShoppingListDraft [[ShoppingListDraft.svg]]  {
     lineItems: [[ShoppingListLineItemDraft.svg List<ShoppingListLineItemDraft>]]
     textLineItems: [[TextLineItemDraft.svg List<TextLineItemDraft>]]
     store: [[StoreResourceIdentifier.svg StoreResourceIdentifier]]
+    businessUnit: [[BusinessUnitResourceIdentifier.svg BusinessUnitResourceIdentifier]]
     custom: [[CustomFieldsDraft.svg CustomFieldsDraft]]
 }
 interface ShoppingListSetCustomerAction [[ShoppingListSetCustomerAction.svg]]  {

diff --git a/uml/api/LastModifiedBy.puml b/uml/api/LastModifiedBy.puml
@@ -634,6 +634,7 @@ interface ShoppingList [[ShoppingList.svg]]  {
     deleteDaysAfterLastModification: Long
     anonymousId: String
     store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
     custom: [[CustomFields.svg CustomFields]]
     lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
     createdBy: [[CreatedBy.svg CreatedBy]]

diff --git a/uml/api/LocalizedString.puml b/uml/api/LocalizedString.puml
@@ -1026,6 +1026,7 @@ interface ShoppingList [[ShoppingList.svg]]  {
     deleteDaysAfterLastModification: Long
     anonymousId: String
     store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
     custom: [[CustomFields.svg CustomFields]]
     lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
     createdBy: [[CreatedBy.svg CreatedBy]]
@@ -1041,6 +1042,7 @@ interface ShoppingListDraft [[ShoppingListDraft.svg]]  {
     lineItems: [[ShoppingListLineItemDraft.svg List<ShoppingListLineItemDraft>]]
     textLineItems: [[TextLineItemDraft.svg List<TextLineItemDraft>]]
     store: [[StoreResourceIdentifier.svg StoreResourceIdentifier]]
+    businessUnit: [[BusinessUnitResourceIdentifier.svg BusinessUnitResourceIdentifier]]
     custom: [[CustomFieldsDraft.svg CustomFieldsDraft]]
 }
 interface ShoppingListLineItem [[ShoppingListLineItem.svg]]  {

diff --git a/uml/api/ShoppingList.puml b/uml/api/ShoppingList.puml
@@ -23,6 +23,7 @@ interface ShoppingList [[ShoppingList.svg]] extends BaseResource {
     deleteDaysAfterLastModification: Long
     anonymousId: String
     store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
     custom: [[CustomFields.svg CustomFields]]
     lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
     createdBy: [[CreatedBy.svg CreatedBy]]

diff --git a/uml/api/ShoppingListDraft.puml b/uml/api/ShoppingListDraft.puml
@@ -19,6 +19,7 @@ interface ShoppingListDraft [[ShoppingListDraft.svg]]  {
     lineItems: [[ShoppingListLineItemDraft.svg List<ShoppingListLineItemDraft>]]
     textLineItems: [[TextLineItemDraft.svg List<TextLineItemDraft>]]
     store: [[StoreResourceIdentifier.svg StoreResourceIdentifier]]
+    businessUnit: [[BusinessUnitResourceIdentifier.svg BusinessUnitResourceIdentifier]]
     custom: [[CustomFieldsDraft.svg CustomFieldsDraft]]
 }
 

diff --git a/uml/api/ShoppingListLineItem.puml b/uml/api/ShoppingListLineItem.puml
@@ -40,6 +40,7 @@ interface ShoppingList [[ShoppingList.svg]]  {
     deleteDaysAfterLastModification: Long
     anonymousId: String
     store: [[StoreKeyReference.svg StoreKeyReference]]
+    businessUnit: [[BusinessUnitKeyReference.svg BusinessUnitKeyReference]]
     custom: [[CustomFields.svg CustomFields]]
     lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
     createdBy: [[CreatedBy.svg CreatedBy]]

diff --git a/uml/api/ShoppingListLineItemDraft.puml b/uml/api/ShoppingListLineItemDraft.puml
@@ -40,6 +40,7 @@ interface ShoppingListDraft [[ShoppingListDraft.svg]]  {
     lineItems: [[ShoppingListLineItemDraft.svg List<ShoppingListLineItemDraft>]]
     textLineItems: [[TextLineItemDraft.svg List<TextLineItemDraft>]]
     store: [[StoreResourceIdentifier.svg StoreResourceIdentifier]]
+    businessUnit: [[BusinessUnitResourceIdentifier.svg BusinessUnitResourceIdentifier]]
     custom: [[CustomFieldsDraft.svg CustomFieldsDraft]]
 }