Skip to content

Commit fc718cb

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent b11c2d3 commit fc718cb

File tree

4 files changed

+33
-18
lines changed

4 files changed

+33
-18
lines changed

bruno/import/Project/Import-containers/ByProjectKeyImportContainersByImportContainerKeyDelete.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
meta {
2-
name: Delete import-container
2+
name: Delete an Import Container.
33
type: http
44
seq: 7
55
}

bruno/import/Project/Import-containers/ByProjectKeyImportContainersPost.bru

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
meta {
2-
name: Creates a new import container.
2+
name: Create a new Import Container.
33
type: http
44
seq: 3
55
}

oas/api/openapi.yaml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79143,7 +79143,7 @@ components:
7914379143
- import-api
7914479144
x-annotation-package: "Subscription"
7914579145
x-annotation-enumDescriptions:
79146-
import-api: "Events related to the Import API.n"
79146+
import-api: "Events related to the [Import API](/../api/import-export/overview).n"
7914779147
EventType:
7914879148
type: "string"
7914979149
enum:
@@ -79154,6 +79154,13 @@ components:
7915479154
- ImportValidationFailed
7915579155
- ImportWaitForMasterVariant
7915679156
x-annotation-package: "Subscription"
79157+
x-annotation-enumDescriptions:
79158+
ImportContainerCreated: "Indicates an [Import Container Created Event](ctp:api:type:ImportContainerCreatedEvent).n"
79159+
ImportContainerDeleted: "Indicates an [Import Container Deleted Event](ctp:api:type:ImportContainerDeletedEvent).n"
79160+
ImportOperationRejected: "Indicates an [Import Operation Rejected Event](ctp:api:type:ImportOperationRejectedEvent).n"
79161+
ImportUnresolved: "Indicates an [Import Unresolved Event](ctp:api:type:ImportUnresolvedEvent).n"
79162+
ImportValidationFailed: "Indicates an [Import Validation Failed Event](ctp:api:type:ImportValidationFailedEvent).n"
79163+
ImportWaitForMasterVariant: "Indicates an [Import Wait For Master Variant Event](ctp:api:type:ImportWaitForMasterVariantEvent).n"
7915779164
GoogleCloudPubSubDestination:
7915879165
allOf:
7915979166
- $ref: '#/components/schemas/Destination'

oas/import/openapi.yaml

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,9 @@ paths:
147147
- "manage_import_containers:{projectKey}"
148148
operationId: ByProjectKeyImportContainersPost
149149
description: |-
150-
Creates a new import container.
150+
Creates a new Import Container.
151+
152+
Generates the [ImportContainerCreated](/projects/events#import-container-created-event) Event.
151153
requestBody:
152154
content:
153155
application/json:
@@ -178,7 +180,7 @@ paths:
178180
- "view_import_containers:{projectKey}"
179181
operationId: ByProjectKeyImportContainersGet
180182
description: |-
181-
Retrieves all import containers of a given project key.
183+
Retrieves all Import Containers of a given project key.
182184
parameters:
183185
- name: limit
184186
x-annotation-default: 20
@@ -234,7 +236,7 @@ paths:
234236
- "manage_import_containers:{projectKey}"
235237
operationId: ByProjectKeyImportContainersByImportContainerKeyPut
236238
description: |-
237-
Updates the import container given by the key.
239+
Updates the Import Container given by the key.
238240
requestBody:
239241
content:
240242
application/json:
@@ -244,7 +246,7 @@ paths:
244246
responses:
245247
"200":
246248
description: |-
247-
The import container was successfully updated.
249+
The Import Container was successfully updated.
248250
content:
249251
application/json:
250252
schema:
@@ -265,19 +267,19 @@ paths:
265267
- "view_import_containers:{projectKey}"
266268
operationId: ByProjectKeyImportContainersByImportContainerKeyGet
267269
description: |-
268-
Retrieves the import container given by the key.
270+
Retrieves the Import Container given by the key.
269271
responses:
270272
"200":
271273
description: |-
272-
The requested import container was found.
274+
The requested Import Container was found.
273275
content:
274276
application/json:
275277
schema:
276278
$ref: '#/components/schemas/ImportContainer'
277279

278280
"404":
279281
description: |-
280-
The requested import container wasn't found.
282+
The requested Import Container wasn't found.
281283
content:
282284
application/json:
283285
schema:
@@ -289,19 +291,21 @@ paths:
289291
- "manage_import_containers:{projectKey}"
290292
operationId: ByProjectKeyImportContainersByImportContainerKeyDelete
291293
description: |-
292-
Deletes the import container given by the key.
294+
Deletes the Import Container specified by the `importContainerKey`.
295+
296+
Generates the [ImportContainerDeleted](/projects/events#import-container-deleted-event) Event.
293297
responses:
294298
"200":
295299
description: |-
296-
The deleted import container.
300+
The deleted Import Container.
297301
content:
298302
application/json:
299303
schema:
300304
$ref: '#/components/schemas/ImportContainer'
301305

302306
"404":
303307
description: |-
304-
The import container to delete wasn't found.
308+
The Import Container to delete wasn't found.
305309
content:
306310
application/json:
307311
schema:
@@ -405,7 +409,7 @@ paths:
405409
- "view_import_containers:{projectKey}"
406410
operationId: ByProjectKeyImportContainersByImportContainerKeyImportSummariesGet
407411
description: |-
408-
Retrieves an [ImportSummary](ctp:import:type:ImportSummary) for the given import container. An [ImportSummary](ctp:import:type:ImportSummary) is calculated on demand.
412+
Retrieves an [ImportSummary](ctp:import:type:ImportSummary) for the given Import Container. An [ImportSummary](ctp:import:type:ImportSummary) is calculated on demand.
409413
responses:
410414
"200":
411415
description: |-
@@ -4697,17 +4701,21 @@ components:
46974701
fields) meets Import API specifications. The resource import is in progress."
46984702
imported: "The resource was successfully imported."
46994703
unresolved: "The import request contains [KeyReferences](ctp:import:type:KeyReference)
4700-
to resources that do not exist in your Composable Commerce Project."
4704+
to resources that do not exist in your Composable Commerce Project. Generates
4705+
the [ImportUnresolved](/projects/events#import-unresolved-event) Event."
47014706
validationFailed: "Either the request payload is missing the data as per Import API
47024707
specifications, or even though the references were resolved, the data does not
4703-
meet validation constraints."
4708+
meet validation constraints. Generates the [ImportValidationFailed](/projects/events#import-validation-failed-event)
4709+
Event."
47044710
waitForMasterVariant: "Products must have at least one Product Variant, also known
47054711
as the Master Variant. If you import a Product without a Master Variant, the import
47064712
request will have this status until another import request includes Master Variant
4707-
data for the Product."
4713+
data for the Product. Generates the [ImportWaitForMasterVariant](/projects/events#import-wait-for-master-variant-event)
4714+
Event."
47084715
rejected: "The resource could not be imported. References were resolved, but the system
47094716
could not import the data due to an internal server error and the retry limit
4710-
was reached."
4717+
was reached. Generates the [ImportOperationRejected](/projects/events#import-operation-rejected-event)
4718+
Event."
47114719
canceled: "The import request was canceled and the resource was not imported."
47124720
Address:
47134721
type: "object"

0 commit comments

Comments
 (0)