Skip to content

Commit 317da98

Browse files
committed
Updated API from documentation release
1 parent bb9d1c5 commit 317da98

File tree

3 files changed

+30
-4
lines changed

3 files changed

+30
-4
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#%RAML 1.0 DataType
2+
(package): Event
3+
displayName: Event
4+
description: |
5+
Base representation of an Event containing common fields to all [Event Types](#eventtype).
6+
properties:
7+
id:
8+
(identifier): true
9+
type: string
10+
description: Unique identifier of the Event.
11+
notificationType:
12+
type: string
13+
enum:
14+
- Event
15+
resourceType:
16+
type: EventSubscriptionResourceTypeId
17+
description: |
18+
The type of resource targeted by the Event.
19+
type:
20+
type: EventType
21+
description: |
22+
The type of Event that has occurred.
23+
data:
24+
type: object
25+
description: |
26+
An object containing details related to the Event.
27+
createdAt:
28+
type: datetime
29+
description: Date and time (UTC) the Event was generated.

api-specs/api/types/event/Event.raml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@ properties:
2121
type: EventType
2222
description: |
2323
The type of Event that has occurred.
24-
data:
25-
type: object
26-
description: |
27-
An object containing details related to the Event.
2824
createdAt:
2925
type: datetime
3026
description: Date and time (UTC) the Event was generated.

api-specs/api/types/types.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -676,6 +676,7 @@ GraphQLSemanticErrorError: !include error/graphql/GraphQLSemanticErrorError.raml
676676
GraphQLShippingMethodDoesNotMatchCartError: !include error/graphql/GraphQLShippingMethodDoesNotMatchCartError.raml
677677
GraphQLStoreCartDiscountsLimitReachedError: !include error/graphql/GraphQLStoreCartDiscountsLimitReachedError.raml
678678
GraphQLSyntaxErrorError: !include error/graphql/GraphQLSyntaxErrorError.raml
679+
BaseEvent: !include event/BaseEvent.raml
679680
Event: !include event/Event.raml
680681
ImportContainerCreatedEvent: !include event/ImportContainerCreatedEvent.raml
681682
ImportContainerCreatedEventData: !include event/ImportContainerCreatedEventData.raml

0 commit comments

Comments
 (0)