openapi: 3.0.3 info: description: | The Quality-On-Demand (QoD) Provisioning API offers a programmable interface for developers to request the assignment of a certain QoS Profile to a certain device, indefinitely. This API sets up the configuration in the network so the requested QoS profile is applied to an specified device, at any time while the provisioning is available. The device traffic will be treated with a certain QoS profile by the network whenever the device is connected to the network, until the provisioning is deleted. # Relevant terms and definitions * **QoS profiles and QoS profile labels**: Latency, throughput or priority requirements of the application mapped to relevant QoS profile values. The set of QoS Profiles that a network operator is offering may be retrieved via the `qos-profiles` API (cf. https://github.com/camaraproject/QualityOnDemand/) or will be agreed during the onboarding with the API service provider. * **Identifier for the device**: 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 network operator for the device, at the request time. After the provisioning request is accepted, the device may get different IP addresses, but the provisioning will still apply to the device that was identified during the request process. Note: Network Access Identifier is defined for future use and will not be supported with v0.1 of the API. * **Notification URL and token**: Developers may provide a callback URL (`sink`) on which notifications about all status change events (eg. provisioning termination) can be received from the service provider. This is an optional parameter. The notification will be sent as a CloudEvent compliant message. If `sink` is included, it is RECOMMENDED for the client to provide as well the `sinkCredential` property to protect the notification endpoint. In the current version,`sinkCredential.credentialType` MUST be set to `ACCESSTOKEN` if provided. # Resources and Operations overview The API defines four operations: - An operation to setup a new QoD provisioning for a given device. - An operation to get the information about a specific QoD provisioning, identified by its `provisioningId`. - An operation to get the QoD provisioning for a given device. - An operation to terminate a QoD provisioning, identified by its `provisioningId`. # 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. # Identifying a device from the access token This specification defines the `device` object field as optional in API requests, specifically in cases where the API is accessed using a 3-legged access token, and the device can be uniquely identified by the token. This approach simplifies API usage for API consumers by relying on the device information associated with the access token used to invoke the API. ## Handling of device information: ### Optional device object for 3-legged tokens: - When using a 3-legged access token, the device associated with the access token must be considered as the device for the API request. This means that the device object is not required in the request, and if included it must identify the same device, therefore **it is recommended NOT to include it in these scenarios** to simplify the API usage and avoid additional validations. ### Validation mechanism: - The server will extract the device identification from the access token, if available. - If the API request additionally includes a `device` object when using a 3-legged access token, the API will validate that the device identifier provided matches the one associated with the access token. - If there is a mismatch, the API will respond with a 403 - INVALID_TOKEN_CONTEXT error, indicating that the device information in the request does not match the token. ### Error handling for unidentifiable devices: - If the `device` object is not included in the request and the device information cannot be derived from the 3-legged access token, the server will return a 422 `UNIDENTIFIABLE_DEVICE` error. ### Restrictions for tokens without an associated authenticated identifier: - For scenarios which do not have a single device identifier associated to the token during the authentication flow, e.g. 2-legged access tokens, the `device` object MUST be provided in the API request. This ensures that the device identification is explicit and valid for each API call made with these tokens. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: QoD Provisioning API version: 0.1.0 x-camara-commonalities: 0.4.0 externalDocs: description: Project documentation at CAMARA url: https://github.com/camaraproject/QualityOnDemand servers: - url: "{apiRoot}/qod-provisioning/v0.1" variables: apiRoot: default: http://localhost:9091 description: "API root, defined by the service provider, e.g. `api.example.com`\ \ or `api.example.com/somepath`" tags: - description: Manage the permanent provisioning of QoD name: QoD Provisioning paths: /device-qos: post: callbacks: notifications: '{$request.body#/sink}': post: description: | Important: this endpoint is to be implemented by the API consumer. The QoD server will call this endpoint whenever any QoD provisioning change related event occurs. Currently only `PROVISIONING_STATUS_CHANGED` event is defined. operationId: postProvisioningNotification parameters: - description: Correlation id for the different services explode: false in: header name: x-correlator required: false schema: type: string style: simple requestBody: content: application/cloudevents+json: examples: PROVISIONING_STATUS_CHANGED_EXAMPLE: $ref: '#/components/examples/PROVISIONING_STATUS_CHANGED_EXAMPLE' schema: $ref: '#/components/schemas/CloudEvent' required: true responses: "204": description: Successful notification headers: x-correlator: $ref: '#/components/headers/x-correlator' "400": content: application/json: examples: GENERIC_400_INVALID_ARGUMENT: description: Invalid Argument. Generic Syntax Exception value: status: 400 code: INVALID_ARGUMENT message: "Client specified an invalid argument, request\ \ body or query param." GENERIC_400_OUT_OF_RANGE: description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested value: status: 400 code: OUT_OF_RANGE message: Client specified an invalid range. schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request headers: x-correlator: $ref: '#/components/headers/x-correlator' "401": content: application/json: examples: GENERIC_401_UNAUTHENTICATED: description: Request cannot be authenticated value: status: 401 code: UNAUTHENTICATED message: "Request not authenticated due to missing, invalid,\ \ or expired credentials." GENERIC_401_AUTHENTICATION_REQUIRED: description: "New authentication is needed, authentication\ \ is no longer valid" value: status: 401 code: AUTHENTICATION_REQUIRED message: New authentication is required. schema: $ref: '#/components/schemas/ErrorInfo' description: Unauthorized headers: x-correlator: $ref: '#/components/headers/x-correlator' "403": content: application/json: examples: GENERIC_403_PERMISSION_DENIED: description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security value: status: 403 code: PERMISSION_DENIED message: Client does not have sufficient permissions to perform this action. GENERIC_403_INVALID_TOKEN_CONTEXT: description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token value: status: 403 code: INVALID_TOKEN_CONTEXT message: "{{field}} is not consistent with access token." schema: $ref: '#/components/schemas/ErrorInfo' description: Forbidden headers: x-correlator: $ref: '#/components/headers/x-correlator' "410": content: application/json: examples: GENERIC_410_GONE: description: Use in notifications flow to allow API Consumer to indicate that its callback is no longer available value: status: 410 code: GONE message: Access to the target resource is no longer available. schema: $ref: '#/components/schemas/ErrorInfo' description: Gone headers: x-correlator: $ref: '#/components/headers/x-correlator' "429": content: application/json: examples: GENERIC_429_QUOTA_EXCEEDED: description: Request is rejected due to exceeding a business quota limit value: status: 429 code: QUOTA_EXCEEDED message: Either out of resource quota or reaching rate limiting. GENERIC_429_TOO_MANY_REQUESTS: description: API Server request limit is overpassed value: status: 429 code: TOO_MANY_REQUESTS message: Either out of resource quota or reaching rate limiting. schema: $ref: '#/components/schemas/ErrorInfo' description: Too Many Requests headers: x-correlator: $ref: '#/components/headers/x-correlator' "500": content: application/json: examples: GENERIC_500_INTERNAL: description: Problem in Server side. Regular Server Exception value: status: 500 code: INTERNAL message: Unknown server error. Typically a server bug. schema: $ref: '#/components/schemas/ErrorInfo' description: Internal server error headers: x-correlator: $ref: '#/components/headers/x-correlator' "503": content: application/json: examples: GENERIC_503_UNAVAILABLE: description: Service is not available. Temporary situation usually related to maintenance process in the server side value: status: 503 code: UNAVAILABLE message: Service Unavailable. schema: $ref: '#/components/schemas/ErrorInfo' description: Service unavailable headers: x-correlator: $ref: '#/components/headers/x-correlator' security: - {} - notificationsBearerAuth: [] summary: Provisioning notifications callback x-callback-request: true description: | Triggers a new provisioning in the operator to assign certain QoS Profile to certain device. - If the provisioning is completed synchronously, the response will be 201 with `status` = `AVAILABLE`. - If the provisioning request is accepted but not yet completed, the response will be 201 with `status` = `REQUESTED`. - If the operator determines synchronously that the provisioning request cannot be fulfilled, the response will be 201 with `status` = `UNAVAILABLE`. - If the request includes the `sink` and `sinkCredential` properties, the client will receive a `status-changed` event with the outcome of the process. The event will be sent also for synchronous operations. **NOTES:** - When the provisioning status becomes `UNAVAILABLE`, the QoD provisioning resource is not immediately released, but will get deleted automatically, at earliest 360 seconds after. This behavior allows clients which are not receiving notification events but are polling, to get the provisioning status information. Before a client can attempt to create a new QoD provisioning for the same device, they must release the provisioning resources with an explicit `delete` operation if not yet automatically deleted. - The access token may be either 2-legged or 3-legged. - If a 3-legged access token which is associated with a device is used, it is recommended NOT to include the `device` parameter in the request (see "Handling of device information" within the API description for details). - If a 2-legged access token is used, the device parameter must be provided and identify a device. operationId: createProvisioning parameters: - description: Correlation id for the different services explode: false in: header name: x-correlator required: false schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProvisioning' description: Parameters to create a new provisioning required: true responses: "201": content: application/json: schema: $ref: '#/components/schemas/ProvisioningInfo' description: Provisioning created headers: x-correlator: $ref: '#/components/headers/x-correlator' "400": content: application/json: examples: GENERIC_400_INVALID_ARGUMENT: description: Invalid Argument. Generic Syntax Exception value: status: 400 code: INVALID_ARGUMENT message: "Client specified an invalid argument, request body or\ \ query param." GENERIC_400_OUT_OF_RANGE: description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested value: status: 400 code: OUT_OF_RANGE message: Client specified an invalid range. GENERIC_400_INVALID_CREDENTIAL: value: status: 400 code: INVALID_CREDENTIAL message: Only Access token is supported GENERIC_400_INVALID_TOKEN: value: status: 400 code: INVALID_TOKEN message: Only bearer token is supported schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request with additional errors for implicit notifications headers: x-correlator: $ref: '#/components/headers/x-correlator' "401": content: application/json: examples: GENERIC_401_UNAUTHENTICATED: description: Request cannot be authenticated value: status: 401 code: UNAUTHENTICATED message: "Request not authenticated due to missing, invalid, or\ \ expired credentials." GENERIC_401_AUTHENTICATION_REQUIRED: description: "New authentication is needed, authentication is no\ \ longer valid" value: status: 401 code: AUTHENTICATION_REQUIRED message: New authentication is required. schema: $ref: '#/components/schemas/ErrorInfo' description: Unauthorized headers: x-correlator: $ref: '#/components/headers/x-correlator' "403": content: application/json: examples: GENERIC_403_PERMISSION_DENIED: description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security value: status: 403 code: PERMISSION_DENIED message: Client does not have sufficient permissions to perform this action. GENERIC_403_INVALID_TOKEN_CONTEXT: description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token value: status: 403 code: INVALID_TOKEN_CONTEXT message: "{{field}} is not consistent with access token." schema: $ref: '#/components/schemas/ErrorInfo' description: Forbidden headers: x-correlator: $ref: '#/components/headers/x-correlator' "404": content: application/json: examples: GENERIC_404_NOT_FOUND: description: Resource is not found value: status: 404 code: NOT_FOUND message: The specified resource is not found. GENERIC_404_DEVICE_NOT_FOUND: description: Device identifier not found value: status: 404 code: DEVICE_NOT_FOUND message: Device identifier not found. schema: $ref: '#/components/schemas/ErrorInfo' description: Not found headers: x-correlator: $ref: '#/components/headers/x-correlator' "409": content: application/json: examples: PROVISIONING_409_CONFLICT: description: The requested provisioning conflicts with an existing one value: status: 409 code: CONFLICT message: There is another existing provisioning for the same device schema: $ref: '#/components/schemas/ErrorInfo' description: Provisioning conflict headers: x-correlator: $ref: '#/components/headers/x-correlator' "422": content: application/json: examples: GENERIC_422_UNPROCESSABLE_ENTITY: description: The request was well-formed but was unable to be processed due to semantic errors or not applicable values. This is the generic error code for 422 responses. value: status: 422 code: UNPROCESSABLE_ENTITY message: "Value not acceptable: ..." GENERIC_422_DEVICE_IDENTIFIERS_MISMATCH: description: Inconsistency between device identifiers not pointing to the same device value: status: 422 code: DEVICE_IDENTIFIERS_MISMATCH message: Provided device identifiers are not consistent. GENERIC_422_DEVICE_NOT_APPLICABLE: description: Service is not available for the provided device value: status: 422 code: DEVICE_NOT_APPLICABLE message: The service is not available for the provided device. GENERIC_422_UNSUPPORTED_DEVICE_IDENTIFIERS: description: Message may list the supported device identifiers value: status: 422 code: UNSUPPORTED_DEVICE_IDENTIFIERS message: "Supported device supported are: ..." GENERIC_422_UNIDENTIFIABLE_DEVICE: description: Service is not available for the provided device value: status: 422 code: UNIDENTIFIABLE_DEVICE message: The device cannot be identified. schema: $ref: '#/components/schemas/ErrorInfo' description: Unprocessable entity headers: x-correlator: $ref: '#/components/headers/x-correlator' "429": content: application/json: examples: GENERIC_429_QUOTA_EXCEEDED: description: Request is rejected due to exceeding a business quota limit value: status: 429 code: QUOTA_EXCEEDED message: Either out of resource quota or reaching rate limiting. GENERIC_429_TOO_MANY_REQUESTS: description: API Server request limit is overpassed value: status: 429 code: TOO_MANY_REQUESTS message: Either out of resource quota or reaching rate limiting. schema: $ref: '#/components/schemas/ErrorInfo' description: Too Many Requests headers: x-correlator: $ref: '#/components/headers/x-correlator' "500": content: application/json: examples: GENERIC_500_INTERNAL: description: Problem in Server side. Regular Server Exception value: status: 500 code: INTERNAL message: Unknown server error. Typically a server bug. schema: $ref: '#/components/schemas/ErrorInfo' description: Internal server error headers: x-correlator: $ref: '#/components/headers/x-correlator' "503": content: application/json: examples: GENERIC_503_UNAVAILABLE: description: Service is not available. Temporary situation usually related to maintenance process in the server side value: status: 503 code: UNAVAILABLE message: Service Unavailable. schema: $ref: '#/components/schemas/ErrorInfo' description: Service unavailable headers: x-correlator: $ref: '#/components/headers/x-correlator' security: - openId: - qod-provisioning:device-qos:create summary: Sets a new provisioning of QoS for a device tags: - QoD Provisioning /device-qos/{provisioningId}: delete: description: | Release resources related to QoS provisioning. If the notification callback is provided and the provisioning status was `AVAILABLE`, when the deletion is completed, the client will receive in addition to the response a `PROVISIONING_STATUS_CHANGED` event with - `status` as `UNAVAILABLE` and - `statusInfo` as `DELETE_REQUESTED` There will be no notification event if the `status` was already `UNAVAILABLE`. **NOTES:** - The access token may be either 2-legged or 3-legged. - If a 3-legged access token is used, the end user (and device) associated with the QoD provisioning must also be associated with the access token. - The QoD provisioning must have been created by the same API client given in the access token. operationId: deleteProvisioning parameters: - description: Provisioning ID that was obtained from the createProvision operation explode: false in: path name: provisioningId required: true schema: $ref: '#/components/schemas/ProvisioningId' style: simple - description: Correlation id for the different services explode: false in: header name: x-correlator required: false schema: type: string style: simple responses: "204": description: Provisioning deleted headers: x-correlator: $ref: '#/components/headers/x-correlator' "202": content: application/json: schema: $ref: '#/components/schemas/ProvisioningInfo' description: Deletion request accepted to be processed. It applies for an async deletion process. `status` in the response will be `AVAILABLE` with `statusInfo` set to `DELETE_REQUESTED`. headers: x-correlator: $ref: '#/components/headers/x-correlator' "400": content: application/json: examples: GENERIC_400_INVALID_ARGUMENT: description: Invalid Argument. Generic Syntax Exception value: status: 400 code: INVALID_ARGUMENT message: "Client specified an invalid argument, request body or\ \ query param." GENERIC_400_OUT_OF_RANGE: description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested value: status: 400 code: OUT_OF_RANGE message: Client specified an invalid range. schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request headers: x-correlator: $ref: '#/components/headers/x-correlator' "401": content: application/json: examples: GENERIC_401_UNAUTHENTICATED: description: Request cannot be authenticated value: status: 401 code: UNAUTHENTICATED message: "Request not authenticated due to missing, invalid, or\ \ expired credentials." GENERIC_401_AUTHENTICATION_REQUIRED: description: "New authentication is needed, authentication is no\ \ longer valid" value: status: 401 code: AUTHENTICATION_REQUIRED message: New authentication is required. schema: $ref: '#/components/schemas/ErrorInfo' description: Unauthorized headers: x-correlator: $ref: '#/components/headers/x-correlator' "403": content: application/json: examples: GENERIC_403_PERMISSION_DENIED: description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security value: status: 403 code: PERMISSION_DENIED message: Client does not have sufficient permissions to perform this action. GENERIC_403_INVALID_TOKEN_CONTEXT: description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token value: status: 403 code: INVALID_TOKEN_CONTEXT message: "{{field}} is not consistent with access token." schema: $ref: '#/components/schemas/ErrorInfo' description: Forbidden headers: x-correlator: $ref: '#/components/headers/x-correlator' "404": content: application/json: examples: GENERIC_404_NOT_FOUND: description: Resource is not found value: status: 404 code: NOT_FOUND message: The specified resource is not found. schema: $ref: '#/components/schemas/ErrorInfo' description: Not found headers: x-correlator: $ref: '#/components/headers/x-correlator' "429": content: application/json: examples: GENERIC_429_QUOTA_EXCEEDED: description: Request is rejected due to exceeding a business quota limit value: status: 429 code: QUOTA_EXCEEDED message: Either out of resource quota or reaching rate limiting. GENERIC_429_TOO_MANY_REQUESTS: description: API Server request limit is overpassed value: status: 429 code: TOO_MANY_REQUESTS message: Either out of resource quota or reaching rate limiting. schema: $ref: '#/components/schemas/ErrorInfo' description: Too Many Requests headers: x-correlator: $ref: '#/components/headers/x-correlator' "500": content: application/json: examples: GENERIC_500_INTERNAL: description: Problem in Server side. Regular Server Exception value: status: 500 code: INTERNAL message: Unknown server error. Typically a server bug. schema: $ref: '#/components/schemas/ErrorInfo' description: Internal server error headers: x-correlator: $ref: '#/components/headers/x-correlator' "503": content: application/json: examples: GENERIC_503_UNAVAILABLE: description: Service is not available. Temporary situation usually related to maintenance process in the server side value: status: 503 code: UNAVAILABLE message: Service Unavailable. schema: $ref: '#/components/schemas/ErrorInfo' description: Service unavailable headers: x-correlator: $ref: '#/components/headers/x-correlator' security: - openId: - qod-provisioning:device-qos:delete summary: Deletes a QoD provisioning tags: - QoD Provisioning get: description: | Querying for QoD provisioning resource information details **NOTES:** - The access token may be either 2-legged or 3-legged. - If a 3-legged access token is used, the end user (and device) associated with the QoD provisioning must also be associated with the access token. - The QoD provisioning must have been created by the same API client given in the access token. operationId: getProvisioningById parameters: - description: Provisioning ID that was obtained from the createProvision operation explode: false in: path name: provisioningId required: true schema: $ref: '#/components/schemas/ProvisioningId' style: simple - description: Correlation id for the different services explode: false in: header name: x-correlator required: false schema: type: string style: simple responses: "200": content: application/json: examples: PROVISIONING_AVAILABLE: $ref: '#/components/examples/PROVISIONING_AVAILABLE' PROVISIONING_UNAVAILABLE: $ref: '#/components/examples/PROVISIONING_UNAVAILABLE' PROVISIONING_AVAILABLE_WITHOUT_DEVICE: $ref: '#/components/examples/PROVISIONING_AVAILABLE_WITHOUT_DEVICE' schema: $ref: '#/components/schemas/ProvisioningInfo' description: Returns information about certain provisioning headers: x-correlator: $ref: '#/components/headers/x-correlator' "400": content: application/json: examples: GENERIC_400_INVALID_ARGUMENT: description: Invalid Argument. Generic Syntax Exception value: status: 400 code: INVALID_ARGUMENT message: "Client specified an invalid argument, request body or\ \ query param." GENERIC_400_OUT_OF_RANGE: description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested value: status: 400 code: OUT_OF_RANGE message: Client specified an invalid range. schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request headers: x-correlator: $ref: '#/components/headers/x-correlator' "401": content: application/json: examples: GENERIC_401_UNAUTHENTICATED: description: Request cannot be authenticated value: status: 401 code: UNAUTHENTICATED message: "Request not authenticated due to missing, invalid, or\ \ expired credentials." GENERIC_401_AUTHENTICATION_REQUIRED: description: "New authentication is needed, authentication is no\ \ longer valid" value: status: 401 code: AUTHENTICATION_REQUIRED message: New authentication is required. schema: $ref: '#/components/schemas/ErrorInfo' description: Unauthorized headers: x-correlator: $ref: '#/components/headers/x-correlator' "403": content: application/json: examples: GENERIC_403_PERMISSION_DENIED: description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security value: status: 403 code: PERMISSION_DENIED message: Client does not have sufficient permissions to perform this action. GENERIC_403_INVALID_TOKEN_CONTEXT: description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token value: status: 403 code: INVALID_TOKEN_CONTEXT message: "{{field}} is not consistent with access token." schema: $ref: '#/components/schemas/ErrorInfo' description: Forbidden headers: x-correlator: $ref: '#/components/headers/x-correlator' "404": content: application/json: examples: GENERIC_404_NOT_FOUND: description: Resource is not found value: status: 404 code: NOT_FOUND message: The specified resource is not found. schema: $ref: '#/components/schemas/ErrorInfo' description: Not found headers: x-correlator: $ref: '#/components/headers/x-correlator' "429": content: application/json: examples: GENERIC_429_QUOTA_EXCEEDED: description: Request is rejected due to exceeding a business quota limit value: status: 429 code: QUOTA_EXCEEDED message: Either out of resource quota or reaching rate limiting. GENERIC_429_TOO_MANY_REQUESTS: description: API Server request limit is overpassed value: status: 429 code: TOO_MANY_REQUESTS message: Either out of resource quota or reaching rate limiting. schema: $ref: '#/components/schemas/ErrorInfo' description: Too Many Requests headers: x-correlator: $ref: '#/components/headers/x-correlator' "500": content: application/json: examples: GENERIC_500_INTERNAL: description: Problem in Server side. Regular Server Exception value: status: 500 code: INTERNAL message: Unknown server error. Typically a server bug. schema: $ref: '#/components/schemas/ErrorInfo' description: Internal server error headers: x-correlator: $ref: '#/components/headers/x-correlator' "503": content: application/json: examples: GENERIC_503_UNAVAILABLE: description: Service is not available. Temporary situation usually related to maintenance process in the server side value: status: 503 code: UNAVAILABLE message: Service Unavailable. schema: $ref: '#/components/schemas/ErrorInfo' description: Service unavailable headers: x-correlator: $ref: '#/components/headers/x-correlator' security: - openId: - qod-provisioning:device-qos:read summary: Get QoD provisioning information tags: - QoD Provisioning /retrieve-device-qos: post: description: | Retrieves the QoD provisioning for a device. **NOTES:** - The access token may be either 2-legged or 3-legged. - If a 3-legged access token is used, the end user (and device) associated with the QoD provisioning must also be associated with the access token. In this case it is recommended NOT to include the `device` parameter in the request (see "Handling of device information" within the API description for details). - If a 2-legged access token is used, the device parameter must be provided and identify a device. - The QoD provisioning must have been created by the same API client given in the access token. - If no provisioning is found for the device, an error response 404 is returned with code "NOT_FOUND". operationId: retrieveProvisioningByDevice parameters: - description: Correlation id for the different services explode: false in: header name: x-correlator required: false schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/RetrieveProvisioningByDevice' description: Parameters to retrieve a provisioning by device required: true responses: "200": content: application/json: examples: PROVISIONING_AVAILABLE: $ref: '#/components/examples/PROVISIONING_AVAILABLE' PROVISIONING_AVAILABLE_WITHOUT_DEVICE: $ref: '#/components/examples/PROVISIONING_AVAILABLE_WITHOUT_DEVICE' schema: $ref: '#/components/schemas/ProvisioningInfo' description: Returns information about QoS provisioning for the device. headers: x-correlator: $ref: '#/components/headers/x-correlator' "400": content: application/json: examples: GENERIC_400_INVALID_ARGUMENT: description: Invalid Argument. Generic Syntax Exception value: status: 400 code: INVALID_ARGUMENT message: "Client specified an invalid argument, request body or\ \ query param." GENERIC_400_OUT_OF_RANGE: description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested value: status: 400 code: OUT_OF_RANGE message: Client specified an invalid range. schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request headers: x-correlator: $ref: '#/components/headers/x-correlator' "401": content: application/json: examples: GENERIC_401_UNAUTHENTICATED: description: Request cannot be authenticated value: status: 401 code: UNAUTHENTICATED message: "Request not authenticated due to missing, invalid, or\ \ expired credentials." GENERIC_401_AUTHENTICATION_REQUIRED: description: "New authentication is needed, authentication is no\ \ longer valid" value: status: 401 code: AUTHENTICATION_REQUIRED message: New authentication is required. schema: $ref: '#/components/schemas/ErrorInfo' description: Unauthorized headers: x-correlator: $ref: '#/components/headers/x-correlator' "403": content: application/json: examples: GENERIC_403_PERMISSION_DENIED: description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security value: status: 403 code: PERMISSION_DENIED message: Client does not have sufficient permissions to perform this action. GENERIC_403_INVALID_TOKEN_CONTEXT: description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token value: status: 403 code: INVALID_TOKEN_CONTEXT message: "{{field}} is not consistent with access token." schema: $ref: '#/components/schemas/ErrorInfo' description: Forbidden headers: x-correlator: $ref: '#/components/headers/x-correlator' "404": content: application/json: examples: GENERIC_404_NOT_FOUND: description: Resource is not found value: status: 404 code: NOT_FOUND message: The specified resource is not found. GENERIC_404_DEVICE_NOT_FOUND: description: Device identifier not found value: status: 404 code: DEVICE_NOT_FOUND message: Device identifier not found. schema: $ref: '#/components/schemas/ErrorInfo' description: Not found headers: x-correlator: $ref: '#/components/headers/x-correlator' "422": content: application/json: examples: GENERIC_422_UNPROCESSABLE_ENTITY: description: The request was well-formed but was unable to be processed due to semantic errors or not applicable values. This is the generic error code for 422 responses. value: status: 422 code: UNPROCESSABLE_ENTITY message: "Value not acceptable: ..." GENERIC_422_DEVICE_IDENTIFIERS_MISMATCH: description: Inconsistency between device identifiers not pointing to the same device value: status: 422 code: DEVICE_IDENTIFIERS_MISMATCH message: Provided device identifiers are not consistent. GENERIC_422_DEVICE_NOT_APPLICABLE: description: Service is not available for the provided device value: status: 422 code: DEVICE_NOT_APPLICABLE message: The service is not available for the provided device. GENERIC_422_UNSUPPORTED_DEVICE_IDENTIFIERS: description: Message may list the supported device identifiers value: status: 422 code: UNSUPPORTED_DEVICE_IDENTIFIERS message: "Supported device supported are: ..." GENERIC_422_UNIDENTIFIABLE_DEVICE: description: Service is not available for the provided device value: status: 422 code: UNIDENTIFIABLE_DEVICE message: The device cannot be identified. schema: $ref: '#/components/schemas/ErrorInfo' description: Unprocessable entity headers: x-correlator: $ref: '#/components/headers/x-correlator' "429": content: application/json: examples: GENERIC_429_QUOTA_EXCEEDED: description: Request is rejected due to exceeding a business quota limit value: status: 429 code: QUOTA_EXCEEDED message: Either out of resource quota or reaching rate limiting. GENERIC_429_TOO_MANY_REQUESTS: description: API Server request limit is overpassed value: status: 429 code: TOO_MANY_REQUESTS message: Either out of resource quota or reaching rate limiting. schema: $ref: '#/components/schemas/ErrorInfo' description: Too Many Requests headers: x-correlator: $ref: '#/components/headers/x-correlator' "500": content: application/json: examples: GENERIC_500_INTERNAL: description: Problem in Server side. Regular Server Exception value: status: 500 code: INTERNAL message: Unknown server error. Typically a server bug. schema: $ref: '#/components/schemas/ErrorInfo' description: Internal server error headers: x-correlator: $ref: '#/components/headers/x-correlator' "503": content: application/json: examples: GENERIC_503_UNAVAILABLE: description: Service is not available. Temporary situation usually related to maintenance process in the server side value: status: 503 code: UNAVAILABLE message: Service Unavailable. schema: $ref: '#/components/schemas/ErrorInfo' description: Service unavailable headers: x-correlator: $ref: '#/components/headers/x-correlator' security: - openId: - qod-provisioning:device-qos:read-by-device summary: Gets the QoD provisioning for a device tags: - QoD Provisioning components: examples: PROVISIONING_AVAILABLE: description: The provisioning has become available summary: QoD provisioning status is available value: device: phoneNumber: "+123456789" qosProfile: QOS_L sink: https://application-server.com/callback sinkCredential: credentialType: ACCESSTOKEN accessToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c accessTokenExpiresUtc: 2024-12-01T12:00:00Z accessTokenType: bearer provisioningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 startedAt: 2024-05-12T17:32:01Z status: AVAILABLE PROVISIONING_UNAVAILABLE: description: The provisioning could not be created or is not active anymore summary: QoD provisioning status is unavailable value: duration: 86400 device: ipv4Address: publicAddress: 203.0.113.0 publicPort: 59765 qosProfile: QOS_L sink: https://application-server.com/callback sinkCredential: credentialType: ACCESSTOKEN accessToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c accessTokenExpiresUtc: 2024-12-01T12:00:00Z accessTokenType: bearer provisioningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 startedAt: 2024-05-12T17:32:01Z status: UNAVAILABLE statusInfo: NETWORK_TERMINATED PROVISIONING_AVAILABLE_WITHOUT_DEVICE: description: Device is optional in responses and must not be provided if it was not provided in the request summary: QoD provisioning status is available but no device information is provided value: qosProfile: QOS_M sink: https://application-server.com/callback sinkCredential: credentialType: ACCESSTOKEN accessToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c accessTokenExpiresUtc: 2024-12-01T12:00:00Z accessTokenType: bearer provisioningId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 startedAt: 2024-05-12T17:32:01Z status: AVAILABLE PROVISIONING_STATUS_CHANGED_EXAMPLE: description: Provisioning status changed summary: Cloud event example for QoD provisioning status change to UNAVAILABLE due to NETWORK_TERMINATED value: id: 83a0d986-0866-4f38-b8c0-fc65bfcda452 source: https://api.example.com/qod-provisioning/v0.1/device-qos/123e4567-e89b-12d3-a456-426614174000 specversion: "1.0" type: org.camaraproject.qod-provisioning.v0.status-changed time: 2021-12-12T00:00:00Z data: provisioningId: 123e4567-e89b-12d3-a456-426614174000 status: UNAVAILABLE statusInfo: NETWORK_TERMINATED headers: x-correlator: description: Correlation id for the different services explode: false schema: type: string style: simple parameters: provisioningId: description: Provisioning ID that was obtained from the createProvision operation explode: false in: path name: provisioningId required: true schema: $ref: '#/components/schemas/ProvisioningId' style: simple x-correlator: description: Correlation id for the different services explode: false in: header name: x-correlator required: false schema: type: string style: simple responses: Generic400: content: application/json: examples: GENERIC_400_INVALID_ARGUMENT: description: Invalid Argument. Generic Syntax Exception value: status: 400 code: INVALID_ARGUMENT message: "Client specified an invalid argument, request body or query\ \ param." GENERIC_400_OUT_OF_RANGE: description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested value: status: 400 code: OUT_OF_RANGE message: Client specified an invalid range. schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request headers: x-correlator: $ref: '#/components/headers/x-correlator' CreateProvisioning400: content: application/json: examples: GENERIC_400_INVALID_ARGUMENT: description: Invalid Argument. Generic Syntax Exception value: status: 400 code: INVALID_ARGUMENT message: "Client specified an invalid argument, request body or query\ \ param." GENERIC_400_OUT_OF_RANGE: description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested value: status: 400 code: OUT_OF_RANGE message: Client specified an invalid range. GENERIC_400_INVALID_CREDENTIAL: value: status: 400 code: INVALID_CREDENTIAL message: Only Access token is supported GENERIC_400_INVALID_TOKEN: value: status: 400 code: INVALID_TOKEN message: Only bearer token is supported schema: $ref: '#/components/schemas/ErrorInfo' description: Bad Request with additional errors for implicit notifications headers: x-correlator: $ref: '#/components/headers/x-correlator' Generic401: content: application/json: examples: GENERIC_401_UNAUTHENTICATED: description: Request cannot be authenticated value: status: 401 code: UNAUTHENTICATED message: "Request not authenticated due to missing, invalid, or expired\ \ credentials." GENERIC_401_AUTHENTICATION_REQUIRED: description: "New authentication is needed, authentication is no longer\ \ valid" value: status: 401 code: AUTHENTICATION_REQUIRED message: New authentication is required. schema: $ref: '#/components/schemas/ErrorInfo' description: Unauthorized headers: x-correlator: $ref: '#/components/headers/x-correlator' Generic403: content: application/json: examples: GENERIC_403_PERMISSION_DENIED: description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security value: status: 403 code: PERMISSION_DENIED message: Client does not have sufficient permissions to perform this action. GENERIC_403_INVALID_TOKEN_CONTEXT: description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token value: status: 403 code: INVALID_TOKEN_CONTEXT message: "{{field}} is not consistent with access token." schema: $ref: '#/components/schemas/ErrorInfo' description: Forbidden headers: x-correlator: $ref: '#/components/headers/x-correlator' Generic404: content: application/json: examples: GENERIC_404_NOT_FOUND: description: Resource is not found value: status: 404 code: NOT_FOUND message: The specified resource is not found. schema: $ref: '#/components/schemas/ErrorInfo' description: Not found headers: x-correlator: $ref: '#/components/headers/x-correlator' GenericDevice404: content: application/json: examples: GENERIC_404_NOT_FOUND: description: Resource is not found value: status: 404 code: NOT_FOUND message: The specified resource is not found. GENERIC_404_DEVICE_NOT_FOUND: description: Device identifier not found value: status: 404 code: DEVICE_NOT_FOUND message: Device identifier not found. schema: $ref: '#/components/schemas/ErrorInfo' description: Not found headers: x-correlator: $ref: '#/components/headers/x-correlator' ProvisioningConflict409: content: application/json: examples: PROVISIONING_409_CONFLICT: description: The requested provisioning conflicts with an existing one value: status: 409 code: CONFLICT message: There is another existing provisioning for the same device schema: $ref: '#/components/schemas/ErrorInfo' description: Provisioning conflict headers: x-correlator: $ref: '#/components/headers/x-correlator' Generic410: content: application/json: examples: GENERIC_410_GONE: description: Use in notifications flow to allow API Consumer to indicate that its callback is no longer available value: status: 410 code: GONE message: Access to the target resource is no longer available. schema: $ref: '#/components/schemas/ErrorInfo' description: Gone headers: x-correlator: $ref: '#/components/headers/x-correlator' Generic422: content: application/json: examples: GENERIC_422_UNPROCESSABLE_ENTITY: description: The request was well-formed but was unable to be processed due to semantic errors or not applicable values. This is the generic error code for 422 responses. value: status: 422 code: UNPROCESSABLE_ENTITY message: "Value not acceptable: ..." GENERIC_422_DEVICE_IDENTIFIERS_MISMATCH: description: Inconsistency between device identifiers not pointing to the same device value: status: 422 code: DEVICE_IDENTIFIERS_MISMATCH message: Provided device identifiers are not consistent. GENERIC_422_DEVICE_NOT_APPLICABLE: description: Service is not available for the provided device value: status: 422 code: DEVICE_NOT_APPLICABLE message: The service is not available for the provided device. GENERIC_422_UNSUPPORTED_DEVICE_IDENTIFIERS: description: Message may list the supported device identifiers value: status: 422 code: UNSUPPORTED_DEVICE_IDENTIFIERS message: "Supported device supported are: ..." GENERIC_422_UNIDENTIFIABLE_DEVICE: description: Service is not available for the provided device value: status: 422 code: UNIDENTIFIABLE_DEVICE message: The device cannot be identified. schema: $ref: '#/components/schemas/ErrorInfo' description: Unprocessable entity headers: x-correlator: $ref: '#/components/headers/x-correlator' Generic429: content: application/json: examples: GENERIC_429_QUOTA_EXCEEDED: description: Request is rejected due to exceeding a business quota limit value: status: 429 code: QUOTA_EXCEEDED message: Either out of resource quota or reaching rate limiting. GENERIC_429_TOO_MANY_REQUESTS: description: API Server request limit is overpassed value: status: 429 code: TOO_MANY_REQUESTS message: Either out of resource quota or reaching rate limiting. schema: $ref: '#/components/schemas/ErrorInfo' description: Too Many Requests headers: x-correlator: $ref: '#/components/headers/x-correlator' Generic500: content: application/json: examples: GENERIC_500_INTERNAL: description: Problem in Server side. Regular Server Exception value: status: 500 code: INTERNAL message: Unknown server error. Typically a server bug. schema: $ref: '#/components/schemas/ErrorInfo' description: Internal server error headers: x-correlator: $ref: '#/components/headers/x-correlator' Generic503: content: application/json: examples: GENERIC_503_UNAVAILABLE: description: Service is not available. Temporary situation usually related to maintenance process in the server side value: status: 503 code: UNAVAILABLE message: Service Unavailable. schema: $ref: '#/components/schemas/ErrorInfo' description: Service unavailable headers: x-correlator: $ref: '#/components/headers/x-correlator' schemas: ProvisioningId: description: Provisioning Identifier in UUID format format: uuid title: ProvisioningId type: string BaseProvisioningInfo: description: Common attributes of a QoD provisioning properties: device: $ref: '#/components/schemas/Device' qosProfile: description: | A unique name for identifying a specific QoS profile. This may follow different formats depending on the service providers implementation. Some options addresses: - A UUID style string - Support for predefined profiles QOS_S, QOS_M, QOS_L, and QOS_E - A searchable descriptive name The set of QoS Profiles that an operator is offering can be retrieved by means of the [QoS Profile API](link TBC). example: QCI_1_voice format: string maxLength: 256 minLength: 3 pattern: "^[a-zA-Z0-9_.-]+$" title: qosProfile type: string sink: description: "The address to which events shall be delivered, using the\ \ HTTP protocol." example: https://endpoint.example.com/sink format: url title: sink type: string sinkCredential: $ref: '#/components/schemas/SinkCredential' required: - qosProfile title: BaseProvisioningInfo type: object ProvisioningInfo: allOf: - $ref: '#/components/schemas/BaseProvisioningInfo' - properties: provisioningId: $ref: '#/components/schemas/ProvisioningId' startedAt: description: Date and time when the provisioning became "AVAILABLE". Not to be returned when `status` is "REQUESTED". Format must follow RFC 3339 and must indicate time zone (UTC or local). example: 2024-06-01T12:00:00Z format: date-time type: string status: $ref: '#/components/schemas/Status' statusInfo: $ref: '#/components/schemas/StatusInfo' required: - provisioningId - status type: object description: | Provisioning related information returned in responses. Optional device object only to be returned if provided in createProvisioning. If more than one type of device identifier was provided, only one identifier will be returned (at implementation choice and with the original value provided in createProvisioning). Please note that IP addresses of devices can change and get reused, so the original values may no longer identify the same device. They identified the device at the time of QoD provisioning creation. example: qosProfile: QCI_1_voice statusInfo: NETWORK_TERMINATED sink: https://endpoint.example.com/sink provisioningId: null startedAt: 2024-06-01T12:00:00Z sinkCredential: credentialType: PLAIN device: phoneNumber: "+123456789" ipv6Address: 2001:db8:85a3:8d3:1319:8a2e:370:7344 ipv4Address: publicAddress: 203.0.113.0 publicPort: 59765 networkAccessIdentifier: 123456789@domain.com status: REQUESTED title: ProvisioningInfo CreateProvisioning: allOf: - $ref: '#/components/schemas/BaseProvisioningInfo' description: Attributes to request a new QoD provisioning example: qosProfile: QCI_1_voice sink: https://endpoint.example.com/sink sinkCredential: credentialType: PLAIN device: phoneNumber: "+123456789" ipv6Address: 2001:db8:85a3:8d3:1319:8a2e:370:7344 ipv4Address: publicAddress: 203.0.113.0 publicPort: 59765 networkAccessIdentifier: 123456789@domain.com RetrieveProvisioningByDevice: description: Attributes to look for QoD provisioning example: device: phoneNumber: "+123456789" ipv6Address: 2001:db8:85a3:8d3:1319:8a2e:370:7344 ipv4Address: publicAddress: 203.0.113.0 publicPort: 59765 networkAccessIdentifier: 123456789@domain.com properties: device: $ref: '#/components/schemas/Device' title: RetrieveProvisioningByDevice type: object SinkCredential: description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target. discriminator: mapping: PLAIN: '#/components/schemas/PlainCredential' ACCESSTOKEN: '#/components/schemas/AccessTokenCredential' REFRESHTOKEN: '#/components/schemas/RefreshTokenCredential' propertyName: credentialType example: credentialType: PLAIN properties: credentialType: description: The type of the credential. enum: - PLAIN - ACCESSTOKEN - REFRESHTOKEN title: credentialType type: string required: - credentialType title: SinkCredential type: object PlainCredential: allOf: - $ref: '#/components/schemas/SinkCredential' - properties: identifier: description: The identifier might be an account or username. type: string secret: description: The secret might be a password or passphrase. type: string required: - identifier - secret type: object description: A plain credential as a combination of an identifier and a secret. type: object AccessTokenCredential: allOf: - $ref: '#/components/schemas/SinkCredential' - properties: accessToken: description: REQUIRED. An access token is a previously acquired token granting access to the target resource. type: string accessTokenExpiresUtc: description: REQUIRED. An absolute UTC instant at which the token shall be considered expired. format: date-time type: string accessTokenType: description: "REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1))." enum: - bearer type: string required: - accessToken - accessTokenExpiresUtc - accessTokenType type: object description: An access token credential. type: object RefreshTokenCredential: allOf: - $ref: '#/components/schemas/SinkCredential' - properties: accessToken: description: REQUIRED. An access token is a previously acquired token granting access to the target resource. type: string accessTokenExpiresUtc: description: REQUIRED. An absolute UTC instant at which the token shall be considered expired. format: date-time type: string accessTokenType: description: "REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1))." enum: - bearer type: string refreshToken: description: REQUIRED. An refresh token credential used to acquire access tokens. type: string refreshTokenEndpoint: description: REQUIRED. A URL at which the refresh token can be traded for an access token. format: uri type: string type: object description: An access token credential with a refresh token. required: - accessToken - accessTokenExpiresUtc - accessTokenType - refreshToken - refreshTokenEndpoint type: object Port: description: TCP or UDP port number maximum: 65535 minimum: 0 type: integer QosProfileName: description: | A unique name for identifying a specific QoS profile. This may follow different formats depending on the service providers implementation. Some options addresses: - A UUID style string - Support for predefined profiles QOS_S, QOS_M, QOS_L, and QOS_E - A searchable descriptive name The set of QoS Profiles that an operator is offering can be retrieved by means of the [QoS Profile API](link TBC). example: QCI_1_voice format: string maxLength: 256 minLength: 3 pattern: "^[a-zA-Z0-9_.-]+$" title: qosProfile type: string CloudEvent: description: Event compliant with the CloudEvents specification discriminator: mapping: org.camaraproject.qod-provisioning.v0.status-changed: '#/components/schemas/EventStatusChanged' propertyName: type properties: id: description: "Identifier of this event, that must be unique in the source\ \ context." title: id type: string source: description: Identifies the context in which an event happened in the specific Provider Implementation. format: uri-reference title: source type: string type: description: The type of the event. enum: - org.camaraproject.qod-provisioning.v0.status-changed title: type type: string specversion: description: Version of the specification to which this event conforms (must be 1.0 if it conforms to cloudevents 1.0.2 version) enum: - "1.0" title: specversion type: string datacontenttype: description: "media-type that describes the event payload encoding, must\ \ be \"application/json\" for CAMARA APIs" enum: - application/json title: datacontenttype type: string data: description: "Event notification details payload, which depends on the event\ \ type" title: data type: object time: description: | Timestamp of when the occurrence happened. It must follow RFC 3339 format: date-time title: time type: string required: - id - source - specversion - time - type title: CloudEvent EventStatusChanged: allOf: - $ref: '#/components/schemas/CloudEvent' - properties: data: $ref: '#/components/schemas/EventStatusChanged_allOf_data' required: - data type: object description: Event to notify a QoD provisioning status change StatusInfo: description: | Reason for the new `status`: * `NETWORK_TERMINATED` - Network terminated the QoD provisioning * `DELETE_REQUESTED`- User requested the deletion of the QoD provisioning enum: - NETWORK_TERMINATED - DELETE_REQUESTED title: StatusInfo type: string Device: description: | End-user equipment able to connect to the 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` NOTE1: the network operator might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different network operators. In this case the identifiers MUST belong to the same device. NOTE2: for the Commonalities release v0.4, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines. example: phoneNumber: "+123456789" ipv6Address: 2001:db8:85a3:8d3:1319:8a2e:370:7344 ipv4Address: publicAddress: 203.0.113.0 publicPort: 59765 networkAccessIdentifier: 123456789@domain.com minProperties: 1 properties: 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 '+'." example: "+123456789" pattern: "^\\+[1-9][0-9]{4,14}$" title: PhoneNumber type: string 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." example: 123456789@domain.com title: NetworkAccessIdentifier type: string ipv4Address: $ref: '#/components/schemas/DeviceIpv4Addr' ipv6Address: 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). example: 2001:db8:85a3:8d3:1319:8a2e:370:7344 format: ipv6 title: DeviceIpv6Address type: string title: Device type: object 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." example: 123456789@domain.com title: NetworkAccessIdentifier type: string 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 '+'." example: "+123456789" pattern: "^\\+[1-9][0-9]{4,14}$" title: PhoneNumber type: string DeviceIpv4Addr: anyOf: [] 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. example: publicAddress: 203.0.113.0 publicPort: 59765 nullable: true properties: publicAddress: description: A single IPv4 address with no subnet mask example: 203.0.113.0 format: ipv4 type: string privateAddress: description: A single IPv4 address with no subnet mask example: 203.0.113.0 format: ipv4 type: string publicPort: description: TCP or UDP port number maximum: 65535 minimum: 0 type: integer title: DeviceIpv4Addr type: object SingleIpv4Addr: description: A single IPv4 address with no subnet mask example: 203.0.113.0 format: ipv4 type: string 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). example: 2001:db8:85a3:8d3:1319:8a2e:370:7344 format: ipv6 title: DeviceIpv6Address type: string Status: description: | The current status of the requested QoD provisioning. The status can be one of the following: * `REQUESTED` - QoD provisioning has been requested but is still being processed. * `AVAILABLE` - The requested QoS profile has been provisioned to the device, and is active. * `UNAVAILABLE` - The QoD provisioning request has been processed but is not active. `statusInfo` may provide additional information about the reason for the unavailability. enum: - REQUESTED - AVAILABLE - UNAVAILABLE title: Status type: string StatusChanged: description: | The current status of a requested or previously available QoD provisioning. Applicable values in the event are: * `AVAILABLE` - The requested QoS profile has been provisioned to the device, and is active. * `UNAVAILABLE` - A requested or previously available QoD provisioning is now unavailable. `statusInfo` may provide additional information about the reason for the unavailability. enum: - AVAILABLE - UNAVAILABLE title: StatusChanged type: string ErrorInfo: description: Common schema for errors example: code: code message: message status: 0 properties: status: description: HTTP status code returned along with this error response title: status type: integer code: description: Code given to this error title: code type: string message: description: Detailed error description title: message type: string required: - code - message - status title: ErrorInfo type: object EventStatusChanged_allOf_data: description: Event details depending on the event type properties: provisioningId: description: Provisioning Identifier in UUID format format: uuid title: ProvisioningId type: string status: $ref: '#/components/schemas/StatusChanged' statusInfo: $ref: '#/components/schemas/StatusInfo' required: - provisioningId - qosStatus title: EventStatusChanged_allOf_data type: object securitySchemes: openId: description: OpenID Connect authentication openIdConnectUrl: https://example.com/.well-known/openid-configuration type: openIdConnect notificationsBearerAuth: bearerFormat: "{$request.body#/sinkCredential.credentialType}" description: Bearer authentication for notifications scheme: bearer type: http