Skip to content

Commit f94d471

Browse files
committed
Making yamls compliant to Commonalities 0.5 (Fall-25 Meta Release), providing an initial API description.
1 parent e56f4eb commit f94d471

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

code/API_definitions/dedicated-network-accesses.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
openapi: 3.0.3
22
info:
33
title: Dedicated Network - Network Accesses API
4+
description: |
5+
This API allows for requesting network access for devices. A device is identified by the CAMARA _device object_, containing either a n MSIDSN or a Network Access Identifier.
46
license:
57
name: Apache 2.0
68
url: https://www.apache.org/licenses/LICENSE-2.0.html
79
version: wip
8-
x-camara-commonalities: 0.4.0
10+
x-camara-commonalities: 0.5
911
servers:
1012
- url: "{apiRoot}/dedicated-network-accesses/vwip"
1113
variables:

code/API_definitions/dedicated-network-profiles.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
openapi: 3.0.3
22
info:
33
title: Dedicated Network - Network Profiles API
4+
description: |
5+
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.
46
license:
57
name: Apache 2.0
68
url: https://www.apache.org/licenses/LICENSE-2.0.html
79
version: wip
8-
x-camara-commonalities: 0.4.0
10+
x-camara-commonalities: 0.5
911
servers:
1012
- url: "{apiRoot}/dedicated-network-profiles/vwip"
1113
variables:

code/API_definitions/dedicated-network.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
openapi: 3.0.3
22
info:
33
title: Dedicated Network - Networks API
4+
description: |
5+
This API allows for requesting a Dedicated Network, which provides a set of capabilities and connectivity performance targets. The Dedicated Network may be requested for a particular geographical location and at a particular time window. Depending on the requested start time for the dedicated network, the network may first enter a _reserved_ state.
46
license:
57
name: Apache 2.0
68
url: https://www.apache.org/licenses/LICENSE-2.0.html
79
version: wip
8-
x-camara-commonalities: 0.4.0
10+
x-camara-commonalities: 0.5
911
servers:
1012
- url: "{apiRoot}/dedicated-network/vwip"
1113
variables:

0 commit comments

Comments
 (0)