| openapi: 3.0.3
|
| info:
|
| title: QoS Booking
|
| description: |
|
| The QoS (Quality of Service) Booking API provides programmable interface for developers and other users (capabilities consumers) to request in advance certain network conditions to be provided by Telco networks, without the necessity to have an in-depth knowledge of the underlying network complexity (e.g. the 4G/5G system in case of a mobile network).
|
|
|
| The API enables API consumers to book the assignment of a predefined QoS profile to a specific device, with some conditions such as the start time, duration and location.
|
|
|
|
|
|
|
|
|
| * **QoS profiles**:
|
| 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 booking request is accepted, the device may get different IP addresses, but the booking 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**:
|
| API consumers may provide a callback URL (`sink`) on which notifications about all status change events (e.g. duration expiration) can be received from the API 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.
|
|
|
|
|
| The API defines four operations:
|
|
|
| - An operation to setup a new QoS Booking for a given device.
|
| - An operation to get the information about a specific QoS Booking, identified by its `BookingId`.
|
| - An operation to get the QoS Booking for a given device.
|
| - An operation to terminate a QoS Booking, identified by its `BookingId`.
|
|
|
|
|
|
|
| The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
|
|
|
| The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
|
|
|
| In cases where personal 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 three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
|
|
|
|
|
|
|
| This API requires the API consumer to identify a device as the subject of the API as follows:
|
| - When the API is invoked using a two-legged access token, the subject will be identified from the optional `device` object, which therefore MUST be provided.
|
|
|
| - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
|
|
|
| This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
|
|
|
|
|
| - If the subject cannot be identified from the access token and the optional `device` object is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
|
|
|
| - If the subject can be identified from the access token and the optional `device` object is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same device is identified by these two methods, as the server is unable to make this comparison.
|
|
|
|
|
| The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
|
| Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
|
| As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
|
|
|
|
|
|
|
| In multi-SIM scenarios where more than one mobile device is associated with a phone number (e.g. a smartphone with an associated smartwatch), it might not be possible to uniquely identify the device to which the enhanced QoS profile should apply from that phone number. If the phone number is used as the device identifier when creating a QoS booking in a multi-SIM scenario, the API may respond with an error, apply the enhanced QoS profile to all devices in the multi-SIM group, or apply the enhanced QoS profile to a single device in the multi-SIM group which may not be the intended device.
|
|
|
| Possible solutions in such a scenario include:
|
| - Using the authorisation code flow to obtain an access token, which will automatically identify the intended device
|
| - Identifying the intended device from a unique identifier for that device, such as its source IP address and port
|
| - Check with the SIM provider whether a unique "secondary" phone number is already associated with each device, and use the secondary phone number to identify the intended device if available
|
|
|
|
|
|
|
| (FAQs will be added in a later version of the documentation)
|
|
|
| license:
|
| name: Apache 2.0
|
| url: https://www.apache.org/licenses/LICENSE-2.0.html
|
| version: wip
|
| x-camara-commonalities: tbd
|
|
|
| externalDocs:
|
| description: Project documentation at CAMARA
|
| url: https://github.com/camaraproject/QoSBooking
|
|
|
| servers:
|
| - url: "{apiRoot}/qos-booking/vwip"
|
| 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:
|
| - name: Device QoS Booking
|
| description: Manage the booking of QoS
|
|
|
| paths:
|
| /device-qos-bookings:
|
| post:
|
| tags:
|
| - Device QoS Booking
|
| summary: Sets a new booking of QoS for a device
|
| description: |
|
| Triggers a new booking to assign certain QoS Profile to certain device.
|
|
|
| - If the booking is completed synchronously, the response will be 201 with `status` = `SCHEDULED`.
|
| - If the booking request is accepted but not yet completed, the response will be 201 with `status` = `REQUESTED`.
|
| - If the operator determines synchronously that the booking request cannot be fulfilled, the response will be 201 with `status` = `UNAVAILABLE`.
|
|
|
| - If the request includes a notification callback, 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 booking status becomes `UNAVAILABLE`, the QoS Booking 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 booking status information.
|
| - The access token may be either 2-legged or 3-legged. See "Identifying the device from the access token" for further information
|
| - When the API is invoked using a two-legged access token, the subject will be identified from the optional `device` object, which therefore MUST be provided.
|
| - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
|
|
|
| operationId: createBooking
|
| parameters:
|
| - $ref: "#/components/parameters/x-correlator"
|
| requestBody:
|
| description: Parameters to create a new booking
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/CreateBooking"
|
| required: true
|
| callbacks:
|
| notifications:
|
| "{$request.body#/sink}":
|
| post:
|
| summary: Booking notifications callback
|
| description: |
|
| Important: this endpoint is to be implemented by the API consumer.
|
| The API provider will call this endpoint whenever any QoS Booking change related event occurs.
|
| Currently only `BOOKING_STATUS_CHANGED` event is defined.
|
| operationId: postBookingNotification
|
| parameters:
|
| - $ref: "#/components/parameters/x-correlator"
|
| requestBody:
|
| required: true
|
| content:
|
| application/cloudevents+json:
|
| schema:
|
| $ref: "#/components/schemas/CloudEvent"
|
| examples:
|
| BOOKING_STATUS_CHANGED_EXAMPLE:
|
| $ref: "#/components/examples/BOOKING_STATUS_CHANGED_EXAMPLE"
|
| responses:
|
| "204":
|
| description: Successful notification
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| "400":
|
| $ref: "#/components/responses/Generic400"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
| "410":
|
| $ref: "#/components/responses/Generic410"
|
| security:
|
| - {}
|
| - notificationsBearerAuth: []
|
| responses:
|
| "201":
|
| description: Booking created
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/BookingInfo"
|
| examples:
|
| BOOKING_AVAILABLE_WITH_DEVICE_RESPONSE:
|
| $ref: "#/components/examples/BOOKING_AVAILABLE_WITH_DEVICE_RESPONSE"
|
| BOOKING_UNAVAILABLE:
|
| $ref: "#/components/examples/BOOKING_UNAVAILABLE"
|
| "400":
|
| $ref: "#/components/responses/CreateBooking400"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
| "404":
|
| $ref: "#/components/responses/GenericDevice404"
|
| "409":
|
| $ref: "#/components/responses/BookingConflict409"
|
| "422":
|
| $ref: "#/components/responses/BookingUnprocessableEntity422"
|
| "429":
|
| $ref: "#/components/responses/Generic429"
|
| security:
|
| - openId:
|
| - "qos-booking:device-qos-bookings:create"
|
|
|
| /device-qos-bookings/{bookingId}:
|
| get:
|
| tags:
|
| - Device QoS Booking
|
| summary: Get QoS Booking information
|
| description: |
|
| Querying for QoS Booking information details
|
|
|
| **NOTES:**
|
| - The access token may be either 2-legged or 3-legged.
|
| - If a 3-legged access token is used, the subject associated with the QoS Booking must also be associated with the access token.
|
| - The QoS Booking must have been created by the same API client given in the access token.
|
|
|
| operationId: getBookingById
|
| parameters:
|
| - $ref: "#/components/parameters/BookingId"
|
| - $ref: "#/components/parameters/x-correlator"
|
| responses:
|
| "200":
|
| description: Returns information about certain booking
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/BookingInfo"
|
| examples:
|
| BOOKING_AVAILABLE_WITH_DEVICE_RESPONSE:
|
| $ref: "#/components/examples/BOOKING_AVAILABLE_WITH_DEVICE_RESPONSE"
|
| BOOKING_UNAVAILABLE:
|
| $ref: "#/components/examples/BOOKING_UNAVAILABLE"
|
| "400":
|
| $ref: "#/components/responses/Generic400"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
| "404":
|
| $ref: "#/components/responses/Generic404"
|
| "429":
|
| $ref: "#/components/responses/Generic429"
|
| security:
|
| - openId:
|
| - "qos-booking:device-qos-bookings:read"
|
|
|
| delete:
|
| tags:
|
| - Device QoS Booking
|
| summary: Deletes a QoS Booking
|
| description: |
|
| Release resources related to a QoS Booking.
|
|
|
| If the notification callback is provided and the booking status was `SCHEDULED` or `AVAILABLE`, when the deletion is completed, the client will receive, in addition to the response, a `BOOKING_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 subject associated with the QoS Booking must also be associated with the access token.
|
| - The QoS Booking must have been created by the same API client given in the access token.
|
| operationId: deleteBooking
|
| parameters:
|
| - $ref: "#/components/parameters/BookingId"
|
| - $ref: "#/components/parameters/x-correlator"
|
| responses:
|
| "204":
|
| description: Booking deleted
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| "202":
|
| description: Deletion request accepted to be processed. It applies for an async deletion process. `status` in the response will be `SCHEDULED` or `AVAILABLE` with `statusInfo` set to `DELETE_REQUESTED`.
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/BookingInfo"
|
| "400":
|
| $ref: "#/components/responses/Generic400"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
| "404":
|
| $ref: "#/components/responses/Generic404"
|
| "429":
|
| $ref: "#/components/responses/Generic429"
|
| security:
|
| - openId:
|
| - "qos-booking:device-qos-bookings:delete"
|
|
|
| /retrieve-device-qos-bookings:
|
| post:
|
| tags:
|
| - Device QoS Booking
|
| summary: Gets the QoS Booking for a device
|
| description: |
|
| Querying for QoS Booking resource information details for a device.
|
|
|
| **NOTES:**
|
| - The access token may be either 2-legged or 3-legged.
|
| - If a 3-legged access token is used, the subject associated with the QoS Booking must also be associated with the access token. In this case the optional `device` parameter MUST NOT be provided in the request.
|
| - If a 2-legged access token is used, the device parameter must be provided and identify a device.
|
| - The QoS Booking must have been created by the same API client given in the access token.
|
| - If no QoS booking is found for the requested device, an empty array is returned.
|
| - This call uses the POST method instead of GET to comply with the CAMARA Commonalities guidelines for sending sensitive or complex data in API calls. Since the device field may contain personally identifiable information, it should not be sent via GET.
|
|
|
| operationId: retrieveBookingByDevice
|
| parameters:
|
| - $ref: "#/components/parameters/x-correlator"
|
| requestBody:
|
| description: Parameters to retrieve a booking by device
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/RetrieveBookingByDevice"
|
| required: true
|
| responses:
|
| "200":
|
| description: Returns the QoS booking information for a given device. A device may have multiple bookings (for several times and locations), thus the response is an array. An empty array is returned if no sessions are found.
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/RetrieveBookingsOutput"
|
| examples:
|
| RETRIEVE_BOOKINGS_ONE_ITEM:
|
| $ref: "#/components/examples/RETRIEVE_BOOKINGS_ONE_ITEM"
|
| RETRIEVE_BOOKINGS_NO_ITEMS:
|
| $ref: "#/components/examples/RETRIEVE_BOOKINGS_NO_ITEMS"
|
| "400":
|
| $ref: "#/components/responses/Generic400"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
| "404":
|
| $ref: "#/components/responses/GenericDevice404"
|
| "422":
|
| $ref: "#/components/responses/Generic422"
|
| "429":
|
| $ref: "#/components/responses/Generic429"
|
| security:
|
| - openId:
|
| - "qos-booking:device-qos-bookings:retrieve-by-device"
|
|
|
| components:
|
| securitySchemes:
|
| openId:
|
| description: OpenID Connect authentication
|
| type: openIdConnect
|
| openIdConnectUrl: https://example.com/.well-known/openid-configuration
|
| notificationsBearerAuth:
|
| description: Bearer authentication for notifications
|
| type: http
|
| scheme: bearer
|
| bearerFormat: "{$request.body#/sinkCredential.credentialType}"
|
|
|
| parameters:
|
| BookingId:
|
| name: bookingId
|
| in: path
|
| description: Booking ID that was obtained from the createBooking operation
|
| required: true
|
| schema:
|
| $ref: "#/components/schemas/BookingId"
|
|
|
| x-correlator:
|
| name: x-correlator
|
| in: header
|
| description: Correlation id for the different services
|
| schema:
|
| $ref: "#/components/schemas/XCorrelator"
|
|
|
| headers:
|
| x-correlator:
|
| description: Correlation id for the different services
|
| schema:
|
| $ref: "#/components/schemas/XCorrelator"
|
|
|
| schemas:
|
| BookingId:
|
| description: Booking Identifier in UUID format
|
| type: string
|
| format: uuid
|
|
|
| BaseBookingInfo:
|
| description: Common attributes of a QoS Booking
|
| type: object
|
| properties:
|
| qosProfile:
|
| $ref: "#/components/schemas/QosProfileName"
|
| applicationServer:
|
| $ref: "#/components/schemas/ApplicationServer"
|
| devicePorts:
|
| description: The ports used locally by the device for flows to which the requested QoS profile should apply. If omitted, then the qosProfile will apply to all flows between the device and the specified application server address and ports
|
| allOf:
|
| - $ref: "#/components/schemas/PortsSpec"
|
| applicationServerPorts:
|
| description: A list of single ports or port ranges on the application server
|
| allOf:
|
| - $ref: "#/components/schemas/PortsSpec"
|
| sink:
|
| type: string
|
| format: uri
|
| pattern: ^https:\/\/.+$
|
| description: The address to which events shall be delivered, using the HTTP protocol.
|
| example: "https://endpoint.example.com/sink"
|
| sinkCredential:
|
| $ref: "#/components/schemas/SinkCredential"
|
| required:
|
| - qosProfile
|
|
|
| BookingInfo:
|
| description: |
|
| Booking related information returned in responses.
|
| Optional device object only to be returned if provided in createBooking. 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 createBooking).
|
| 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 QoS Booking creation.
|
| allOf:
|
| - $ref: "#/components/schemas/BaseBookingInfo"
|
| - type: object
|
| properties:
|
| device:
|
| $ref: "#/components/schemas/DeviceResponse"
|
| startTime:
|
| description: Date and time when QoS profile is scheduled to become available. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
|
| type: string
|
| format: date-time
|
| duration:
|
| description: |
|
| Session duration in seconds. Implementations can grant the requested session duration or set a different duration from `startTime`, based on network policies or conditions.
|
| - When `qosStatus` is "REQUESTED" or "SCHEDULED", the value is the duration to be scheduled, granted by the implementation.
|
| - When `qosStatus` is "AVAILABLE", the value is the overall duration since `startedAt`.
|
| - When `qosStatus` is "UNAVAILABLE", the value is the overall effective duration since `startedAt` until the session was terminated.
|
| type: integer
|
| format: int32
|
| minimum: 1
|
| serviceArea:
|
| $ref: "#/components/schemas/Area"
|
| bookingId:
|
| $ref: "#/components/schemas/BookingId"
|
| startedAt:
|
| description: Date and time when the Booking became "AVAILABLE". Not to be returned when `status` is "REQUESTED" or "SCHEDULED". It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
|
| type: string
|
| format: date-time
|
| status:
|
| $ref: "#/components/schemas/Status"
|
| statusInfo:
|
| $ref: "#/components/schemas/StatusInfo"
|
| required:
|
| - bookingId
|
| - status
|
| - startTime
|
| - duration
|
| - serviceArea
|
|
|
| CreateBooking:
|
| description: Attributes to request a new QoS Booking
|
| allOf:
|
| - $ref: "#/components/schemas/BaseBookingInfo"
|
| - type: object
|
| properties:
|
| device:
|
| $ref: "#/components/schemas/Device"
|
| startTime:
|
| description: Date and time when the API consumer requests the QoS profile to become available. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
|
| type: string
|
| format: date-time
|
| duration:
|
| description:
|
| Requested session duration in seconds. Value may be explicitly limited for the QoS profile, as specified in the Qos Profile (see qos-profile API). Implementations can grant the requested session duration or set a different duration from `startTime`, based on network policies or conditions.
|
| type: integer
|
| format: int32
|
| minimum: 1
|
| serviceArea:
|
| $ref: "#/components/schemas/Area"
|
| required:
|
| - startTime
|
| - duration
|
| - serviceArea
|
|
|
| RetrieveBookingByDevice:
|
| description: Attributes to look for QoS Booking
|
| type: object
|
| properties:
|
| device:
|
| $ref: "#/components/schemas/Device"
|
|
|
| RetrieveBookingsOutput:
|
| description: QoS bookings for a given device
|
| type: array
|
| items:
|
| $ref: "#/components/schemas/BookingInfo"
|
| minItems: 0
|
|
|
| SinkCredential:
|
| description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
|
| type: object
|
| properties:
|
| credentialType:
|
| type: string
|
| enum:
|
| - PLAIN
|
| - ACCESSTOKEN
|
| - REFRESHTOKEN
|
| description: "The type of the credential."
|
| discriminator:
|
| propertyName: credentialType
|
| mapping:
|
| PLAIN: "#/components/schemas/PlainCredential"
|
| ACCESSTOKEN: "#/components/schemas/AccessTokenCredential"
|
| REFRESHTOKEN: "#/components/schemas/RefreshTokenCredential"
|
| required:
|
| - credentialType
|
|
|
| PlainCredential:
|
| type: object
|
| description: A plain credential as a combination of an identifier and a secret.
|
| allOf:
|
| - $ref: "#/components/schemas/SinkCredential"
|
| - type: object
|
| required:
|
| - identifier
|
| - secret
|
| 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
|
|
|
| AccessTokenCredential:
|
| type: object
|
| description: An access token credential.
|
| allOf:
|
| - $ref: "#/components/schemas/SinkCredential"
|
| - type: object
|
| properties:
|
| accessToken:
|
| description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
|
| type: string
|
| accessTokenExpiresUtc:
|
| type: string
|
| format: date-time
|
| description: |
|
| REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired.
|
| In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
|
| If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match.
|
| It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
|
| example: "2023-07-03T12:27:08.312Z"
|
| accessTokenType:
|
| description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
|
| type: string
|
| enum:
|
| - bearer
|
| required:
|
| - accessToken
|
| - accessTokenExpiresUtc
|
| - accessTokenType
|
|
|
| RefreshTokenCredential:
|
| type: object
|
| description: An access token credential with a refresh token.
|
| allOf:
|
| - $ref: "#/components/schemas/SinkCredential"
|
| - type: object
|
| properties:
|
| accessToken:
|
| description: REQUIRED. An access token is a previously acquired token granting access to the target resource.
|
| type: string
|
| accessTokenExpiresUtc:
|
| type: string
|
| format: date-time
|
| description: |
|
| REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired.
|
| In the case of an ACCESS_TOKEN_EXPIRED termination reason, implementation should notify the client before the expiration date.
|
| If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match.
|
| It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
|
| example: "2023-07-03T12:27:08.312Z"
|
| accessTokenType:
|
| description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)).
|
| type: string
|
| enum:
|
| - bearer
|
| refreshToken:
|
| description: REQUIRED. An refresh token credential used to acquire access tokens.
|
| type: string
|
| refreshTokenEndpoint:
|
| type: string
|
| format: uri
|
| description: REQUIRED. A URL at which the refresh token can be traded for an access token.
|
| required:
|
| - accessToken
|
| - accessTokenExpiresUtc
|
| - accessTokenType
|
| - refreshToken
|
| - refreshTokenEndpoint
|
|
|
| Port:
|
| description: TCP or UDP port number
|
| type: integer
|
| minimum: 0
|
| maximum: 65535
|
|
|
| PortsSpec:
|
| description: Specification of several TCP or UDP ports
|
| type: object
|
| minProperties: 1
|
| properties:
|
| ranges:
|
| description: Range of TCP or UDP ports
|
| type: array
|
| minItems: 1
|
| items:
|
| type: object
|
| required:
|
| - from
|
| - to
|
| properties:
|
| from:
|
| $ref: "#/components/schemas/Port"
|
| to:
|
| $ref: "#/components/schemas/Port"
|
| ports:
|
| description: Array of TCP or UDP ports
|
| type: array
|
| minItems: 1
|
| items:
|
| $ref: "#/components/schemas/Port"
|
| example:
|
| ranges:
|
| - from: 5010
|
| to: 5020
|
| ports:
|
| - 5060
|
| - 5070
|
|
|
| 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).
|
| type: string
|
| example: QCI_1_voice
|
| minLength: 3
|
| maxLength: 256
|
| format: string
|
| pattern: "^[a-zA-Z0-9_.-]+$"
|
|
|
| CloudEvent:
|
| description: Event compliant with the CloudEvents specification
|
| required:
|
| - id
|
| - source
|
| - specversion
|
| - type
|
| - time
|
| properties:
|
| id:
|
| description: Identifier of this event, that must be unique in the source context.
|
| type: string
|
| source:
|
| description: Identifies the context in which an event happened in the specific Provider Implementation.
|
| type: string
|
| format: uri-reference
|
| type:
|
| description: The type of the event.
|
| type: string
|
| enum:
|
| - "org.camaraproject.qos-booking.v0.status-changed"
|
| specversion:
|
| description: Version of the specification to which this event conforms (must be 1.0 if it conforms to cloudevents 1.0.2 version)
|
| type: string
|
| enum:
|
| - "1.0"
|
| datacontenttype:
|
| description: 'media-type that describes the event payload encoding, must be "application/json" for CAMARA APIs'
|
| type: string
|
| enum:
|
| - "application/json"
|
| data:
|
| description: Event notification details payload, which depends on the event type
|
| type: object
|
| time:
|
| description: |
|
| Timestamp of when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
|
| type: string
|
| format: date-time
|
| discriminator:
|
| propertyName: "type"
|
| mapping:
|
| org.camaraproject.qos-booking.v0.status-changed: "#/components/schemas/EventStatusChanged"
|
|
|
| EventStatusChanged:
|
| description: Event to notify a QoS Booking status change
|
| allOf:
|
| - $ref: "#/components/schemas/CloudEvent"
|
| - type: object
|
| properties:
|
| data:
|
| type: object
|
| description: Event details depending on the event type
|
| required:
|
| - bookingId
|
| - status
|
| properties:
|
| bookingId:
|
| $ref: "#/components/schemas/BookingId"
|
| status:
|
| $ref: "#/components/schemas/StatusChanged"
|
| statusInfo:
|
| $ref: "#/components/schemas/StatusInfo"
|
| required:
|
| - data
|
|
|
| StatusInfo:
|
| description: |
|
| Reason for the new `status`. Currently `statusInfo` is only applicable when `status` is 'UNAVAILABLE'.
|
| * `DURATION_EXPIRED` - Session terminated due to requested duration expired
|
| * `NETWORK_TERMINATED` - Network terminated the QoS Booking
|
| * `DELETE_REQUESTED`- User requested the deletion of the QoS Booking
|
|
|
| type: string
|
| enum:
|
| - DURATION_EXPIRED
|
| - NETWORK_TERMINATED
|
| - DELETE_REQUESTED
|
|
|
| Area:
|
| description: Base schema for all areas
|
| type: object
|
| properties:
|
| areaType:
|
| $ref: "#/components/schemas/AreaType"
|
| required:
|
| - areaType
|
| discriminator:
|
| propertyName: areaType
|
| mapping:
|
| CIRCLE: "#/components/schemas/Circle"
|
| POLYGON: "#/components/schemas/Polygon"
|
| AREANAME: "#/components/schemas/AreaName"
|
|
|
| AreaType:
|
| type: string
|
| description: |
|
| Type of this area.
|
| CIRCLE - The area is defined as a circle.
|
| POLYGON - The area is defined as a polygon.
|
| AREANAME - The area is defined as an area name.
|
| enum:
|
| - CIRCLE
|
| - POLYGON
|
| - AREANAME
|
|
|
| Circle:
|
| description: Circular area
|
| allOf:
|
| - $ref: "#/components/schemas/Area"
|
| - type: object
|
| required:
|
| - center
|
| - radius
|
| properties:
|
| center:
|
| $ref: "#/components/schemas/Point"
|
| radius:
|
| type: number
|
| description: Distance from the center in meters
|
| minimum: 1
|
|
|
| Polygon:
|
| description: Polygonal area. The Polygon should be a simple polygon, i.e. should not intersect itself.
|
| allOf:
|
| - $ref: "#/components/schemas/Area"
|
| - type: object
|
| required:
|
| - boundary
|
| properties:
|
| boundary:
|
| $ref: "#/components/schemas/PointList"
|
|
|
| AreaName:
|
| description: The value of "AreaName" might be predefined and only regional or even an operator-specific in this API version. As a prerequisite, the API Provider may offer API Consumer the "AreaName" values, which API consumer can request, in a preparation phase. And then API Consumers can select from the "AreaNames" as Service Areas.
|
| allOf:
|
| - $ref: "#/components/schemas/Area"
|
| - type: object
|
| required:
|
| - areaName
|
| properties:
|
| areaName:
|
| type: string
|
|
|
| PointList:
|
| description: List of points defining a polygon
|
| type: array
|
| items:
|
| $ref: "#/components/schemas/Point"
|
| minItems: 3
|
| maxItems: 15
|
|
|
| Point:
|
| type: object
|
| description: Coordinates (latitude, longitude) defining a location in a map
|
| required:
|
| - latitude
|
| - longitude
|
| properties:
|
| latitude:
|
| $ref: "#/components/schemas/Latitude"
|
| longitude:
|
| $ref: "#/components/schemas/Longitude"
|
| example:
|
| latitude: 50.735851
|
| longitude: 7.10066
|
|
|
| Latitude:
|
| description: Latitude component of a location
|
| type: number
|
| format: double
|
| minimum: -90
|
| maximum: 90
|
|
|
| Longitude:
|
| description: Longitude component of location
|
| type: number
|
| format: double
|
| minimum: -180
|
| maximum: 180
|
|
|
| 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.
|
| 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
|
|
|
| ApplicationServer:
|
| description: |
|
| A server hosting backend applications to deliver some business logic to clients.
|
|
|
| The developer can choose to provide the below specified device identifiers:
|
|
|
| * `ipv4Address`
|
| * `ipv6Address`
|
| type: object
|
| properties:
|
| ipv4Address:
|
| $ref: "#/components/schemas/ApplicationServerIpv4Address"
|
| ipv6Address:
|
| $ref: "#/components/schemas/ApplicationServerIpv6Address"
|
| minProperties: 1
|
|
|
| ApplicationServerIpv4Address:
|
| type: string
|
| example: "198.51.100.0/24"
|
| description: |
|
| IPv4 address may be specified in form <address/mask> as:
|
| - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule.
|
| - address/mask - an IP number as above with a mask width of the form 1.2.3.4/24.
|
| In this case, all IP numbers from 1.2.3.0 to 1.2.3.255 will match. The bit width MUST be valid for the IP version.
|
|
|
| ApplicationServerIpv6Address:
|
| type: string
|
| example: "2001:db8:85a3:8d3:1319:8a2e:370:7344"
|
| description: |
|
| IPv6 address may be specified in form <address/mask> as:
|
| - address - The /128 subnet is optional for single addresses:
|
| - 2001:db8:85a3:8d3:1319:8a2e:370:7344
|
| - 2001:db8:85a3:8d3:1319:8a2e:370:7344/128
|
| - address/mask - an IP v6 number with a mask:
|
| - 2001:db8:85a3:8d3::0/64
|
| - 2001:db8:85a3:8d3::/64
|
|
|
| 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"
|
|
|
| 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"
|
|
|
| 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": "203.0.113.0",
|
| "publicPort": 59765
|
| }
|
|
|
| SingleIpv4Addr:
|
| description: A single IPv4 address with no subnet mask
|
| type: string
|
| format: ipv4
|
| example: "203.0.113.0"
|
|
|
| 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
|
|
|
| DeviceResponse:
|
| description: |
|
| An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer includes the `device` parameter in their request (i.e. they are using a two-legged access token), and is relevant when more than one device identifier is specified, as only one of those device identifiers is allowed in the response.
|
| If the API consumer provides more than one device identifier in their request, the API provider must return a single identifier which is the one they are using to fulfil the request, even if the identifiers do not match the same device. API provider does not perform any logic to validate/correlate that the indicated device identifiers match the same device. No error should be returned if the identifiers are otherwise valid to prevent API consumers correlating different identifiers with a given end user.
|
| allOf:
|
| - $ref: "#/components/schemas/Device"
|
| - maxProperties: 1
|
|
|
| Status:
|
| description: |
|
| The current status of the requested QoS Booking. The status can be one of the following:
|
| * `REQUESTED` - QoS booking has been requested but is still being processed.
|
| * `SCHEDULED` - QoS booking has been granted for a future start time.
|
| * `AVAILABLE` - The requested QoS profile has been activated for the device.
|
| * `UNAVAILABLE` - The QoS booking request has been processed but is not scheduled or active. `statusInfo` may provide additional information about the reason for the unavailability.
|
| type: string
|
| enum:
|
| - REQUESTED
|
| - SCHEDULED
|
| - AVAILABLE
|
| - UNAVAILABLE
|
|
|
| StatusChanged:
|
| description: |
|
| The current status of a requested, scheduled or previously available QoS Booking. Applicable values in the event are:
|
| * `SCHEDULED` - QoS booking has been granted for a future start time.
|
| * `AVAILABLE` - The requested QoS profile has been activated for the device.
|
| * `UNAVAILABLE` - The QoS booking request has been processed but is not scheduled or active. `statusInfo` may provide additional information about the reason for the unavailability.
|
| type: string
|
| enum:
|
| - SCHEDULED
|
| - AVAILABLE
|
| - UNAVAILABLE
|
|
|
| ErrorInfo:
|
| description: Common schema for errors
|
| type: object
|
| properties:
|
| status:
|
| type: integer
|
| description: HTTP response status code
|
| code:
|
| type: string
|
| description: A human-readable code to describe the error
|
| message:
|
| type: string
|
| description: A human-readable description of what the event represents
|
| required:
|
| - status
|
| - code
|
| - message
|
|
|
| XCorrelator:
|
| type: string
|
| pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
|
| example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
|
|
|
| responses:
|
| Generic400:
|
| description: Bad Request
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 400
|
| code:
|
| enum:
|
| - INVALID_ARGUMENT
|
| - OUT_OF_RANGE
|
| 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.
|
|
|
| CreateBooking400:
|
| description: Bad Request when creating a QoS booking.
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 400
|
| code:
|
| enum:
|
| - INVALID_ARGUMENT
|
| - OUT_OF_RANGE
|
| - QOS_BOOKING.DURATION_OUT_OF_RANGE
|
| - INVALID_CREDENTIAL
|
| - INVALID_TOKEN
|
| - INVALID_SINK
|
| 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.
|
| DurationOutOfRangeForQoSProfile:
|
| description: The requested duration is out of the allowed range for the specific QoS profile
|
| value:
|
| status: 400
|
| code: QOS_BOOKING.DURATION_OUT_OF_RANGE
|
| message: The requested duration is out of the allowed range for the specific QoS profile
|
| 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
|
| GENERIC_400_INVALID_SINK:
|
| description: Invalid sink value
|
| value:
|
| status: 400
|
| code: INVALID_SINK
|
| message: sink not valid for the specified protocol
|
|
|
| Generic401:
|
| description: Unauthorized
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 401
|
| code:
|
| enum:
|
| - UNAUTHENTICATED
|
| 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.
|
|
|
| Generic403:
|
| description: Forbidden
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 403
|
| code:
|
| enum:
|
| - PERMISSION_DENIED
|
| 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.
|
|
|
| Generic404:
|
| description: Not found
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 404
|
| code:
|
| enum:
|
| - NOT_FOUND
|
| examples:
|
| GENERIC_404_NOT_FOUND:
|
| description: Resource is not found
|
| value:
|
| status: 404
|
| code: NOT_FOUND
|
| message: The specified resource is not found.
|
|
|
| GenericDevice404:
|
| description: Not found
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 404
|
| code:
|
| enum:
|
| - NOT_FOUND
|
| - IDENTIFIER_NOT_FOUND
|
| 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: IDENTIFIER_NOT_FOUND
|
| message: Device identifier not found.
|
|
|
| BookingConflict409:
|
| description: Conflict
|
| headers:
|
| x-correlator:
|
| $ref: '#/components/headers/x-correlator'
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 409
|
| code:
|
| enum:
|
| - CONFLICT
|
| example:
|
| status: 409
|
| code: CONFLICT
|
| message: Conflict with an existing booking for the same device.
|
|
|
| Generic410:
|
| description: Gone
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 410
|
| code:
|
| enum:
|
| - GONE
|
| 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.
|
|
|
| Generic422:
|
| description: Unprocessable Content
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 422
|
| code:
|
| enum:
|
| - SERVICE_NOT_APPLICABLE
|
| - MISSING_IDENTIFIER
|
| - UNSUPPORTED_IDENTIFIER
|
| - UNNECESSARY_IDENTIFIER
|
| examples:
|
| GENERIC_422_SERVICE_NOT_APPLICABLE:
|
| description: Service not applicable for the provided identifier
|
| value:
|
| status: 422
|
| code: SERVICE_NOT_APPLICABLE
|
| message: The service is not available for the provided identifier.
|
| GENERIC_422_MISSING_IDENTIFIER:
|
| description: An identifier is not included in the request and the device or phone number identification cannot be derived from the access token
|
| value:
|
| status: 422
|
| code: MISSING_IDENTIFIER
|
| message: The device cannot be identified.
|
| GENERIC_422_UNSUPPORTED_IDENTIFIER:
|
| description: None of the provided identifiers is supported by the implementation
|
| value:
|
| status: 422
|
| code: UNSUPPORTED_IDENTIFIER
|
| message: The identifier provided is not supported.
|
| GENERIC_422_UNNECESSARY_IDENTIFIER:
|
| description: An explicit identifier is provided when a device or phone number has already been identified from the access token
|
| value:
|
| status: 422
|
| code: UNNECESSARY_IDENTIFIER
|
| message: The device is already identified by the access token.
|
|
|
| BookingUnprocessableEntity422:
|
| description: Unprocessable Content
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 422
|
| code:
|
| enum:
|
| - SERVICE_NOT_APPLICABLE
|
| - MISSING_IDENTIFIER
|
| - UNSUPPORTED_IDENTIFIER
|
| - UNNECESSARY_IDENTIFIER
|
| - QOS_BOOKING.NOT_MANAGED_AREA_TYPE
|
| - QOS_BOOKING.AREA_NOT_COVERED
|
| - QOS_BOOKING.INVALID_AREA
|
| examples:
|
| GENERIC_422_SERVICE_NOT_APPLICABLE:
|
| description: Service not applicable for the provided identifier
|
| value:
|
| status: 422
|
| code: SERVICE_NOT_APPLICABLE
|
| message: The service is not available for the provided identifier.
|
| GENERIC_422_MISSING_IDENTIFIER:
|
| description: An identifier is not included in the request and the device or phone number identification cannot be derived from the access token
|
| value:
|
| status: 422
|
| code: MISSING_IDENTIFIER
|
| message: The device cannot be identified.
|
| GENERIC_422_UNSUPPORTED_IDENTIFIER:
|
| description: None of the provided identifiers is supported by the implementation
|
| value:
|
| status: 422
|
| code: UNSUPPORTED_IDENTIFIER
|
| message: The identifier provided is not supported.
|
| GENERIC_422_UNNECESSARY_IDENTIFIER:
|
| description: An explicit identifier is provided when a device or phone number has already been identified from the access token
|
| value:
|
| status: 422
|
| code: UNNECESSARY_IDENTIFIER
|
| message: The device is already identified by the access token.
|
| QOS_BOOKING_422_NOT_MANAGED_AREA_TYPE:
|
| summary: Not managed area type
|
| description: The requested area type is currently not supported by implementation
|
| value:
|
| status: 422
|
| code: QOS_BOOKING.NOT_MANAGED_AREA_TYPE
|
| message: "The requested area type is not managed"
|
| QOS_BOOKING_422_AREA_NOT_COVERED:
|
| summary: The area cannot be covered
|
| description: The system is not able cover the requested area
|
| value:
|
| status: 422
|
| code: QOS_BOOKING.AREA_NOT_COVERED
|
| message: "Unable to cover the requested area"
|
| QOS_BOOKING_422_INVALID_AREA:
|
| summary: Invalid area
|
| description: The requested area value is not valid for the system. Details to be provided in the message.
|
| value:
|
| status: 422
|
| code: QOS_BOOKING.INVALID_AREA
|
| message: "The requested area is too small"
|
|
|
| Generic429:
|
| description: Too Many Requests
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 429
|
| code:
|
| enum:
|
| - QUOTA_EXCEEDED
|
| - TOO_MANY_REQUESTS
|
| examples:
|
| GENERIC_429_QUOTA_EXCEEDED:
|
| description: Request is rejected due to exceeding a business quota limit
|
| value:
|
| status: 429
|
| code: QUOTA_EXCEEDED
|
| message: Out of resource quota.
|
| GENERIC_429_TOO_MANY_REQUESTS:
|
| description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached
|
| value:
|
| status: 429
|
| code: TOO_MANY_REQUESTS
|
| message: Rate limit reached.
|
|
|
| examples:
|
| BOOKING_AVAILABLE_WITH_DEVICE_RESPONSE:
|
| summary: QoS booking status is available, with device included in response
|
| description: QoS booking info when status is available, and request used a 2-legged access token with multiple device identifiers, or possibly only a single device identifier
|
| value:
|
| qosProfile: "QOS_L"
|
| sink: "https://application-server.com/notifications"
|
| device:
|
| ipv4Address:
|
| publicAddress: "203.0.113.0"
|
| publicPort: 59765
|
| startTime: "2024-06-01T12:00:00Z"
|
| duration: 3600
|
| serviceArea:
|
| areaType: "CIRCLE"
|
| center:
|
| latitude: 50.735851
|
| longitude: 7.10066
|
| radius: 100
|
| bookingId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
| startedAt: "2024-06-01T12:00:00Z"
|
| status: "AVAILABLE"
|
|
|
| BOOKING_UNAVAILABLE:
|
| summary: QoS booking is unavailable, with device not included in response
|
| description: QoS booking info when status is unavailable due to network termination. Request used a 3-legged access token, or possibly a single device identifier
|
| value:
|
| qosProfile: "Acme2"
|
| sink: "https://application-server.com/notifications"
|
| startTime: "2024-06-01T12:00:00Z"
|
| duration: 2428
|
| serviceArea:
|
| areaType: "CIRCLE"
|
| center:
|
| latitude: 50.735851
|
| longitude: 7.10066
|
| radius: 100
|
| bookingId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
| startedAt: "2024-06-01T12:00:00Z"
|
| status: "UNAVAILABLE"
|
| statusInfo: "NETWORK_TERMINATED"
|
|
|
| BOOKING_STATUS_CHANGED_EXAMPLE:
|
| summary: Booking status changed
|
| description: Cloud event example for status change to UNAVAILABLE due to DURATION_EXPIRED
|
| value:
|
| id: "83a0d986-0866-4f38-b8c0-fc65bfcda452"
|
| source: "https://api.example.com/qod/v1/sessions/123e4567-e89b-12d3-a456-426614174000"
|
| type: "org.camaraproject.qos-booking.v0.status-changed"
|
| specversion: "1.0"
|
| time: "2024-06-01T13:00:00Z"
|
| data:
|
| bookingId: "123e4567-e89b-12d3-a456-426614174000"
|
| status: "UNAVAILABLE"
|
| statusInfo: "DURATION_EXPIRED"
|
|
|
| RETRIEVE_BOOKINGS_ONE_ITEM:
|
| summary: List of QoS sessions for the device
|
| description: A single QoS session for the device is available
|
| value:
|
| - qosProfile: "QOS_L"
|
| applicationServer:
|
| ipv4Address: "0.0.0.0/0"
|
| sink: "https://application-server.com/notifications"
|
| device:
|
| phoneNumber: "+123456789"
|
| startTime: "2024-06-01T12:00:00Z"
|
| duration: 3600
|
| serviceArea:
|
| areaType: "CIRCLE"
|
| center:
|
| latitude: 50.735851
|
| longitude: 7.10066
|
| radius: 100
|
| bookingId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
| startedAt: "2024-06-01T12:00:00Z"
|
| status: "AVAILABLE"
|
|
|
| RETRIEVE_BOOKINGS_NO_ITEMS:
|
| summary: No bookings found for the device
|
| description: An empty array is returned when no bookings are found for the device
|
| value: []
|
|
|
