diff --git a/code/API_definitions/device-status.yaml b/code/API_definitions/device-status.yaml index cfff538..655712b 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -99,7 +99,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 0.5.1 + version: wip externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ @@ -127,6 +127,8 @@ paths: summary: "Get the current connectivity status information" description: Get the current connectivity status information operationId: getConnectivityStatus + parameters: + - $ref: '#/components/parameters/x-correlator' security: - openId: - device-status:connectivity:read @@ -139,6 +141,9 @@ paths: responses: "200": description: Contains information about current connectivity status + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -172,6 +177,8 @@ paths: summary: "Get the current roaming status and the country information" description: Get the current roaming status and the country information operationId: getRoamingStatus + parameters: + - $ref: '#/components/parameters/x-correlator' security: - openId: - device-status:roaming:read @@ -184,6 +191,9 @@ paths: responses: "200": description: Contains information about current roaming status + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -223,6 +233,8 @@ paths: summary: "Create a device status event subscription for a device" description: Create a device status event subscription for a device operationId: createDeviceStatusSubscription + parameters: + - $ref: '#/components/parameters/x-correlator' security: - openId: - device-status:subscriptions:create @@ -243,6 +255,8 @@ paths: Important: this endpoint is to be implemented by the API consumer. The Device status server will call this endpoint whenever any device status related event occurs. operationId: postNotification + parameters: + - $ref: '#/components/parameters/x-correlator' requestBody: required: true content: @@ -269,6 +283,9 @@ paths: responses: "204": description: Successful notification + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' "400": $ref: "#/components/responses/Generic400" "401": @@ -286,12 +303,18 @@ paths: responses: "201": description: Created + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: $ref: "#/components/schemas/SubscriptionInfo" "202": description: Request accepted to be processed. It applies for async creation process. + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -314,12 +337,17 @@ paths: summary: "Retrieve a list of device status event subscription" description: Retrieve a list of device status event subscription(s) operationId: retrieveSubscriptionList + parameters: + - $ref: '#/components/parameters/x-correlator' security: - openId: - device-status:subscriptions:read responses: "200": description: List of event subscription details + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -347,15 +375,14 @@ paths: - openId: - device-status:subscriptions:read parameters: - - name: subscriptionId - in: path - description: Subscription identifier that was obtained from the create subscription operation - required: true - schema: - type: string + - $ref: "#/components/parameters/SubscriptionId" + - $ref: '#/components/parameters/x-correlator' responses: "200": description: OK + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -382,17 +409,19 @@ paths: - openId: - device-status:subscriptions:delete parameters: - - name: subscriptionId - in: path - description: Subscription identifier that was obtained from the create event subscription operation - required: true - schema: - type: string + - $ref: "#/components/parameters/SubscriptionId" + - $ref: '#/components/parameters/x-correlator' responses: "204": description: event subscription deleted + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' "202": description: Request accepted to be processed. It applies for async deletion process. + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -414,6 +443,25 @@ components: openId: type: openIdConnect openIdConnectUrl: https://example.com/.well-known/openid-configuration + parameters: + SubscriptionId: + name: subscriptionId + in: path + description: Subscription identifier that was obtained from the create event subscription operation + required: true + schema: + $ref: '#/components/schemas/SubscriptionId' + x-correlator: + name: x-correlator + in: header + description: Correlation id for the different services + schema: + type: string + headers: + x-correlator: + description: Correlation id for the different services + schema: + type: string schemas: RoamingStatusResponse: type: object @@ -895,6 +943,9 @@ components: responses: Generic400: description: Problem with the client request + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -905,6 +956,9 @@ components: message: "Client specified an invalid argument, request body or query param" Generic401: description: Authentication problem with the client request + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -915,6 +969,9 @@ components: message: "Request not authenticated due to missing, invalid, or expired credentials" Generic403: description: Client does not have sufficient permission + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -925,6 +982,9 @@ components: message: "Client does not have sufficient permissions to perform this action" Generic404: description: Resource Not Found + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -935,6 +995,9 @@ components: message: "The specified resource is not found" Generic409: description: Conflict + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -945,6 +1008,9 @@ components: message: "The specified resource is in a conflict" Generic500: description: Server error + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: @@ -955,6 +1021,9 @@ components: message: "Server error" Generic503: description: Service unavailable. Typically the server is down. + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' content: application/json: schema: