| openapi: 3.0.3
|
| info:
|
| title: Dedicated Network - Network Profiles
|
| description: |
|
|
|
|
|
|
|
| This API allows for discovering available network profiles, which are offered by the network provider to be used in conjunction of the Dedicated Network API. Network profiles describe the capabilities and performance targets of a dedicated network. For more information about the Dedicated Networks APIs, see [link]().
|
|
|
|
|
|
|
| A Network Profile represents a predefined set of network capabilities and performance characteristics that can be applied when creating a Network. It enables API Consumers to understand the capabilities they can expect when using the reserved network connectivity resources. A Network Profile is a validated, supported configuration that has been pre-approved between the API Provider and API Consumer.
|
|
|
| A Network Profile contains information about the maximum number of devices allowed, the aggregated throughput to be provided, and a set of allowed QoS Profiles that devices can use when having access to the Dedicated Network. The concept of named QoS Profiles is re-used from the [QualityOnDemand](https://github.com/camaraproject/QualityOnDemand) API family. An API provider may offer the QualityOnDemand `qos-profiles` API for resolving a QoS Profile name into characteristics of a specific QoS profile.
|
|
|
| Network Profiles are designed to support different use-cases and should contain the matching `qos-profile` combinations. Generally, two types of Network Profiles can be identified
|
| * Network Profiles containing only a `defaultQosProfile`
|
| * Network Profiles containing one or more additional `qos-profile`s with the `qosProfiles` array. When multiple QoS Profiles are supported within one Network Profile, the QualityOnDemand `quality-on-demand` API may be used to assign one of the available QoS profiles to a specific device while the Network is in `ACTIVATED` state
|
|
|
| Devices are not neccessarily using connectivity continuously. The value of the `maxNumberOfDevices` parameter should be set _generous_, considering that not all devices using connectivity simultaneously and/or continuously.
|
|
|
| The parameters `aggregatedUlThroughput` and `aggregatedDlThroughput` define the (hard) limits of simultaneous connectivity usage, ie. sum of all traffic pertaining all devices using the available QoS profiles.
|
|
|
| A detailed description of the individual parameters may be included within the _terms and conditions_ (outside of scope for the API).
|
|
|
|
|
|
|
| The key characteristics of the API include:
|
|
|
| - Network Profiles are read-only resources from the API Consumer perspective
|
|
|
| - They are discoverable through GET operations
|
|
|
| - Each Network Profile has a unique identifier (profileId)
|
|
|
| - The profileId serves as a reference when creating a Dedicated Network
|
|
|
| - The API returns only Network Profiles that the API Consumer is eligible to use based on their agreements
|
|
|
|
|
|
|
| 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.
|
|
|
|
|
|
|
| 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.
|
|
|
| license:
|
| name: Apache 2.0
|
| url: https://www.apache.org/licenses/LICENSE-2.0.html
|
| version: wip
|
| x-camara-commonalities: 0.6
|
| externalDocs:
|
| description: Product documentation at CAMARA
|
| url: https://github.com/camaraproject/DedicatedNetworks
|
| servers:
|
| - url: "{apiRoot}/dedicated-network-profiles/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`
|
| paths:
|
| /profiles:
|
| get:
|
| tags:
|
| - Profiles
|
| summary: Read dedicated network profiles
|
| operationId: readNetworkProfiles
|
| security:
|
| - openId:
|
| - dedicated-network-profiles:profiles:read
|
| parameters:
|
| - name: name
|
| in: query
|
| description: name of a network profile
|
| schema:
|
| type: string
|
| - $ref: "#/components/parameters/x-correlator"
|
| responses:
|
| '200':
|
| description: List of available network profiles
|
| content:
|
| application/json:
|
| schema:
|
| type: array
|
| items:
|
| $ref: '#/components/schemas/NetworkProfile'
|
| '400':
|
| $ref: "#/components/responses/Generic400"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
|
|
| /profiles/{profileId}:
|
| get:
|
| tags:
|
| - Profiles
|
| summary: Read a dedicated network profile
|
| operationId: readNetworkProfile
|
| security:
|
| - openId:
|
| - dedicated-network-profiles:profiles:read
|
| parameters:
|
| - name: profileId
|
| in: path
|
| required: true
|
| schema:
|
| $ref: "#/components/schemas/NetworkProfileId"
|
| - $ref: "#/components/parameters/x-correlator"
|
| responses:
|
| '200':
|
| description: List of available network profiles
|
| content:
|
| application/json:
|
| schema:
|
| $ref: '#/components/schemas/NetworkProfile'
|
| '400':
|
| $ref: "#/components/responses/Generic400"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
| "404":
|
| $ref: "#/components/responses/Generic404"
|
|
|
| components:
|
| securitySchemes:
|
| openId:
|
| type: openIdConnect
|
| openIdConnectUrl: https://example.com/.well-known/openid-configuration
|
| headers:
|
| x-correlator:
|
| description: Correlation id for the different services
|
| schema:
|
| $ref: "#/components/schemas/XCorrelator"
|
| parameters:
|
| x-correlator:
|
| name: x-correlator
|
| in: header
|
| description: Correlation id for the different services
|
| schema:
|
| $ref: "#/components/schemas/XCorrelator"
|
|
|
| schemas:
|
|
|
| XCorrelator:
|
| type: string
|
| pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
|
| example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
|
|
|
| NetworkProfileId:
|
| description: Network profile id in UUID format
|
| type: string
|
| format: uuid
|
|
|
| NetworkProfile:
|
| type: object
|
| properties:
|
| id:
|
| $ref: '#/components/schemas/NetworkProfileId'
|
| name:
|
| description: A human-readable name to describe the network profile
|
| type: string
|
| maxNumberOfDevices:
|
| type: integer
|
| aggregatedUlThroughput:
|
| $ref: "#/components/schemas/BitRate"
|
| aggregatedDlThroughput:
|
| $ref: "#/components/schemas/BitRate"
|
| qosProfiles:
|
| description: Qos Profiles, which are supported by the dedicated network.
|
| type: array
|
| items:
|
| $ref: '#/components/schemas/QosProfileName'
|
| minItems: 1
|
| defaultQosProfile:
|
| $ref: '#/components/schemas/QosProfileName'
|
| required:
|
| - id
|
| - maxNumberOfDevices
|
| - aggregatedUlThroughput
|
| - aggregatedDlThroughput
|
| - qosProfiles
|
| - defaultQosProfile
|
|
|
| BitRate:
|
| description: Specification of bitrate
|
| type: object
|
| properties:
|
| value:
|
| description: Quantity of bitrate
|
| type: integer
|
| example: 10
|
| format: int32
|
| minimum: 1
|
| maximum: 1024
|
| unit:
|
| $ref: "#/components/schemas/BitRateUnitEnum"
|
|
|
| BitRateUnitEnum:
|
| description: Units of bitrate
|
| type: string
|
| enum:
|
| - bps
|
| - kbps
|
| - Mbps
|
| - Gbps
|
| - Tbps
|
|
|
| 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.
|
| type: string
|
| example: QCI_1_voice
|
| minLength: 3
|
| maxLength: 256
|
| format: string
|
| pattern: "^[a-zA-Z0-9_.-]+$"
|
|
|
| ErrorInfo:
|
| type: object
|
| required:
|
| - status
|
| - code
|
| - message
|
| 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
|
|
|
| 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.
|
|
|
| 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 and a new authentication is required
|
| value:
|
| status: 401
|
| code: UNAUTHENTICATED
|
| message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
|
|
|
| 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
|
| - INVALID_TOKEN_CONTEXT
|
| 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."
|
|
|
| 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
|
| - 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_IDENTIFIER_NOT_FOUND:
|
| description: Some identifier cannot be matched to a device
|
| value:
|
| status: 404
|
| code: IDENTIFIER_NOT_FOUND
|
| message: Device identifier not found.
|
|
|
| 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.
|
|
|
