Skip to content

Commit 8b9f674

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 62910ed commit 8b9f674

19 files changed

+1644
-1065
lines changed

oas/api/openapi.yaml

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50149,6 +50149,7 @@ components:
5014950149
ProjectNotConfiguredForLanguages: '#/components/schemas/ProjectNotConfiguredForLanguagesError'
5015050150
QueryComplexityLimitExceeded: '#/components/schemas/QueryComplexityLimitExceededError'
5015150151
QueryTimedOut: '#/components/schemas/QueryTimedOutError'
50152+
RecurringOrderFailure: '#/components/schemas/RecurringOrderFailureError'
5015250153
ReferenceExists: '#/components/schemas/ReferenceExistsError'
5015350154
ReferencedResourceNotFound: '#/components/schemas/ReferencedResourceNotFoundError'
5015450155
RequiredField: '#/components/schemas/RequiredFieldError'
@@ -50935,6 +50936,23 @@ components:
5093550936
type: "string"
5093650937
additionalProperties:
5093750938
type: "string"
50939+
RecurringOrderFailureError:
50940+
allOf:
50941+
- $ref: '#/components/schemas/ErrorObject'
50942+
- type: "object"
50943+
required:
50944+
- code
50945+
- details
50946+
- message
50947+
properties:
50948+
code:
50949+
type: "string"
50950+
message:
50951+
type: "string"
50952+
details:
50953+
{}
50954+
additionalProperties:
50955+
type: "string"
5093850956
ReferenceExistsError:
5093950957
allOf:
5094050958
- $ref: '#/components/schemas/ErrorObject'
@@ -51632,6 +51650,7 @@ components:
5163251650
ProjectNotConfiguredForLanguages: '#/components/schemas/GraphQLProjectNotConfiguredForLanguagesError'
5163351651
QueryComplexityLimitExceeded: '#/components/schemas/GraphQLQueryComplexityLimitExceededError'
5163451652
QueryTimedOut: '#/components/schemas/GraphQLQueryTimedOutError'
51653+
RecurringOrderFailure: '#/components/schemas/GraphQLRecurringOrderFailureError'
5163551654
ReferenceExists: '#/components/schemas/GraphQLReferenceExistsError'
5163651655
ReferencedResourceNotFound: '#/components/schemas/GraphQLReferencedResourceNotFoundError'
5163751656
RequiredField: '#/components/schemas/GraphQLRequiredFieldError'
@@ -52258,6 +52277,20 @@ components:
5225852277
type: "string"
5225952278
additionalProperties:
5226052279
type: "string"
52280+
GraphQLRecurringOrderFailureError:
52281+
allOf:
52282+
- $ref: '#/components/schemas/GraphQLErrorObject'
52283+
- type: "object"
52284+
required:
52285+
- code
52286+
- details
52287+
properties:
52288+
code:
52289+
type: "string"
52290+
details:
52291+
{}
52292+
additionalProperties:
52293+
type: "string"
5226152294
GraphQLReferenceExistsError:
5226252295
allOf:
5226352296
- $ref: '#/components/schemas/GraphQLErrorObject'
@@ -60279,6 +60312,7 @@ components:
6027960312
RecurringOrderCustomTypeSet: '#/components/schemas/RecurringOrderCustomTypeSetMessage'
6028060313
RecurringOrderDeleted: '#/components/schemas/RecurringOrderDeletedMessage'
6028160314
RecurringOrderExpiresAtSet: '#/components/schemas/RecurringOrderExpiresAtSetMessage'
60315+
RecurringOrderFailed: '#/components/schemas/RecurringOrderFailedMessage'
6028260316
RecurringOrderKeySet: '#/components/schemas/RecurringOrderKeySetMessage'
6028360317
RecurringOrderScheduleSet: '#/components/schemas/RecurringOrderScheduleSetMessage'
6028460318
RecurringOrderStartsAtSet: '#/components/schemas/RecurringOrderStartsAtSetMessage'
@@ -65833,6 +65867,57 @@ components:
6583365867
oldExpiresAt:
6583465868
type: "string"
6583565869
format: "datetime"
65870+
RecurringOrderFailedMessage:
65871+
allOf:
65872+
- $ref: '#/components/schemas/Message'
65873+
- type: "object"
65874+
required:
65875+
- cartId
65876+
- failedAt
65877+
- failureReason
65878+
- orderScheduledAt
65879+
properties:
65880+
id:
65881+
type: "string"
65882+
version:
65883+
type: "integer"
65884+
format: "int64"
65885+
createdAt:
65886+
type: "string"
65887+
format: "datetime"
65888+
lastModifiedAt:
65889+
type: "string"
65890+
format: "datetime"
65891+
lastModifiedBy:
65892+
$ref: '#/components/schemas/LastModifiedBy'
65893+
createdBy:
65894+
$ref: '#/components/schemas/CreatedBy'
65895+
sequenceNumber:
65896+
type: "integer"
65897+
format: "int64"
65898+
resource:
65899+
$ref: '#/components/schemas/Reference'
65900+
resourceVersion:
65901+
type: "integer"
65902+
format: "int64"
65903+
type:
65904+
type: "string"
65905+
resourceUserProvidedIdentifiers:
65906+
$ref: '#/components/schemas/UserProvidedIdentifiers'
65907+
cartId:
65908+
type: "string"
65909+
failedAt:
65910+
type: "string"
65911+
format: "datetime"
65912+
failureReason:
65913+
type: "string"
65914+
orderScheduledAt:
65915+
type: "string"
65916+
format: "datetime"
65917+
errors:
65918+
type: "array"
65919+
items:
65920+
$ref: '#/components/schemas/RecurringOrderFailureError'
6583665921
RecurringOrderKeySetMessage:
6583765922
allOf:
6583865923
- $ref: '#/components/schemas/Message'
@@ -69222,6 +69307,7 @@ components:
6922269307
RecurringOrderCustomTypeSet: '#/components/schemas/RecurringOrderCustomTypeSetMessagePayload'
6922369308
RecurringOrderDeleted: '#/components/schemas/RecurringOrderDeletedMessagePayload'
6922469309
RecurringOrderExpiresAtSet: '#/components/schemas/RecurringOrderExpiresAtSetMessagePayload'
69310+
RecurringOrderFailed: '#/components/schemas/RecurringOrderFailedMessagePayload'
6922569311
RecurringOrderKeySet: '#/components/schemas/RecurringOrderKeySetMessagePayload'
6922669312
RecurringOrderScheduleSet: '#/components/schemas/RecurringOrderScheduleSetMessagePayload'
6922769313
RecurringOrderStartsAtSet: '#/components/schemas/RecurringOrderStartsAtSetMessagePayload'
@@ -71255,6 +71341,32 @@ components:
7125571341
oldExpiresAt:
7125671342
type: "string"
7125771343
format: "datetime"
71344+
RecurringOrderFailedMessagePayload:
71345+
allOf:
71346+
- $ref: '#/components/schemas/MessagePayload'
71347+
- type: "object"
71348+
required:
71349+
- cartId
71350+
- failedAt
71351+
- failureReason
71352+
- orderScheduledAt
71353+
properties:
71354+
type:
71355+
type: "string"
71356+
cartId:
71357+
type: "string"
71358+
failedAt:
71359+
type: "string"
71360+
format: "datetime"
71361+
failureReason:
71362+
type: "string"
71363+
orderScheduledAt:
71364+
type: "string"
71365+
format: "datetime"
71366+
errors:
71367+
type: "array"
71368+
items:
71369+
$ref: '#/components/schemas/RecurringOrderFailureError'
7125871370
RecurringOrderKeySetMessagePayload:
7125971371
allOf:
7126071372
- $ref: '#/components/schemas/MessagePayload'

uml/api/BaseResource.puml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4008,6 +4008,24 @@ interface RecurringOrderExpiresAtSetMessage [[RecurringOrderExpiresAtSetMessage.
40084008
newExpiresAt: DateTime
40094009
oldExpiresAt: DateTime
40104010
}
4011+
interface RecurringOrderFailedMessage [[RecurringOrderFailedMessage.svg]] {
4012+
id: String
4013+
version: Long
4014+
createdAt: DateTime
4015+
lastModifiedAt: DateTime
4016+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
4017+
createdBy: [[CreatedBy.svg CreatedBy]]
4018+
sequenceNumber: Long
4019+
resource: [[Reference.svg Reference]]
4020+
resourceVersion: Long
4021+
type: String
4022+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
4023+
cartId: String
4024+
failedAt: DateTime
4025+
failureReason: String
4026+
orderScheduledAt: DateTime
4027+
errors: [[RecurringOrderFailureError.svg List<RecurringOrderFailureError>]]
4028+
}
40114029
interface RecurringOrderKeySetMessage [[RecurringOrderKeySetMessage.svg]] {
40124030
id: String
40134031
version: Long
@@ -4780,6 +4798,7 @@ BaseResource --> RecurringOrderCustomTypeRemovedMessage #blue;text:blue : "type
47804798
BaseResource --> RecurringOrderCustomTypeSetMessage #blue;text:blue : "type : RecurringOrderCustomTypeSet"
47814799
BaseResource --> RecurringOrderDeletedMessage #blue;text:blue : "type : RecurringOrderDeleted"
47824800
BaseResource --> RecurringOrderExpiresAtSetMessage #blue;text:blue : "type : RecurringOrderExpiresAtSet"
4801+
BaseResource --> RecurringOrderFailedMessage #blue;text:blue : "type : RecurringOrderFailed"
47834802
BaseResource --> RecurringOrderKeySetMessage #blue;text:blue : "type : RecurringOrderKeySet"
47844803
BaseResource --> RecurringOrderScheduleSetMessage #blue;text:blue : "type : RecurringOrderScheduleSet"
47854804
BaseResource --> RecurringOrderStartsAtSetMessage #blue;text:blue : "type : RecurringOrderStartsAtSet"

uml/api/ErrorObject.puml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,11 @@ interface QueryTimedOutError [[QueryTimedOutError.svg]] {
372372
code: String
373373
message: String
374374
}
375+
interface RecurringOrderFailureError [[RecurringOrderFailureError.svg]] {
376+
code: String
377+
message: String
378+
details: [[Object.svg Object]]
379+
}
375380
interface ReferenceExistsError [[ReferenceExistsError.svg]] {
376381
code: String
377382
message: String
@@ -527,6 +532,7 @@ ErrorObject --> ProductPresentWithDifferentVariantSelectionError #blue;text:blue
527532
ErrorObject --> ProjectNotConfiguredForLanguagesError #blue;text:blue : "code : ProjectNotConfiguredForLanguages"
528533
ErrorObject --> QueryComplexityLimitExceededError #blue;text:blue : "code : QueryComplexityLimitExceeded"
529534
ErrorObject --> QueryTimedOutError #blue;text:blue : "code : QueryTimedOut"
535+
ErrorObject --> RecurringOrderFailureError #blue;text:blue : "code : RecurringOrderFailure"
530536
ErrorObject --> ReferenceExistsError #blue;text:blue : "code : ReferenceExists"
531537
ErrorObject --> ReferencedResourceNotFoundError #blue;text:blue : "code : ReferencedResourceNotFound"
532538
ErrorObject --> RequiredFieldError #blue;text:blue : "code : RequiredField"

uml/api/GraphQLErrorObject.puml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,10 @@ interface GraphQLQueryComplexityLimitExceededError [[GraphQLQueryComplexityLimit
305305
interface GraphQLQueryTimedOutError [[GraphQLQueryTimedOutError.svg]] {
306306
code: String
307307
}
308+
interface GraphQLRecurringOrderFailureError [[GraphQLRecurringOrderFailureError.svg]] {
309+
code: String
310+
details: [[Object.svg Object]]
311+
}
308312
interface GraphQLReferenceExistsError [[GraphQLReferenceExistsError.svg]] {
309313
code: String
310314
referencedBy: [[ReferenceTypeId.svg ReferenceTypeId]]
@@ -425,6 +429,7 @@ GraphQLErrorObject --> GraphQLProductPresentWithDifferentVariantSelectionError #
425429
GraphQLErrorObject --> GraphQLProjectNotConfiguredForLanguagesError #blue;text:blue : "code : ProjectNotConfiguredForLanguages"
426430
GraphQLErrorObject --> GraphQLQueryComplexityLimitExceededError #blue;text:blue : "code : QueryComplexityLimitExceeded"
427431
GraphQLErrorObject --> GraphQLQueryTimedOutError #blue;text:blue : "code : QueryTimedOut"
432+
GraphQLErrorObject --> GraphQLRecurringOrderFailureError #blue;text:blue : "code : RecurringOrderFailure"
428433
GraphQLErrorObject --> GraphQLReferenceExistsError #blue;text:blue : "code : ReferenceExists"
429434
GraphQLErrorObject --> GraphQLReferencedResourceNotFoundError #blue;text:blue : "code : ReferencedResourceNotFound"
430435
GraphQLErrorObject --> GraphQLRequiredFieldError #blue;text:blue : "code : RequiredField"
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
@startuml
2+
3+
hide empty fields
4+
hide empty methods
5+
legend
6+
|= |= line |
7+
|<back:black> </back>| inheritance |
8+
|<back:green> </back>| property reference |
9+
|<back:blue> </back>| discriminated class |
10+
endlegend
11+
interface GraphQLRecurringOrderFailureError [[GraphQLRecurringOrderFailureError.svg]] extends GraphQLErrorObject {
12+
code: String
13+
details: [[Object.svg Object]]
14+
}
15+
interface GraphQLErrorObject [[GraphQLErrorObject.svg]] {
16+
code: String
17+
}
18+
19+
20+
21+
22+
23+
@enduml

uml/api/Message.puml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3927,6 +3927,24 @@ interface RecurringOrderExpiresAtSetMessage [[RecurringOrderExpiresAtSetMessage.
39273927
newExpiresAt: DateTime
39283928
oldExpiresAt: DateTime
39293929
}
3930+
interface RecurringOrderFailedMessage [[RecurringOrderFailedMessage.svg]] {
3931+
id: String
3932+
version: Long
3933+
createdAt: DateTime
3934+
lastModifiedAt: DateTime
3935+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
3936+
createdBy: [[CreatedBy.svg CreatedBy]]
3937+
sequenceNumber: Long
3938+
resource: [[Reference.svg Reference]]
3939+
resourceVersion: Long
3940+
type: String
3941+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
3942+
cartId: String
3943+
failedAt: DateTime
3944+
failureReason: String
3945+
orderScheduledAt: DateTime
3946+
errors: [[RecurringOrderFailureError.svg List<RecurringOrderFailureError>]]
3947+
}
39303948
interface RecurringOrderKeySetMessage [[RecurringOrderKeySetMessage.svg]] {
39313949
id: String
39323950
version: Long
@@ -4804,6 +4822,7 @@ Message --> RecurringOrderCustomTypeRemovedMessage #blue;text:blue : "type : Rec
48044822
Message --> RecurringOrderCustomTypeSetMessage #blue;text:blue : "type : RecurringOrderCustomTypeSet"
48054823
Message --> RecurringOrderDeletedMessage #blue;text:blue : "type : RecurringOrderDeleted"
48064824
Message --> RecurringOrderExpiresAtSetMessage #blue;text:blue : "type : RecurringOrderExpiresAtSet"
4825+
Message --> RecurringOrderFailedMessage #blue;text:blue : "type : RecurringOrderFailed"
48074826
Message --> RecurringOrderKeySetMessage #blue;text:blue : "type : RecurringOrderKeySet"
48084827
Message --> RecurringOrderScheduleSetMessage #blue;text:blue : "type : RecurringOrderScheduleSet"
48094828
Message --> RecurringOrderStartsAtSetMessage #blue;text:blue : "type : RecurringOrderStartsAtSet"

uml/api/MessagePayload.puml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1332,6 +1332,14 @@ interface RecurringOrderExpiresAtSetMessagePayload [[RecurringOrderExpiresAtSetM
13321332
newExpiresAt: DateTime
13331333
oldExpiresAt: DateTime
13341334
}
1335+
interface RecurringOrderFailedMessagePayload [[RecurringOrderFailedMessagePayload.svg]] {
1336+
type: String
1337+
cartId: String
1338+
failedAt: DateTime
1339+
failureReason: String
1340+
orderScheduledAt: DateTime
1341+
errors: [[RecurringOrderFailureError.svg List<RecurringOrderFailureError>]]
1342+
}
13351343
interface RecurringOrderKeySetMessagePayload [[RecurringOrderKeySetMessagePayload.svg]] {
13361344
type: String
13371345
key: String
@@ -1801,6 +1809,7 @@ MessagePayload --> RecurringOrderCustomTypeRemovedMessagePayload #blue;text:blue
18011809
MessagePayload --> RecurringOrderCustomTypeSetMessagePayload #blue;text:blue : "type : RecurringOrderCustomTypeSet"
18021810
MessagePayload --> RecurringOrderDeletedMessagePayload #blue;text:blue : "type : RecurringOrderDeleted"
18031811
MessagePayload --> RecurringOrderExpiresAtSetMessagePayload #blue;text:blue : "type : RecurringOrderExpiresAtSet"
1812+
MessagePayload --> RecurringOrderFailedMessagePayload #blue;text:blue : "type : RecurringOrderFailed"
18041813
MessagePayload --> RecurringOrderKeySetMessagePayload #blue;text:blue : "type : RecurringOrderKeySet"
18051814
MessagePayload --> RecurringOrderScheduleSetMessagePayload #blue;text:blue : "type : RecurringOrderScheduleSet"
18061815
MessagePayload --> RecurringOrderStartsAtSetMessagePayload #blue;text:blue : "type : RecurringOrderStartsAtSet"
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
@startuml
2+
3+
hide empty fields
4+
hide empty methods
5+
legend
6+
|= |= line |
7+
|<back:black> </back>| inheritance |
8+
|<back:green> </back>| property reference |
9+
|<back:blue> </back>| discriminated class |
10+
endlegend
11+
interface RecurringOrderFailedMessage [[RecurringOrderFailedMessage.svg]] extends Message {
12+
id: String
13+
version: Long
14+
createdAt: DateTime
15+
lastModifiedAt: DateTime
16+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
17+
createdBy: [[CreatedBy.svg CreatedBy]]
18+
sequenceNumber: Long
19+
resource: [[Reference.svg Reference]]
20+
resourceVersion: Long
21+
type: String
22+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
23+
cartId: String
24+
failedAt: DateTime
25+
failureReason: String
26+
orderScheduledAt: DateTime
27+
errors: [[RecurringOrderFailureError.svg List<RecurringOrderFailureError>]]
28+
}
29+
interface Message [[Message.svg]] {
30+
id: String
31+
version: Long
32+
createdAt: DateTime
33+
lastModifiedAt: DateTime
34+
lastModifiedBy: [[LastModifiedBy.svg LastModifiedBy]]
35+
createdBy: [[CreatedBy.svg CreatedBy]]
36+
sequenceNumber: Long
37+
resource: [[Reference.svg Reference]]
38+
resourceVersion: Long
39+
type: String
40+
resourceUserProvidedIdentifiers: [[UserProvidedIdentifiers.svg UserProvidedIdentifiers]]
41+
}
42+
43+
44+
45+
46+
47+
@enduml
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
@startuml
2+
3+
hide empty fields
4+
hide empty methods
5+
legend
6+
|= |= line |
7+
|<back:black> </back>| inheritance |
8+
|<back:green> </back>| property reference |
9+
|<back:blue> </back>| discriminated class |
10+
endlegend
11+
interface RecurringOrderFailedMessagePayload [[RecurringOrderFailedMessagePayload.svg]] extends MessagePayload {
12+
type: String
13+
cartId: String
14+
failedAt: DateTime
15+
failureReason: String
16+
orderScheduledAt: DateTime
17+
errors: [[RecurringOrderFailureError.svg List<RecurringOrderFailureError>]]
18+
}
19+
interface MessagePayload [[MessagePayload.svg]] {
20+
type: String
21+
}
22+
23+
24+
25+
26+
27+
@enduml

0 commit comments

Comments
 (0)