diff --git a/config/api/vis-api.yaml b/config/api/vis-api.yaml index 6bc0775bfdc8daa2ba70740234ede3b103bfa3d7..e5b565e6a7e7c03e55b9e11c0f2c5f14770bb60c 100644 --- a/config/api/vis-api.yaml +++ b/config/api/vis-api.yaml @@ -167,6 +167,11 @@ paths: application/json: schema: $ref: '#/components/schemas/V2xMsgPublication' + example: + msgContent: 'Hello World' + msgEncodeFormat: 'base64' + msgType: '1' + stdOrganization: 'ETSI' responses: '204': $ref: '#/components/responses/204' @@ -204,6 +209,16 @@ paths: application/json: schema: $ref: '#/components/schemas/SubscriptionLinkList' + example: + _links: + self: + href: 'http://meAppServer.example.com/vis/v2/subscriptions' + subscription: + - _links: + self: + href: 'http://meAppServer.example.com/vis/v2/subscriptions/123' + callbackReference: 'http://my.callback.com/vis-v2x-msg/some-id' + subscriptionType: V2xMsgSubscription '400': $ref: '#/components/responses/400' '401': @@ -232,6 +247,17 @@ paths: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription' - $ref: '#/components/schemas/ProvChgPc5Subscription' - $ref: '#/components/schemas/V2xMsgSubscription' + example: + subscriptionType: V2xMsgSubscription + callbackReference: 'http://my.callback.com/vis-v2x-msg/some-id' + filterCriteria: + stdOrganization: 'ETSI' + msgType: + - 1 + - 2 + expiryDeadline: + seconds: 1977836800 + nanoseconds: 0 responses: '201': description: 'In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type.' @@ -243,6 +269,20 @@ paths: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription' - $ref: '#/components/schemas/ProvChgPc5Subscription' - $ref: '#/components/schemas/V2xMsgSubscription' + example: + subscriptionType: V2xMsgSubscription + callbackReference: 'http://my.callback.com/vis-v2x-msg/some-id' + _links: + self: + href: 'http://meAppServer.example.com/vis/v2/subscriptions/123' + filterCriteria: + stdOrganization: 'ETSI' + msgType: + - 1 + - 2 + expiryDeadline: + seconds: 1977836800 + nanoseconds: 0 '400': $ref: '#/components/responses/400' '401': @@ -309,6 +349,20 @@ paths: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription' - $ref: '#/components/schemas/ProvChgPc5Subscription' - $ref: '#/components/schemas/V2xMsgSubscription' + example: + subscriptionType: V2xMsgSubscription + callbackReference: 'http://my.callback.com/vis-v2x-msg/some-id' + _links: + self: + href: 'http://meAppServer.example.com/vis/v2/subscriptions/123' + filterCriteria: + stdOrganization: 'ETSI' + msgType: + - 1 + - 2 + expiryDeadline: + seconds: 1977836800 + nanoseconds: 0 '400': $ref: '#/components/responses/400' '401': @@ -338,6 +392,20 @@ paths: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription' - $ref: '#/components/schemas/ProvChgPc5Subscription' - $ref: '#/components/schemas/V2xMsgSubscription' + example: + subscriptionType: V2xMsgSubscription + callbackReference: 'http://my.callback.com/vis-v2x-msg/some-id' + _links: + self: + href: 'http://meAppServer.example.com/vis/v2/subscriptions/123' + filterCriteria: + stdOrganization: 'ETSI' + msgType: + - 1 + - 2 + expiryDeadline: + seconds: 1977836800 + nanoseconds: 0 responses: '200': description: 'A response body containing data type describing the updated subscription is returned' @@ -349,6 +417,21 @@ paths: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription' - $ref: '#/components/schemas/ProvChgPc5Subscription' - $ref: '#/components/schemas/V2xMsgSubscription' + example: + example: + subscriptionType: V2xMsgSubscription + callbackReference: 'http://my.callback.com/vis-v2x-msg/some-id' + _links: + self: + href: 'http://meAppServer.example.com/vis/v2/subscriptions/123' + filterCriteria: + stdOrganization: 'ETSI' + msgType: + - 1 + - 2 + expiryDeadline: + seconds: 1977836800 + nanoseconds: 0 '400': $ref: '#/components/responses/400' '401':