Skip to content

Commit

Permalink
TASK: Updating RAML types, Postman and OAS definition
Browse files Browse the repository at this point in the history
  • Loading branch information
@ct-sdks
ct-sdks[bot] committed Aug 9, 2024
1 parent dd82e07 commit 5bd4f5e
Show file tree
Hide file tree
Showing 31 changed files with 2,283 additions and 642 deletions.
283 changes: 283 additions & 0 deletions oas/api/openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52850,6 +52850,210 @@ components:
$ref: '#/components/schemas/Address'
shippingKey:
type: "string"
DeliveryCustomFieldAddedMessage:
allOf:
- $ref: '#/components/schemas/OrderMessage'
- type: "object"
required:
- deliveryId
- name
- value
properties:
id:
type: "string"
version:
type: "integer"
format: "int64"
createdAt:
type: "string"
format: "datetime"
lastModifiedAt:
type: "string"
format: "datetime"
lastModifiedBy:
$ref: '#/components/schemas/LastModifiedBy'
createdBy:
$ref: '#/components/schemas/CreatedBy'
sequenceNumber:
type: "integer"
format: "int64"
resource:
$ref: '#/components/schemas/Reference'
resourceVersion:
type: "integer"
format: "int64"
type:
type: "string"
resourceUserProvidedIdentifiers:
$ref: '#/components/schemas/UserProvidedIdentifiers'
name:
type: "string"
value:
{}
deliveryId:
type: "string"
DeliveryCustomFieldChangedMessage:
allOf:
- $ref: '#/components/schemas/OrderMessage'
- type: "object"
required:
- deliveryId
- name
- value
properties:
id:
type: "string"
version:
type: "integer"
format: "int64"
createdAt:
type: "string"
format: "datetime"
lastModifiedAt:
type: "string"
format: "datetime"
lastModifiedBy:
$ref: '#/components/schemas/LastModifiedBy'
createdBy:
$ref: '#/components/schemas/CreatedBy'
sequenceNumber:
type: "integer"
format: "int64"
resource:
$ref: '#/components/schemas/Reference'
resourceVersion:
type: "integer"
format: "int64"
type:
type: "string"
resourceUserProvidedIdentifiers:
$ref: '#/components/schemas/UserProvidedIdentifiers'
name:
type: "string"
value:
{}
previousValue:
{}
deliveryId:
type: "string"
DeliveryCustomFieldRemovedMessage:
allOf:
- $ref: '#/components/schemas/OrderMessage'
- type: "object"
required:
- deliveryId
- name
properties:
id:
type: "string"
version:
type: "integer"
format: "int64"
createdAt:
type: "string"
format: "datetime"
lastModifiedAt:
type: "string"
format: "datetime"
lastModifiedBy:
$ref: '#/components/schemas/LastModifiedBy'
createdBy:
$ref: '#/components/schemas/CreatedBy'
sequenceNumber:
type: "integer"
format: "int64"
resource:
$ref: '#/components/schemas/Reference'
resourceVersion:
type: "integer"
format: "int64"
type:
type: "string"
resourceUserProvidedIdentifiers:
$ref: '#/components/schemas/UserProvidedIdentifiers'
name:
type: "string"
deliveryId:
type: "string"
DeliveryCustomTypeRemovedMessage:
allOf:
- $ref: '#/components/schemas/OrderMessage'
- type: "object"
required:
- deliveryId
properties:
id:
type: "string"
version:
type: "integer"
format: "int64"
createdAt:
type: "string"
format: "datetime"
lastModifiedAt:
type: "string"
format: "datetime"
lastModifiedBy:
$ref: '#/components/schemas/LastModifiedBy'
createdBy:
$ref: '#/components/schemas/CreatedBy'
sequenceNumber:
type: "integer"
format: "int64"
resource:
$ref: '#/components/schemas/Reference'
resourceVersion:
type: "integer"
format: "int64"
type:
type: "string"
resourceUserProvidedIdentifiers:
$ref: '#/components/schemas/UserProvidedIdentifiers'
previousTypeId:
type: "string"
deliveryId:
type: "string"
DeliveryCustomTypeSetMessage:
allOf:
- $ref: '#/components/schemas/OrderMessage'
- type: "object"
required:
- customFields
- deliveryId
properties:
id:
type: "string"
version:
type: "integer"
format: "int64"
createdAt:
type: "string"
format: "datetime"
lastModifiedAt:
type: "string"
format: "datetime"
lastModifiedBy:
$ref: '#/components/schemas/LastModifiedBy'
createdBy:
$ref: '#/components/schemas/CreatedBy'
sequenceNumber:
type: "integer"
format: "int64"
resource:
$ref: '#/components/schemas/Reference'
resourceVersion:
type: "integer"
format: "int64"
type:
type: "string"
resourceUserProvidedIdentifiers:
$ref: '#/components/schemas/UserProvidedIdentifiers'
customFields:
$ref: '#/components/schemas/CustomFields'
previousTypeId:
type: "string"
deliveryId:
type: "string"
DeliveryItemsUpdatedMessage:
allOf:
- $ref: '#/components/schemas/OrderMessage'
Expand Down Expand Up @@ -60092,6 +60296,85 @@ components:
$ref: '#/components/schemas/Address'
shippingKey:
type: "string"
DeliveryCustomFieldAddedMessagePayload:
allOf:
- $ref: '#/components/schemas/OrderMessagePayload'
- type: "object"
required:
- deliveryId
- name
- value
properties:
type:
type: "string"
name:
type: "string"
value:
{}
deliveryId:
type: "string"
DeliveryCustomFieldChangedMessagePayload:
allOf:
- $ref: '#/components/schemas/OrderMessagePayload'
- type: "object"
required:
- deliveryId
- name
- value
properties:
type:
type: "string"
name:
type: "string"
value:
{}
previousValue:
{}
deliveryId:
type: "string"
DeliveryCustomFieldRemovedMessagePayload:
allOf:
- $ref: '#/components/schemas/OrderMessagePayload'
- type: "object"
required:
- deliveryId
- name
properties:
type:
type: "string"
name:
type: "string"
deliveryId:
type: "string"
DeliveryCustomTypeRemovedMessagePayload:
allOf:
- $ref: '#/components/schemas/OrderMessagePayload'
- type: "object"
required:
- deliveryId
properties:
type:
type: "string"
previousTypeId:
type: "string"
deliveryId:
type: "string"
DeliveryCustomTypeSetMessagePayload:
allOf:
- $ref: '#/components/schemas/OrderMessagePayload'
- type: "object"
required:
- customFields
- deliveryId
properties:
type:
type: "string"
customFields:
$ref: '#/components/schemas/CustomFields'
previousTypeId:
type: "string"
deliveryId:
type: "string"
DeliveryItemsUpdatedMessagePayload:
allOf:
- $ref: '#/components/schemas/OrderMessagePayload'
Expand Down
24 changes: 24 additions & 0 deletions uml/api/CustomFields.puml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,22 @@ interface CustomerGroupCustomTypeSetMessage [[CustomerGroupCustomTypeSetMessage.
customFields: [[CustomFields.svg CustomFields]]
oldTypeId: String
}
interface DeliveryCustomTypeSetMessage [[DeliveryCustomTypeSetMessage.svg]] {
id: String
version: Long
createdAt: DateTime
lastModifiedAt: DateTime
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
createdBy: [[CreatedBy.svg CreatedBy]]
sequenceNumber: Long
resource: [[Reference.svg Reference]]
resourceVersion: Long
type: String
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
customFields: [[CustomFields.svg CustomFields]]
previousTypeId: String
deliveryId: String
}
interface OrderCustomTypeSetMessage [[OrderCustomTypeSetMessage.svg]] {
id: String
version: Long
Expand Down Expand Up @@ -592,6 +608,12 @@ interface CustomerGroupCustomTypeSetMessagePayload [[CustomerGroupCustomTypeSetM
customFields: [[CustomFields.svg CustomFields]]
oldTypeId: String
}
interface DeliveryCustomTypeSetMessagePayload [[DeliveryCustomTypeSetMessagePayload.svg]] {
type: String
customFields: [[CustomFields.svg CustomFields]]
previousTypeId: String
deliveryId: String
}
interface OrderCustomTypeSetMessagePayload [[OrderCustomTypeSetMessagePayload.svg]] {
type: String
customFields: [[CustomFields.svg CustomFields]]
Expand Down Expand Up @@ -978,6 +1000,7 @@ CustomFields --> BusinessUnitCustomTypeSetMessage #green;text:green : "customFie
CustomFields --> CustomerAddressCustomTypeSetMessage #green;text:green : "customFields"
CustomFields --> CustomerCustomTypeSetMessage #green;text:green : "customFields"
CustomFields --> CustomerGroupCustomTypeSetMessage #green;text:green : "customFields"
CustomFields --> DeliveryCustomTypeSetMessage #green;text:green : "customFields"
CustomFields --> OrderCustomTypeSetMessage #green;text:green : "customFields"
CustomFields --> PaymentInteractionAddedMessage #green;text:green : "interaction"
CustomFields --> ProductPriceCustomFieldsSetMessage #green;text:green : "customField"
Expand All @@ -987,6 +1010,7 @@ CustomFields --> BusinessUnitCustomTypeSetMessagePayload #green;text:green : "cu
CustomFields --> CustomerAddressCustomTypeSetMessagePayload #green;text:green : "customFields"
CustomFields --> CustomerCustomTypeSetMessagePayload #green;text:green : "customFields"
CustomFields --> CustomerGroupCustomTypeSetMessagePayload #green;text:green : "customFields"
CustomFields --> DeliveryCustomTypeSetMessagePayload #green;text:green : "customFields"
CustomFields --> OrderCustomTypeSetMessagePayload #green;text:green : "customFields"
CustomFields --> PaymentInteractionAddedMessagePayload #green;text:green : "interaction"
CustomFields --> ProductPriceCustomFieldsSetMessagePayload #green;text:green : "customField"
Expand Down
45 changes: 45 additions & 0 deletions uml/api/DeliveryCustomFieldAddedMessage.puml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
@startuml

hide empty fields
hide empty methods
legend
|= |= line |
|<back:black> </back>| inheritance |
|<back:green> </back>| property reference |
|<back:blue> </back>| discriminated class |
endlegend
interface DeliveryCustomFieldAddedMessage [[DeliveryCustomFieldAddedMessage.svg]] extends OrderMessage {
id: String
version: Long
createdAt: DateTime
lastModifiedAt: DateTime
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
createdBy: [[CreatedBy.svg CreatedBy]]
sequenceNumber: Long
resource: [[Reference.svg Reference]]
resourceVersion: Long
type: String
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
name: String
value: [[Object.svg Object]]
deliveryId: String
}
interface OrderMessage [[OrderMessage.svg]] {
id: String
version: Long
createdAt: DateTime
lastModifiedAt: DateTime
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
createdBy: [[CreatedBy.svg CreatedBy]]
sequenceNumber: Long
resource: [[Reference.svg Reference]]
resourceVersion: Long
type: String
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
}





@enduml
Loading

0 comments on commit 5bd4f5e

Please sign in to comment.