Updated API from documentation release

Author: ct-sdks[bot]

api-specs/import/api.raml

@@ -174,6 +174,7 @@ traits:
         - secured_by_manage_import_containers
       body:
         type: import-container.ImportContainerDraft
+        example: !include examples/import-container-draft-minimal.json
       responses:
         201:
           body:
@@ -225,12 +226,13 @@ traits:
           - secured_by_manage_import_containers
         body:
           type: import-container.ImportContainerUpdateDraft
+          example: !include examples/import-container-update-draft-minimal.json
         responses:
           200:
             description: The Import Container was successfully updated.
             body:
               type: import-container.ImportContainer
-              example: !include examples/import-container-minimal.json
+              example: !include examples/import-container-updated.json
           409:
             description:
               A concurrent modification was detected. The client should retry
@@ -266,6 +268,7 @@ traits:
             description: The deleted Import Container.
             body:
               type: import-container.ImportContainer
+              example: !include examples/import-container-minimal.json
           404:
             description: The Import Container to delete wasn't found.
             body:
@@ -344,6 +347,7 @@ traits:
           200:
             body:
               type: import-operation.ImportOperation
+              example: !include examples/import-operation-validation-failed.json
           404:
             body:
               type: error.ErrorResponse
@@ -371,7 +375,7 @@ traits:
             201:
               body:
                 type: import-request.ImportResponse
-                example: !include examples/category-import-response.json
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -393,10 +397,12 @@ traits:
             - secured_by_manage_products
           body:
             type: import-request.PriceImportRequest
+            example: !include examples/price-import-request.json
           responses:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -423,6 +429,7 @@ traits:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -444,10 +451,12 @@ traits:
             - secured_by_manage_products
           body:
             type: import-request.ProductImportRequest
+            example: !include examples/product-import-request.json
           responses:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -469,10 +478,12 @@ traits:
             - secured_by_manage_products
           body:
             type: import-request.ProductDraftImportRequest
+            example: !include examples/product-draft-import-request.json
           responses:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -494,10 +505,12 @@ traits:
             - secured_by_manage_products
           body:
             type: import-request.ProductTypeImportRequest
+            example: !include examples/product-type-import-request.json
           responses:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -519,10 +532,12 @@ traits:
             - secured_by_manage_products
           body:
             type: import-request.ProductVariantImportRequest
+            example: !include examples/product-variant-import-request.json
           responses:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -544,10 +559,12 @@ traits:
             - secured_by_manage_products
           body:
             type: import-request.ProductVariantPatchRequest
+            example: !include examples/product-variant-patch-request.json
           responses:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -572,6 +589,7 @@ traits:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -591,10 +609,12 @@ traits:
             - secured_by_manage_orders
           body:
             type: import-request.OrderPatchImportRequest
+            example: !include examples/order-patch-import-request.json
           responses:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -621,7 +641,7 @@ traits:
             201:
               body:
                 type: import-request.ImportResponse
-                example: !include examples/customer-import-response.json
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -648,7 +668,7 @@ traits:
             201:
               body:
                 type: import-request.ImportResponse
-                example: !include examples/inventory-import-response.json
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -674,6 +694,7 @@ traits:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:
@@ -700,6 +721,7 @@ traits:
             201:
               body:
                 type: import-request.ImportResponse
+                example: !include examples/import-response.json
             400:
               description: The request was invalid.
               body:

api-specs/import/examples/categories.json

@@ -2,83 +2,15 @@
   "type": "category",
   "resources": [
     {
-      "key": "greatTestCat",
-      "name": { "en": "greatTestCat" },
-      "slug": { "en": "great-slug" },
+      "key": "category-to-import",
+      "name": { "en": "Category to import" },
+      "slug": { "en": "category-to-import-slug" },
       "description": {
-        "de": "Beschreibung der Kategorie",
-        "en": "category's description"
+        "en": "Description of category to import"
       },
       "parent": {
         "typeId": "category",
-        "key": "category-key"
-      },
-      "orderHint": "category's order hint",
-      "externalId": "external-id",
-      "metaTitle": {
-        "de": "der Metatitel der Katze",
-        "en": "the cat's meta title"
-      },
-      "metaDescription": {
-        "de": "die Meta-Beschreibung der Katze",
-        "en": "the cat's meta description"
-      },
-      "metaKeywords": {
-        "de": "die Schlüsselwörter der Katze",
-        "en": "the cat's key words"
-      },
-      "assets": [
-        {
-          "key": "asset-key",
-          "sources": [
-            {
-              "uri": "https://google.com",
-              "key": "asset-source-key",
-              "dimensions": {
-                "w": 12,
-                "h": 10
-              },
-              "contentType": "dummy content type"
-            }
-          ],
-          "name": {
-            "de": "Asset-Name",
-            "en": "asset name"
-          },
-          "description": {
-            "de": "Asset-Beschreibung",
-            "en": "asset description"
-          },
-          "tags": ["tag 1"],
-          "custom": {
-            "type": {
-              "key": "custom-type",
-              "typeId": "type"
-            },
-            "fields": {
-              "exampleBooleanField": {
-                "type": "Boolean",
-                "value": false
-              }
-            }
-          }
-        }
-      ],
-      "custom": {
-        "type": {
-          "typeId": "type",
-          "key": "custom-type"
-        },
-        "fields": {
-          "exampleBooleanField": {
-            "type": "Boolean",
-            "value": true
-          },
-          "exampleStringField": {
-            "type": "String",
-            "value": "a string"
-          }
-        }
+        "key": "key-of-parent-category"
       }
     }
   ]

api-specs/import/examples/category-import-request.json

@@ -0,0 +1,12 @@
+{
+  "key": "category-to-import",
+  "name": { "en": "Category to import" },
+  "slug": { "en": "category-to-import-slug" },
+  "description": {
+    "en": "Description of category to import"
+  },
+  "parent": {
+    "typeId": "category",
+    "key": "key-of-parent-category"
+  }
+}

api-specs/import/examples/category-import.json

@@ -0,0 +1,8 @@
+{
+  "key": "john-doe-address-key",
+  "streetName": "Main Street",
+  "streetNumber": "123",
+  "postalCode": "12345",
+  "city": "Berlin",
+  "country": "DE"
+}