Skip to content

r1.2 for version 0.1.0 (Fall'25 M4) #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tlohmar merged 2 commits into from
Sep 17, 2025
Merged

r1.2 for version 0.1.0 (Fall'25 M4) #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0d06e2
r1.2 for version 0.1.0
rkandoi Aug 20, 2025
0c8ae21
Apply suggestions from code review
rkandoi Sep 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,77 @@
# Changelog Dedicated Networks

# r1.2
## Release Notes

This release contains the definition and documentation of
* dedicated-network v0.1.0
* dedicated-network-accesses v0.1.0
* dedicated-network-profiles v0.1.0

The API definition(s) are based on
* Commonalities v0.6.0
* Identity and Consent Management v0.4.0

## Key updates

* Aligning QoS Profile with QualityOnDemand
* Introduces a new QosProfileName DataType into the Profiles API aligning the definition with QualityOnDemand
* by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/59
* Documentation (info section in Profiles & Accesses API and general documentation) is extended to clarify that the reuse the QualityOnDemand QOS Profiles concept
* by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/54

* Aligning Device object with Commonalities
* Introducing all the common supported identifiers to align with the object definition
* Extending the general documentation with a motivation for supporting MSISDNs as device identifier.
* Adding a recommendation for not supporting IP addresses as device identifier.
* by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/55

* Clarification that an Access resource can only be created once the referred Network is created. When the referred Network is in TERMINATED state, creation of Access resources is not possible anymore for the given Network by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/53

* Adding 3GPP Release information to DedicatedNetworks_GeneralDescription.md by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/51

## dedicated-network v0.1.0

**dedicated-network v0.1.0 is the initial public release of version 0.1.0 of the Dedicated Network API.**

- dedicated-network v0.1.0 API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network.yaml)

## dedicated-network-accesses v0.1.0

**dedicated-network-accesses v0.1.0 is the initial public release of version 0.1.0 of the Dedicated Network Accesses API.**

- dedicated-network-accesses v0.1.0 API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-accesses.yaml)

### Changed

* Aligning Device object with Commonalities by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/55

## dedicated-network-profiles v0.1.0

**dedicated-network-profiles v0.1.0 is the initial public release of version 0.1.0 of the Dedicated Network Profiles API.**

- dedicated-network-profiles v0.1.0 API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-profiles.yaml)

### Added

* Introduces a new QosProfileName DataType into the Profiles API aligning the definition with QualityOnDemand by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/59

**Full Changelog**: https://github.com/camaraproject/DedicatedNetworks/commits/r1.2




# r1.1

## Release Notes

This release contains the definition and documentation of
Expand Down
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Copy link
Contributor

@tanjadegroot tanjadegroot Sep 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 12, the second sentence could be update to the new Sub Project this API will be part of.

Copy link
Contributor Author

@rkandoi rkandoi Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it better to wait for a formal approval before this change is made? Also, it seems the name of the WG itself might be evolved. So it seems it may not be possible to achieve this change in this release (although I think it would be great it we could achieve it!)

Copy link
Contributor

@tlohmar tlohmar Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, we are now moving into the QoD Sub Project. Renaming this sub project can be seen as an independent activity.
I though, that the sub project structure should only be visible inside of CAMARA. Since the parent sub project is mentioned pretty first in the README it is also well visible outside for developers.

Copy link
Contributor Author

@rkandoi rkandoi Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in PR: #77

Copy link
Contributor

@hdamker hdamker Sep 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 12, the second sentence could be update to the new Sub Project this API will be part of.

As I wrote also in PR #77 - I prefer that this change is only done after formal approval (in TSC) and with that after the release. There is no urgency to get this change into the release.

cc: @tanjadegroot

Copy link
Contributor

@tanjadegroot tanjadegroot Sep 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 19: change customer -> consumer

Copy link
Contributor Author

@rkandoi rkandoi Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created PR : https://github.com/camaraproject/DedicatedNetworks/pull/75/files

Original file line number Diff line number Diff line change
Expand Up @@ -31,28 +31,28 @@ Sandbox API Repository to describe, develop, document, and test the DedicatedNet

**Version Control Notice:** This project undergoes active development with frequent updates to the main branch. No backward compatibility is guaranteed for any code in development branches, including main, until an official release is published. Code changes, including potential reversions, may occur between commits. We recommend using the latest official release version.

**NEW**: r1.2 with initial public release of dedicated-network v0.1.0, dedicated-network-profiles v0.1.0 and dedicated-network-accesses v0.1.0 is available.

**The latest public release is [r1.2](https://github.com/camaraproject/DedicatedNetworks/releases/tag/r1.2), with the API versions listed below**

**The first pre-release is [r1.1](https://github.com/camaraproject/DedicatedNetworks/releases/tag/r1.1), with the API versions listed below**
To facilitate understanding of these APIs, please consult the [General Description](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/documentation/API_documentation/DedicatedNetworks_GeneralDescription.md) for essential concepts and workflows prior to examining the technical specifications.

To facilitate understanding of these APIs, please consult the [General Description](https://github.com/camaraproject/DedicatedNetworks/blob/r1.1/documentation/API_documentation/DedicatedNetworks_GeneralDescription.md) for essential concepts and workflows prior to examining the technical specifications.
* **dedicated-network v0.1.0 (initial public release)**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml)

* **dedicated-network v0.1.0-rc.1 (release candidate)**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.1/code/API_definitions/dedicated-network.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.1/code/API_definitions/dedicated-network.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.1/code/API_definitions/dedicated-network.yaml)
* **dedicated-network-profiles v0.1.0 (initial public release)**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml)

* **dedicated-network-profiles v0.1.0-rc.1 (release candidate)**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.1/code/API_definitions/dedicated-network-profiles.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.1/code/API_definitions/dedicated-network-profiles.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.1/code/API_definitions/dedicated-network-profiles.yaml)
* **dedicated-network-accesses v0.1.0 (initial public release)**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-accesses.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml)

* **dedicated-network-accesses v0.1.0-rc.1 (release candidate)**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.1/code/API_definitions/dedicated-network-accesses.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.1/code/API_definitions/dedicated-network-accesses.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.1/code/API_definitions/dedicated-network-accesses.yaml)

Previous releases and pre-releases are available here: https://github.com/camaraproject/DedicatedNetworks/releases
Previous public releases and pre-releases are available here: https://github.com/camaraproject/DedicatedNetworks/releases

For changes see the [CHANGELOG.md](https://github.com/camaraproject/DedicatedNetworks/blob/main/CHANGELOG.md)

Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/dedicated-network-accesses.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,13 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: wip
version: 0.1.0
x-camara-commonalities: 0.6
externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/DedicatedNetworks
servers:
- url: "{apiRoot}/dedicated-network-accesses/vwip"
- url: "{apiRoot}/dedicated-network-accesses/v0.1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/dedicated-network-profiles.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: wip
version: 0.1.0
x-camara-commonalities: 0.6
externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/DedicatedNetworks
servers:
- url: "{apiRoot}/dedicated-network-profiles/vwip"
- url: "{apiRoot}/dedicated-network-profiles/v0.1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/dedicated-network.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: wip
version: 0.1.0
x-camara-commonalities: 0.6
externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/DedicatedNetworks
servers:
- url: "{apiRoot}/dedicated-network/vwip"
- url: "{apiRoot}/dedicated-network/v0.1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down
14 changes: 7 additions & 7 deletions code/Test_definitions/dedicated-network-accesses.feature
View file
Open in desktop
Copy link
Contributor

@tanjadegroot tanjadegroot Sep 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in all 3 feature files, in the background section change:
And the header "x-correlator" is set to a string value
to
And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

Copy link
Contributor Author

@rkandoi rkandoi Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created PR: #76

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Dedicated Network API, wip - Network Accesses API Operations
Feature: CAMARA Dedicated Network API, v0.1.0 - Network Accesses API Operations
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -20,7 +20,7 @@ Feature: CAMARA Dedicated Network API, wip - Network Accesses API Operations

@dedicated_network_accesses_listNetworkAccesses_01_success_all
Scenario: List all network accesses
Given the resource "/dedicated-network-accesses/vwip/accesses"
Given the resource "/dedicated-network-accesses/v0.1/accesses"
When the request "listNetworkAccesses" is sent
Then the response status code is 200
And the response header "Content-Type" is "application/json"
Expand All @@ -30,7 +30,7 @@ Feature: CAMARA Dedicated Network API, wip - Network Accesses API Operations
@dedicated_network_accesses_listNetworkAccesses_02_success_filtered_by_network
Scenario: List network accesses filtered by network ID
Given an existing dedicated network
And the resource "/dedicated-network-accesses/vwip/accesses"
And the resource "/dedicated-network-accesses/v0.1/accesses"
And the query parameter "networkId" is set to the ID of the existing network
When the request "listNetworkAccesses" is sent
Then the response status code is 200
Expand All @@ -42,7 +42,7 @@ Feature: CAMARA Dedicated Network API, wip - Network Accesses API Operations
@dedicated_network_accesses_listNetworkAccesses_03_success_filtered_by_device
Scenario: List network accesses filtered by device
Given a valid device identifier
And the resource "/dedicated-network-accesses/vwip/accesses"
And the resource "/dedicated-network-accesses/v0.1/accesses"
And the header "x-device" is set to a RFC 8941 structured field value representing the Device schema (#/components/schemas/Device) (e.g., 'phonenumber="+123456789"')
When the request "listNetworkAccesses" is sent
Then the response status code is 200
Expand All @@ -56,7 +56,7 @@ Feature: CAMARA Dedicated Network API, wip - Network Accesses API Operations
@dedicated_network_accesses_createNetworkAccess_01_success
Scenario: Create a network access with valid parameters
Given an existing dedicated network
And the resource "/dedicated-network-accesses/vwip/accesses"
And the resource "/dedicated-network-accesses/v0.1/accesses"
And the header "Content-Type" is set to "application/json"
And the header "x-device" is set to a RFC 8941 structured field value representing the Device schema (#/components/schemas/Device) (e.g., 'phonenumber="+123456789"')
And the request body is set to a request body compliant with the schema at "/components/schemas/CreateNetworkAccess"
Expand All @@ -76,7 +76,7 @@ Feature: CAMARA Dedicated Network API, wip - Network Accesses API Operations
@dedicated_network_accesses_readNetworkAccess_01_success
Scenario: Get details of a specific network access
Given an existing network access
And the resource "/dedicated-network-accesses/vwip/accesses/{accessId}"
And the resource "/dedicated-network-accesses/v0.1/accesses/{accessId}"
And the path parameter "accessId" is set to the ID of the existing access
When the request "readNetworkAccess" is sent
Then the response status code is 200
Expand All @@ -90,7 +90,7 @@ Feature: CAMARA Dedicated Network API, wip - Network Accesses API Operations
@dedicated_network_accesses_deleteNetworkAccess_01_success
Scenario: Delete a network access
Given an existing network access
And the resource "/dedicated-network-accesses/vwip/accesses/{accessId}"
And the resource "/dedicated-network-accesses/v0.1/accesses/{accessId}"
And the path parameter "accessId" is set to the ID of the existing access
When the request "deleteNetworkAccess" is sent
Then the response status code is 204
Expand Down
6 changes: 3 additions & 3 deletions code/Test_definitions/dedicated-network-profiles.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Dedicated Network API, wip - Network Profiles API Operations
Feature: CAMARA Dedicated Network API, v0.1.0 - Network Profiles API Operations
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -18,7 +18,7 @@ Feature: CAMARA Dedicated Network API, wip - Network Profiles API Operations

@dedicated_network_profiles_readNetworkProfiles_01_success
Scenario: List all available network profiles
Given the resource "/dedicated-network-profiles/vwip/profiles"
Given the resource "/dedicated-network-profiles/v0.1/profiles"
When the request "readNetworkProfiles" is sent
Then the response status code is 200
And the response header "Content-Type" is "application/json"
Expand All @@ -31,7 +31,7 @@ Feature: CAMARA Dedicated Network API, wip - Network Profiles API Operations
@dedicated_network_profiles_readNetworkProfile_01_success
Scenario: Get details of a specific network profile
Given an existing network profile
And the resource "/dedicated-network-profiles/vwip/profiles/{profileId}"
And the resource "/dedicated-network-profiles/v0.1/profiles/{profileId}"
And the path parameter "profileId" is set to the ID of the existing profile
When the request "readNetworkProfile" is sent
Then the response status code is 200
Expand Down
12 changes: 6 additions & 6 deletions code/Test_definitions/dedicated-network.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: CAMARA Dedicated Network API, wip - Networks API Operations
Feature: CAMARA Dedicated Network API, v0.1.0 - Networks API Operations
# Input to be provided by the implementation to the tester
#
# Implementation indications:
Expand All @@ -20,7 +20,7 @@ Feature: CAMARA Dedicated Network API, wip - Networks API Operations

@dedicated_network_listNetworks_01_success
Scenario: List all dedicated networks
Given the resource "/dedicated-network/vwip/networks"
Given the resource "/dedicated-network/v0.1/networks"
When the request "listNetworks" is sent
Then the response status code is 200
And the response header "Content-Type" is "application/json"
Expand All @@ -31,7 +31,7 @@ Feature: CAMARA Dedicated Network API, wip - Networks API Operations

@dedicated_network_createNetwork_01_success_basic
Scenario: Create a dedicated network (basic success)
Given the resource "/dedicated-network/vwip/networks"
Given the resource "/dedicated-network/v0.1/networks"
And the header "Content-Type" is set to "application/json"
And the request body is set to a request body compliant with the schema at "/components/schemas/CreateNetwork"
And the request body property "$.profileId" is set to a valid network profile ID
Expand All @@ -49,7 +49,7 @@ Feature: CAMARA Dedicated Network API, wip - Networks API Operations

@dedicated_network_createNetwork_02_success_echo
Scenario: Create a dedicated network (response echoes request fields)
Given the resource "/dedicated-network/vwip/networks"
Given the resource "/dedicated-network/v0.1/networks"
And the header "Content-Type" is set to "application/json"
And the request body is set to a request body compliant with the schema at "/components/schemas/CreateNetwork"
And the request body property "$.profileId" is set to a valid network profile ID
Expand All @@ -70,7 +70,7 @@ Feature: CAMARA Dedicated Network API, wip - Networks API Operations
@dedicated_network_readNetwork_01_success
Scenario: Get details of a specific network
Given an existing dedicated network
And the resource "/dedicated-network/vwip/networks/{networkId}"
And the resource "/dedicated-network/v0.1/networks/{networkId}"
And the path parameter "networkId" is set to the ID of the existing network
When the request "readNetwork" is sent
Then the response status code is 200
Expand All @@ -84,7 +84,7 @@ Feature: CAMARA Dedicated Network API, wip - Networks API Operations
@dedicated_network_deleteNetwork_01_success
Scenario: Delete a dedicated network
Given an existing dedicated network
And the resource "/dedicated-network/vwip/networks/{networkId}"
And the resource "/dedicated-network/v0.1/networks/{networkId}"
And the path parameter "networkId" is set to the ID of the existing network
When the request "deleteNetwork" is sent
Then the response status code is 204
Expand Down
Loading