Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit b11c2d3d1949 · 2025-04-01T13:23:12.000Z
diff --git a/api-specs/api/types/event/ImportContainerCreatedEvent.raml b/api-specs/api/types/event/ImportContainerCreatedEvent.raml
@@ -8,8 +8,7 @@ example: !include ../../examples/Event/ImportContainerCreatedEvent.json
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    enum:
-      - import-api
+    default: 'import-api'
   data:
     type: ImportContainerCreatedEventData
     description: |
diff --git a/api-specs/api/types/event/ImportContainerDeletedEvent.raml b/api-specs/api/types/event/ImportContainerDeletedEvent.raml
@@ -8,8 +8,7 @@ discriminatorValue: ImportContainerDeleted
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    enum:
-      - import-api
+    default: 'import-api'
   data:
     type: ImportContainerDeletedEventData
     description: |
diff --git a/api-specs/api/types/event/ImportOperationRejectedEvent.raml b/api-specs/api/types/event/ImportOperationRejectedEvent.raml
@@ -8,8 +8,7 @@ discriminatorValue: ImportOperationRejected
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    enum:
-      - import-api
+    default: 'import-api'
   data:
     type: ImportOperationRejectedEventData
     description: |
diff --git a/api-specs/api/types/event/ImportUnresolvedEvent.raml b/api-specs/api/types/event/ImportUnresolvedEvent.raml
@@ -8,8 +8,7 @@ example: !include ../../examples/Event/ImportUnresolvedEvent.json
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    enum:
-      - import-api
+    default: 'import-api'
   data:
     type: ImportUnresolvedEventData
     description: |
diff --git a/api-specs/api/types/event/ImportValidationFailedEvent.raml b/api-specs/api/types/event/ImportValidationFailedEvent.raml
@@ -8,8 +8,7 @@ discriminatorValue: ImportValidationFailed
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    enum:
-      - import-api
+    default: 'import-api'
   data:
     type: ImportValidationFailedEventData
     description: |
diff --git a/api-specs/api/types/event/ImportWaitForMasterVariantEvent.raml b/api-specs/api/types/event/ImportWaitForMasterVariantEvent.raml
@@ -8,8 +8,7 @@ discriminatorValue: ImportWaitForMasterVariant
 properties:
   resourceType:
     type: EventSubscriptionResourceTypeId
-    enum:
-      - import-api
+    default: 'import-api'
   data:
     type: ImportWaitForMasterVariantEventData
     description: |
diff --git a/api-specs/api/types/subscription/EventSubscriptionResourceTypeId.raml b/api-specs/api/types/subscription/EventSubscriptionResourceTypeId.raml
@@ -8,4 +8,4 @@ enum:
   - import-api
 (enumDescriptions):
   import-api: |
-    Events related to the Import API.
+    Events related to the [Import API](/../api/import-export/overview).
diff --git a/api-specs/api/types/subscription/EventType.raml b/api-specs/api/types/subscription/EventType.raml
@@ -11,3 +11,16 @@ enum:
   - ImportUnresolved
   - ImportValidationFailed
   - ImportWaitForMasterVariant
+(enumDescriptions):
+  ImportContainerCreated: |
+    Indicates an [Import Container Created Event](ctp:api:type:ImportContainerCreatedEvent).
+  ImportContainerDeleted: |
+    Indicates an [Import Container Deleted Event](ctp:api:type:ImportContainerDeletedEvent).
+  ImportOperationRejected: |
+    Indicates an [Import Operation Rejected Event](ctp:api:type:ImportOperationRejectedEvent).
+  ImportUnresolved: |
+    Indicates an [Import Unresolved Event](ctp:api:type:ImportUnresolvedEvent).
+  ImportValidationFailed: |
+    Indicates an [Import Validation Failed Event](ctp:api:type:ImportValidationFailedEvent).
+  ImportWaitForMasterVariant: |
+    Indicates an [Import Wait For Master Variant Event](ctp:api:type:ImportWaitForMasterVariantEvent).
diff --git a/api-specs/import/api.raml b/api-specs/import/api.raml
@@ -165,8 +165,11 @@ traits:
       type: string
   /import-containers:
     post:
-      displayName: Creates a new import container.
-      description: Creates a new import container.
+      displayName: Create a new Import Container.
+      description: |
+        Creates a new Import Container.
+
+        Generates the [ImportContainerCreated](/projects/events#import-container-created-event) Event.
       is:
         - secured_by_manage_import_containers
       body:
@@ -201,29 +204,30 @@ traits:
           description: |
             See [Sorting](/../api/general-concepts#sorting).
           type: string[]
-      description: Retrieves all import containers of a given project key.
+      description: Retrieves all Import Containers of a given project key.
       is:
         - secured_by_view_import_containers
       responses:
         200:
           body:
             type: import-container.ImportContainerPagedResponse
+            example: !include examples/import-container-paged-query-response.json
     /{importContainerKey}:
       type: baseByParam
       uriParameters:
         importContainerKey:
           (postman.paramName): import-container-key
-          description: The key of the import container.
+          description: The key of the Import Container.
           type: string
       put:
-        description: Updates the import container given by the key.
+        description: Updates the Import Container given by the key.
         is:
           - secured_by_manage_import_containers
         body:
           type: import-container.ImportContainerUpdateDraft
         responses:
           200:
-            description: The import container was successfully updated.
+            description: The Import Container was successfully updated.
             body:
               type: import-container.ImportContainer
               example: !include examples/import-container-minimal.json
@@ -235,31 +239,35 @@ traits:
               type: error.ErrorResponse
               example: !include examples/error-response-concurrent-modification.json
       get:
-        description: Retrieves the import container given by the key.
+        description: Retrieves the Import Container given by the key.
         is:
           - secured_by_view_import_containers
         responses:
           200:
-            description: The requested import container was found.
+            description: The requested Import Container was found.
             body:
               type: import-container.ImportContainer
               example: !include examples/import-container-minimal.json
           404:
-            description: The requested import container wasn't found.
+            description: The requested Import Container wasn't found.
             body:
               type: error.ErrorResponse
               example: !include examples/error-response-resource-not-found.json
       delete:
-        description: Deletes the import container given by the key.
+        displayName: Delete an Import Container.
+        description: |
+          Deletes the Import Container specified by the `importContainerKey`.
+
+          Generates the [ImportContainerDeleted](/projects/events#import-container-deleted-event) Event.
         is:
           - secured_by_manage_import_containers
         responses:
           200:
-            description: The deleted import container.
+            description: The deleted Import Container.
             body:
               type: import-container.ImportContainer
           404:
-            description: The import container to delete wasn't found.
+            description: The Import Container to delete wasn't found.
             body:
               type: error.ErrorResponse
       /import-summaries:
@@ -268,7 +276,7 @@ traits:
           is:
             - secured_by_view_import_containers
           description: |
-            Retrieves an [ImportSummary](ctp:import:type:ImportSummary) for the given import container. An [ImportSummary](ctp:import:type:ImportSummary) is calculated on demand.
+            Retrieves an [ImportSummary](ctp:import:type:ImportSummary) for the given Import Container. An [ImportSummary](ctp:import:type:ImportSummary) is calculated on demand.
           responses:
             200:
               body:
diff --git a/api-specs/import/examples/import-container-paged-query-response.json b/api-specs/import/examples/import-container-paged-query-response.json
@@ -0,0 +1,14 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "count": 1,
+  "total": 1,
+  "results": [
+    {
+      "key": "my-import-container",
+      "version": 1,
+      "createdAt": "2018-02-05T09:47:16.648Z",
+      "lastModifiedAt": "2018-02-05T09:47:16.649Z"
+    }
+  ]
+}
diff --git a/api-specs/import/types/common.raml b/api-specs/import/types/common.raml
@@ -354,10 +354,10 @@ types:
     (annotations.enumDescriptions):
       processing: The initial state assigned if the request payload (JSON structure and fields) meets Import API specifications. The resource import is in progress.
       imported: The resource was successfully imported.
-      unresolved: The import request contains [KeyReferences](ctp:import:type:KeyReference) to resources that do not exist in your Composable Commerce Project.
-      validationFailed: Either the request payload is missing the data as per Import API specifications, or even though the references were resolved, the data does not meet validation constraints.
-      waitForMasterVariant: Products must have at least one Product Variant, also known as the Master Variant. If you import a Product without a Master Variant, the import request will have this status until another import request includes Master Variant data for the Product.
-      rejected: The resource could not be imported. References were resolved, but the system could not import the data due to an internal server error and the retry limit was reached.
+      unresolved: The import request contains [KeyReferences](ctp:import:type:KeyReference) to resources that do not exist in your Composable Commerce Project. Generates the [ImportUnresolved](/projects/events#import-unresolved-event) Event.
+      validationFailed: Either the request payload is missing the data as per Import API specifications, or even though the references were resolved, the data does not meet validation constraints. Generates the [ImportValidationFailed](/projects/events#import-validation-failed-event) Event.
+      waitForMasterVariant: Products must have at least one Product Variant, also known as the Master Variant. If you import a Product without a Master Variant, the import request will have this status until another import request includes Master Variant data for the Product. Generates the [ImportWaitForMasterVariant](/projects/events#import-wait-for-master-variant-event) Event.
+      rejected: The resource could not be imported. References were resolved, but the system could not import the data due to an internal server error and the retry limit was reached. Generates the [ImportOperationRejected](/projects/events#import-operation-rejected-event) Event.
       canceled: The import request was canceled and the resource was not imported.
     type: string
     enum:
diff --git a/api-specs/import/types/import-container.raml b/api-specs/import/types/import-container.raml
@@ -52,7 +52,7 @@ types:
       minimal: !include ../examples/import-container-draft-minimal.json
   ImportContainerUpdateDraft:
     description: |
-      The representation sent to the server when updating an import container.
+      The representation sent to the server when updating an Import Container.
     properties:
       version:
         description: Current version of the ImportContainer.
diff --git a/api-specs/import/types/import-request.raml b/api-specs/import/types/import-request.raml
@@ -24,7 +24,7 @@ uses:
 types:
   ImportRequest:
     description: |
-      An import request batches multiple import resources of the same import resource type for processing by an import container.
+      An import request batches multiple import resources of the same import resource type for processing by an Import Container.
     discriminator: type
     properties:
       type: common.ImportResourceType
