diff --git a/code/API_definitions/device-reachability-status.yaml b/code/API_definitions/device-reachability-status.yaml new file mode 100644 index 00000000..bf891285 --- /dev/null +++ b/code/API_definitions/device-reachability-status.yaml @@ -0,0 +1,403 @@ +openapi: 3.0.3 +info: + title: Device Reachability Status + description: | + This API provides the customer with the ability to query device reachability status. + + # Introduction + + ## Reachability Status + + API consumer is able to verify whether a certain user device is reachable from the network via data- or sms-usage. + + ## Relevant terms and definitions + + * **Device**: A device refers to any physical entity that can connect to a network and participate in network communication. + At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device. + + * **Reachability** : Reachability status. + - `CONNECTED_SMS`, if device is connected to the network via SMS usage + - `CONNECTED_DATA`, if device is connected to the network via data usage + - `NOT_CONNECTED`, if device is not connected to the network + + * **LastStatusTime** : This property specifies the time when the status was last updated. Its presence in the response indicates the freshness of the information, while its absence implies the information may be outdated or its freshness is uncertain. + + ## API Functionality + + The API exposes following capabilities: + + ### Device Reachability situation + + The endpoint `POST /retrieve` allows to get current connectivity status information synchronously. + + ## Authorization and authentication + + [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token. + + Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. + + It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. + + ## Further info and support + + (FAQs will be added in a later version of the documentation) + + termsOfService: http://swagger.io/terms/ + contact: + email: project-email@sample.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: wip +externalDocs: + description: Product documentation at CAMARA + url: https://github.com/camaraproject/ + +servers: + - url: "{apiRoot}/device-reachability-status/v0" + variables: + apiRoot: + default: http://localhost:9091 + description: API root +tags: + - name: Device reachability status + description: Operations to get the current reachability status of a device +paths: + /retrieve: + post: + tags: + - Device reachability status + summary: "Get the current reachability status information" + description: Get the current reachability status information + operationId: getReachabilityStatus + parameters: + - $ref: '#/components/parameters/x-correlator' + security: + - openId: + - device-reachability-status:read + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/RequestReachabilityStatus" + required: true + responses: + "200": + description: Contains information about current reachability status + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ReachabilityStatusResponse" + examples: + Connected-With-SMS: + value: + lastStatusTime: "2024-02-20T10:41:38.657Z" + reachabilityStatus: CONNECTED_SMS + Connected-With-DATA: + value: + lastStatusTime: "2024-02-20T10:41:38.657Z" + reachabilityStatus: CONNECTED_DATA + Not-Connected: + value: + lastStatusTime: "2024-02-20T10:41:38.657Z" + reachabilityStatus: NOT_CONNECTED + "400": + $ref: "#/components/responses/Generic400" + "401": + $ref: "#/components/responses/Generic401" + "403": + $ref: "#/components/responses/ReachabilityPermissionDenied403" + "404": + $ref: "#/components/responses/ReachabilityNotFound404" + "422": + $ref: "#/components/responses/ReachabilityUnprocessableEntity422" + "500": + $ref: "#/components/responses/Generic500" + "503": + $ref: "#/components/responses/Generic503" +components: + securitySchemes: + openId: + type: openIdConnect + openIdConnectUrl: https://example.com/.well-known/openid-configuration + parameters: + 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: + LastStatusTime: + description: Last time that the associated device reachability status was updated + type: string + format: date-time + example: "2024-02-20T10:41:38.657Z" + ReachabilityStatusResponse: + type: object + required: + - reachabilityStatus + properties: + lastStatusTime: + $ref: "#/components/schemas/LastStatusTime" + reachabilityStatus: + $ref: "#/components/schemas/ReachabilityStatus" + ReachabilityStatus: + description: | + CONNECTED_DATA: The device is connected to the network for Data usage + + CONNECTED_SMS: The device is connected to the network for SMS usage + + NOT_CONNECTED: The device is not connected + type: string + enum: + - CONNECTED_DATA + - CONNECTED_SMS + - NOT_CONNECTED + Device: + description: | + End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. + + The developer can choose to provide the below specified device identifiers: + + * `ipv4Address` + * `ipv6Address` + * `phoneNumber` + * `networkAccessIdentifier` + + NOTE: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device. + type: object + properties: + phoneNumber: + $ref: "#/components/schemas/PhoneNumber" + networkAccessIdentifier: + $ref: "#/components/schemas/NetworkAccessIdentifier" + ipv4Address: + $ref: "#/components/schemas/DeviceIpv4Addr" + ipv6Address: + $ref: "#/components/schemas/DeviceIpv6Address" + minProperties: 1 + + PhoneNumber: + description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'. + type: string + pattern: '^\+[1-9][0-9]{4,14}$' + example: "+123456789" + + NetworkAccessIdentifier: + description: A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the network access identifier is not subjected to portability ruling in force, and is individually managed by each operator. + type: string + example: "123456789@domain.com" + + DeviceIpv4Addr: + type: object + description: | + The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers). + + If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then the same address should be specified for both publicAddress and privateAddress. + + If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object) + + In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone. + properties: + publicAddress: + $ref: "#/components/schemas/SingleIpv4Addr" + privateAddress: + $ref: "#/components/schemas/SingleIpv4Addr" + publicPort: + $ref: "#/components/schemas/Port" + anyOf: + - required: [publicAddress, privateAddress] + - required: [publicAddress, publicPort] + example: + publicAddress: "84.125.93.10" + publicPort: 59765 + + SingleIpv4Addr: + description: A single IPv4 address with no subnet mask + type: string + format: ipv4 + example: "84.125.93.10" + + Port: + description: TCP or UDP port number + type: integer + minimum: 0 + maximum: 65535 + + DeviceIpv6Address: + description: | + The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to the /64 prefix). + type: string + format: ipv6 + example: 2001:db8:85a3:8d3:1319:8a2e:370:7344 + + RequestReachabilityStatus: + type: object + properties: + device: + $ref: "#/components/schemas/Device" + required: + - device + + ErrorInfo: + type: object + required: + - status + - code + - message + properties: + status: + type: integer + description: HTTP response status code + code: + type: string + description: Code given to this error + message: + type: string + description: Detailed error description + + responses: + Generic400: + description: Problem with the client request + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 400 + code: "INVALID_ARGUMENT" + 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: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 401 + code: "UNAUTHENTICATED" + message: "Request not authenticated due to missing, invalid, or expired credentials" + ReachabilityPermissionDenied403: + description: | + Client does not have sufficient permission. + In addition to regular scenario of `PERMISSION_DENIED`, other scenarios may exist: + - Phone number cannot be deducted from access token context.(`{"code": "INVALID_TOKEN_CONTEXT","message": "Phone number cannot be deducted from access token context"}`) + headers: + X-Correlator: + description: Correlation id for the different services + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorInfo' + examples: + PermissionDenied: + value: + status: 403 + code: "PERMISSION_DENIED" + message: "Client does not have sufficient permissions to perform this action" + InvalidTokenContext: + value: + status: 403 + code: INVALID_TOKEN_CONTEXT + message: Invalid access token context + ReachabilityNotFound404: + description: Resource Not Found + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + examples: + DeviceIdentifierNotFound: + value: + status: 404 + code: DEVICE_NOT_FOUND + message: Some identifier cannot be matched to a device + Generic409: + description: Conflict + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 409 + code: CONFLICT + message: "The specified resource is in a conflict" + ReachabilityUnprocessableEntity422: + description: Unprocessable Entity + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + examples: + UnsupportedDeviceIdentifiers: + value: + status: 422 + code: UNSUPPORTED_DEVICE_IDENTIFIERS + message: "None of the provided device identifiers is supported by the implementation" + InconsistentDeviceIdentifiers: + value: + status: 422 + code: DEVICE_IDENTIFIERS_MISMATCH + message: Device identifiers mismatch + DeviceNotSupported: + value: + status: 422 + code: DEVICE_NOT_APPLICABLE + message: Service not applicable to the device + NetworkIssueToRetrieveReacabilityStatus: + value: + status: 422 + code: DEVICE_REACHABILITY_STATUS.UNABLE_TO_PROVIDE_REACHABILITY_STATUS + message: Network issue - Unable to provide reachability status + Generic500: + description: Server error + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 500 + code: "INTERNAL" + message: "Server error" + Generic503: + description: Service unavailable. Typically the server is down. + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 503 + code: "UNAVAILABLE" + message: "Service unavailable" diff --git a/code/API_definitions/device-roaming-status.yaml b/code/API_definitions/device-roaming-status.yaml new file mode 100644 index 00000000..23264675 --- /dev/null +++ b/code/API_definitions/device-roaming-status.yaml @@ -0,0 +1,432 @@ +openapi: 3.0.3 +info: + title: Device Roaming Status + description: | + This API provides the customer with the ability to query device roaming Status + + # Introduction + + ## Roaming Status + API consumer is able to verify whether a certain user device is in roaming situation (or not). + + The verification of the roaming situation depends on the network's ability. Additionally to the roaming status, when the device is in roaming situation, visited country information could be returned in the response. + + ## Possible Use-Cases + Roaming status verification could be useful in scenario such as (not exhaustive): + - For regulatory reasons, where a customer may need to be within a certain jurisdiction, or out with others, in order for transactions to be authorized + - For security / fraud reasons, to establish that a customer is located where they claim to be + - For service delivery reasons, to ensure that the customer has access to particular service, and will not incur roaming charges in accessing them + + + ## Relevant terms and definitions + + * **Device**: A device refers to any physical entity that can connect to a network and participate in network communication. + At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device. + + * **Roaming** : Roaming status - `true`, if device is in roaming situation - `false` else. + + * **Country** : Country code and name - visited country information, provided if the device is in roaming situation. + + * **LastStatusTime** : This property specifies the time when the status was last updated. Its presence in the response indicates the freshness of the information, while its absence implies the information may be outdated or its freshness is uncertain. + + ## API Functionality + + The API exposes following capabilities: + + ## Device roaming situation + + The endpoint `POST /retrieve` allows to get roaming status and country information (if device in roaming situation) synchronously. + + ## Authorization and authentication + + [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token. + + Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. + + It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. + + + ## Further info and support + + (FAQs will be added in a later version of the documentation) + + termsOfService: http://swagger.io/terms/ + contact: + email: project-email@sample.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: wip +externalDocs: + description: Product documentation at CAMARA + url: https://github.com/camaraproject/ + +servers: + - url: "{apiRoot}/device-roaming-status/v0" + variables: + apiRoot: + default: http://localhost:9091 + description: API root + +tags: + - name: Roaming status retrieval + description: Operation to get device roaming status and country information (if roaming) synchronously +paths: + /retrieve: + post: + tags: + - Roaming status retrieval + 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-roaming-status:read + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/RequestRoamingStatus" + required: true + responses: + "200": + description: Contains information about current roaming status + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/RoamingStatusResponse" + examples: + No-Country-Name: + value: + lastStatusTime: "2024-02-20T10:41:38.657Z" + roaming: true + countryCode: 901 + countryName: [] + Single-Country-Code: + value: + lastStatusTime: "2024-02-20T10:41:38.657Z" + roaming: true + countryCode: 262 + countryName: ["DE"] + Multiple-Country-Codes: + value: + lastStatusTime: "2024-02-20T10:41:38.657Z" + roaming: true + countryCode: 340 + countryName: ["BL", "GF", "GP", "MF", "MQ"] + "400": + $ref: "#/components/responses/Generic400" + "401": + $ref: "#/components/responses/Generic401" + "403": + $ref: "#/components/responses/RoamingPermissionDenied403" + "404": + $ref: "#/components/responses/RoamingNotFound404" + "422": + $ref: "#/components/responses/RoamingUnprocessableEntity422" + "500": + $ref: "#/components/responses/Generic500" + "503": + $ref: "#/components/responses/Generic503" + +components: + securitySchemes: + openId: + type: openIdConnect + openIdConnectUrl: https://example.com/.well-known/openid-configuration + parameters: + 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 + required: + - roaming + properties: + lastStatusTime: + $ref: "#/components/schemas/LastStatusTime" + roaming: + $ref: "#/components/schemas/ActiveRoaming" + countryCode: + $ref: "#/components/schemas/CountryCode" + countryName: + $ref: "#/components/schemas/CountryName" + + LastStatusTime: + description: Last time that the associated device roaming status was updated + type: string + format: date-time + example: "2024-02-20T10:41:38.657Z" + + ActiveRoaming: + description: Roaming status. True, if it is roaming + type: boolean + + Device: + description: | + End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. + + The developer can choose to provide the below specified device identifiers: + + * `ipv4Address` + * `ipv6Address` + * `phoneNumber` + * `networkAccessIdentifier` + + NOTE: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device. + type: object + properties: + phoneNumber: + $ref: "#/components/schemas/PhoneNumber" + networkAccessIdentifier: + $ref: "#/components/schemas/NetworkAccessIdentifier" + ipv4Address: + $ref: "#/components/schemas/DeviceIpv4Addr" + ipv6Address: + $ref: "#/components/schemas/DeviceIpv6Address" + minProperties: 1 + + PhoneNumber: + description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'. + type: string + pattern: '^\+[1-9][0-9]{4,14}$' + example: "+123456789" + + NetworkAccessIdentifier: + description: A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the network access identifier is not subjected to portability ruling in force, and is individually managed by each operator. + type: string + example: "123456789@domain.com" + + DeviceIpv4Addr: + type: object + description: | + The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers). + + If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then the same address should be specified for both publicAddress and privateAddress. + + If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object) + + In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone. + properties: + publicAddress: + $ref: "#/components/schemas/SingleIpv4Addr" + privateAddress: + $ref: "#/components/schemas/SingleIpv4Addr" + publicPort: + $ref: "#/components/schemas/Port" + anyOf: + - required: [publicAddress, privateAddress] + - required: [publicAddress, publicPort] + example: + publicAddress: "84.125.93.10" + publicPort: 59765 + + SingleIpv4Addr: + description: A single IPv4 address with no subnet mask + type: string + format: ipv4 + example: "84.125.93.10" + + Port: + description: TCP or UDP port number + type: integer + minimum: 0 + maximum: 65535 + + DeviceIpv6Address: + description: | + The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to the /64 prefix). + type: string + format: ipv6 + example: 2001:db8:85a3:8d3:1319:8a2e:370:7344 + + CountryCode: + description: The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas. + type: integer + + CountryName: + description: The ISO 3166 ALPHA-2 country-codes of mapped to mobile country code(MCC). If there is mapping of one MCC to multiple countries, then we have list of countries. If there is no mapping of MCC to any country, then an empty array [] shall be returned.. + type: array + items: + type: string + + RequestRoamingStatus: + type: object + properties: + device: + $ref: "#/components/schemas/Device" + required: + - device + + ErrorInfo: + type: object + required: + - status + - code + - message + properties: + status: + type: integer + description: HTTP response status code + code: + type: string + description: Code given to this error + message: + type: string + description: Detailed error description + + responses: + Generic400: + description: Problem with the client request + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 400 + code: "INVALID_ARGUMENT" + 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: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 401 + code: "UNAUTHENTICATED" + message: "Request not authenticated due to missing, invalid, or expired credentials" + RoamingPermissionDenied403: + description: | + Client does not have sufficient permission. + In addition to regular scenario of `PERMISSION_DENIED`, other scenarios may exist: + - Phone number cannot be deducted from access token context.(`{"code": "DEVICE_ROAMING_STATUS.INVALID_TOKEN_CONTEXT","message": "Phone number cannot be deducted from access token context"}`) + headers: + X-Correlator: + description: Correlation id for the different services + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorInfo' + examples: + PermissionDenied: + value: + status: 403 + code: "PERMISSION_DENIED" + message: "Client does not have sufficient permissions to perform this action" + InvalidTokenContext: + value: + status: 403 + code: INVALID_TOKEN_CONTEXT + message: Invalid access token context + RoamingNotFound404: + description: Resource Not Found + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + examples: + NotFound: + value: + status: 404 + code: NOT_FOUND + message: "The specified resource is not found" + DeviceIdentifierNotFound: + value: + status: 404 + code: DEVICE_NOT_FOUND + message: Some identifier cannot be matched to a device + Generic409: + description: Conflict + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 409 + code: CONFLICT + message: "The specified resource is in a conflict" + RoamingUnprocessableEntity422: + description: Unprocessable Entity + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + examples: + UnsupportedDeviceIdentifiers: + value: + status: 422 + code: UNSUPPORTED_DEVICE_IDENTIFIERS + message: "None of the provided device identifiers is supported by the implementation" + InconsistentDeviceIdentifiers: + value: + status: 422 + code: DEVICE_IDENTIFIERS_MISMATCH + message: Device identifiers mismatch + DeviceNotSupported: + value: + status: 422 + code: DEVICE_NOT_APPLICABLE + message: Service not applicable to the device + NetworkIssueToRetrieveRoamingStatus: + value: + status: 422 + code: DEVICE_ROAMING_STATUS.UNABLE_TO_PROVIDE_ROAMING_STATUS + message: Network issue - Unable to provide roaming status + Generic500: + description: Server error + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 500 + code: "INTERNAL" + message: "Server error" + Generic503: + description: Service unavailable. Typically the server is down. + headers: + x-correlator: + $ref: '#/components/headers/x-correlator' + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + status: 503 + code: "UNAVAILABLE" + message: "Service unavailable" diff --git a/code/API_definitions/device-status.yaml b/code/API_definitions/device-status.yaml index 5cb832e8..a284a8e6 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -101,13 +101,13 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.6.0-alpha.1 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: "{apiRoot}/device-status/v0" + - url: "{apiRoot}/device-status/v0.6alpha1" variables: apiRoot: default: http://localhost:9091