Skip to content

Commit

Permalink
Update qod-provisioning.yaml
Browse files Browse the repository at this point in the history
Fixing review comments
  • Loading branch information
jlurien committed Aug 6, 2024
1 parent 68f702c commit 8b12298
Showing 1 changed file with 36 additions and 3 deletions.
39 changes: 36 additions & 3 deletions code/API_definitions/qod-provisioning.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ info:
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 enpoint. In the current version,`sinkCredential.credentialType` MUST be set to `ACCESSTOKEN` if provided.
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:
Expand Down Expand Up @@ -138,7 +138,7 @@ paths:
x-correlator:
$ref: "#/components/headers/x-correlator"
"400":
$ref: "#/components/responses/Generic400"
$ref: "#/components/responses/CreateProvisioning400"
"401":
$ref: "#/components/responses/Generic401"
"403":
Expand Down Expand Up @@ -647,7 +647,7 @@ components:
* `phoneNumber`
* `networkAccessIdentifier`
NOTE1: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device
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:
Expand Down Expand Up @@ -774,6 +774,39 @@ components:
code: OUT_OF_RANGE
message: Client specified an invalid range.

CreateProvisioning400:
description: Bad Request with additional errors for implicit notifications
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorInfo"
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"

Generic401:
description: Unauthorized
headers:
Expand Down

0 comments on commit 8b12298

Please sign in to comment.