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

rkandoi · 2025-08-20T10:17:30Z

What type of PR is this?

subproject management

What this PR does / why we need it:

Create the initial public release of Dedicated Network APIs to be included in Fall25 Meta release.

Contains (only) changes relevant to subproject management such as updating versions and links.

CHANGELOG.md

hdamker · 2025-09-02T13:32:43Z

@rkandoi Your PR branch is 27 commits behind main and can't be reviewed with that. Please resolve the merge conflicts and update your branch from main. Please set back to "ready for review" if done.

rkandoi · 2025-09-03T05:03:52Z

Thanks @hdamker for pointing out. Perhaps some error when I created the working branch. In any case, the PR is now rebased on the lastest main and hence marked as "Ready for review" as suggested.

hdamker · 2025-09-05T12:09:19Z

One point in all three API Readiness Checklists: line 13 in the table has no valid link and the status is missing

code/Test_definitions/dedicated-network-accesses.feature

hdamker · 2025-09-05T12:31:13Z

Regarding the content of API definition an observations:

dedicated-network.yaml references dedicated-network-profiles.yaml schemas
dedicated-network-accesses.yaml references dedicated-network.yaml schemas

We have currently no mechanism in place to resolve these references and create independent bundle API definitions. These references could create challenges for API implementations and API Consumer. So it might be better to copy the definitions for now.

tlohmar · 2025-09-05T12:37:04Z

Regarding the content of API definition an observations:

dedicated-network.yaml references dedicated-network-profiles.yaml schemas

dedicated-network-accesses.yaml references dedicated-network.yaml schemas

We have currently no mechanism in place to resolve these references and create independent bundle API definitions. These references could create challenges for API implementations and API Consumer. So it might be better to copy the definitions for now.

We have removed all the direct links to API specifications and only reference the top level repository (i.e. https://github.com/camaraproject/DedicatedNetworks/). Thus, this is very similar as to referencing e.g. https://github.com/camaraproject/IdentityAndConsentManagement/

hdamker · 2025-09-05T12:54:37Z

Regarding the content of API definition an observations:

dedicated-network.yaml references dedicated-network-profiles.yaml schemas

dedicated-network-accesses.yaml references dedicated-network.yaml schemas

We have currently no mechanism in place to resolve these references and create independent bundle API definitions. These references could create challenges for API implementations and API Consumer. So it might be better to copy the definitions for now.

We have removed all the direct links to API specifications and only reference the top level repository (i.e. https://github.com/camaraproject/DedicatedNetworks/). Thus, this is very similar as to referencing e.g. https://github.com/camaraproject/IdentityAndConsentManagement/

I meant this kind of reference between the YAMLs:

          schema:
            $ref: 'dedicated-network.yaml#/components/schemas/NetworkId'

tlohmar · 2025-09-05T13:02:26Z

I meant this kind of reference between the YAMLs:

          schema:
            $ref: 'dedicated-network.yaml#/components/schemas/NetworkId'

Is the recommendation to duplicate the data type definition and add some verbal references?

hdamker · 2025-09-05T13:53:19Z

Converted to draft due to the two open PRs.

tlohmar

@rkandoi Please sync, as two PullRequests were merged and should be included in this release..

rkandoi · 2025-09-11T05:02:49Z

Highlighted issues have been addressed, specifically:

Fixing the version in the test definitions
Updating the API Descriptions Wiki link in line 13 of readiness checklist

The suggestion about the schemas has not been addressed and is proposed to be considered for a future release.

The PR is now also rebased on latest main.

Marked PR as ready for review again @hdamker and @tlohmar .

tlohmar

Looks good. Thx.

tanjadegroot · 2025-09-13T14:16:22Z

I meant this kind of reference between the YAMLs:
          schema:
            $ref: 'dedicated-network.yaml#/components/schemas/NetworkId'
Is the recommendation to duplicate the data type definition and add some verbal references?

yes, the files should be self contained and hence the schema should be in the local file "schemas" section, and the reference can only look like this: $ref: '#/components/schemas/

I recommend fixing this in the r1.2 release as you have the risk that tools used by API consumers will not be able to load your public API spec file.

tanjadegroot

Some tweeks to update plus a strong recommendation to remove the cross file schema references in the yaml files.
For the rest it looks great !

Some suggestions for the next release as well.

README.md

tanjadegroot · 2025-09-13T13:19:34Z

README.md

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

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!)

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.

Fixed in PR: #77

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

tanjadegroot · 2025-09-13T13:21:13Z

README.md

Line 19: change customer -> consumer

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

code/Test_definitions/dedicated-network.feature

tanjadegroot · 2025-09-13T15:06:18Z

code/Test_definitions/dedicated-network-accesses.feature

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"

Created PR: #76

documentation/API_documentation/dedicated-network-API-Readiness-Checklist.md

documentation/API_documentation/dedicated-network-accesses-API-Readiness-Checklist.md

documentation/API_documentation/dedicated-network-profiles-API-Readiness-Checklist.md

rkandoi · 2025-09-15T13:07:46Z

I meant this kind of reference between the YAMLs:
          schema:
            $ref: 'dedicated-network.yaml#/components/schemas/NetworkId'
Is the recommendation to duplicate the data type definition and add some verbal references?
yes, the files should be self contained and hence the schema should be in the local file "schemas" section, and the reference can only look like this: $ref: '#/components/schemas/

I recommend fixing this in the r1.2 release as you have the risk that tools used by API consumers will not be able to load your public API spec file.

Updated now in PR: #78

hdamker · 2025-09-16T12:03:00Z

Updated now in PR: #78

PR #78 needs to be merged, and the release PR here synced with main for the final review.

Is my assumption correct that you don't plan to correct the order within ErrorInfo schema? That's fine, especially as the API will have significant changes within the next version. I'm just asking as the API most probably will be the only one which will use the order message -> status -> code instead of status -> code -> message.

cc: @tanjadegroot

tanjadegroot · 2025-09-16T22:41:21Z

Hi Team,
will you do the update to fix the ErrorInfo definition in the 3 yaml files ? it is a quick fix to do.
It should look like this (from CAMARA_common.yaml), only the schema needs to be changed to the below:

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

rkandoi · 2025-09-17T05:28:10Z

Hi Team, will you do the update to fix the ErrorInfo definition in the 3 yaml files ? it is a quick fix to do. It should look like this (from CAMARA_common.yaml), only the schema needs to be changed to the below:
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

Hi @hdamker, @tanjadegroot , @tlohmar : Fixed in this PR: #79.

This can be seen as a cosmetic/consistency related change and has no functional impact as you know.

tanjadegroot · 2025-09-17T12:04:26Z

Hi Team, will you do the update to fix the ErrorInfo definition in the 3 yaml files ? it is a quick fix to do. It should look like this (from CAMARA_common.yaml), only the schema needs to be changed to the below:
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
Hi @hdamker, @tanjadegroot , @tlohmar : Fixed in this PR: #79.

This can be seen as a cosmetic/consistency related change and has no functional impact as you know.

Agreed, but consistency is important for API adoption :-)
Many thanks for making the change !

Added "public" keyword to the README and marked API Description to "Y" in checklist Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

rkandoi · 2025-09-17T13:43:52Z

@hdamker @tanjadegroot - Thank you for all your feedback. All changes are now merged and this PR is now rebased on the latest main. Hence ready for approval.

tanjadegroot

Hi team, @rkandoi, all is looking great ! thanks to team for the updates/

LGTM from Release Management

tlohmar

Looks good, thanks.

tanjadegroot · 2025-09-17T22:33:39Z

Team, we are missing the release creation and the update of the API tracker on the wiki.
If you can please do before the TSC (Sep 18 4PM CEST) that would be great

rkandoi requested review from a team, PeterKovacs2, carlosromerog, eric-murray and tlohmar as code owners August 20, 2025 10:17

eric-murray reviewed Aug 20, 2025

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

tlohmar requested a review from SteveV-Vodafone August 20, 2025 19:28

PeterKovacs2 previously approved these changes Aug 21, 2025

View reviewed changes

Kevsy changed the title ~~r1.2 for version 0.1.0~~ r1.2 for version 0.1.0 (Fall'25 M4) Aug 21, 2025

Kevsy mentioned this pull request Aug 21, 2025

DedicatedNetworks r1.2 (Fall25 M4) release review camaraproject/ReleaseManagement#289

Closed

34 tasks

hdamker marked this pull request as draft September 2, 2025 13:32

rkandoi dismissed PeterKovacs2’s stale review via 7e967ea September 3, 2025 04:52

rkandoi force-pushed the r1.2-v0.1.0 branch 2 times, most recently from 7e967ea to e8efea9 Compare September 3, 2025 05:01

rkandoi marked this pull request as ready for review September 3, 2025 05:02

hdamker reviewed Sep 5, 2025

View reviewed changes

code/Test_definitions/dedicated-network-accesses.feature Show resolved Hide resolved

hdamker marked this pull request as draft September 5, 2025 13:52

rkandoi force-pushed the r1.2-v0.1.0 branch from e8efea9 to 765b3ef Compare September 8, 2025 05:34

tlohmar reviewed Sep 8, 2025

View reviewed changes

rkandoi force-pushed the r1.2-v0.1.0 branch from 765b3ef to 8fa0942 Compare September 11, 2025 05:00

rkandoi marked this pull request as ready for review September 11, 2025 05:00

tlohmar previously approved these changes Sep 11, 2025

View reviewed changes

tanjadegroot requested changes Sep 13, 2025

View reviewed changes

rkandoi dismissed tlohmar’s stale review via fe1005e September 14, 2025 06:10

This was referenced Sep 14, 2025

Editorial fix - change "customer" to "consumer" in README #75

Merged

Update tests to use XCorrelator schema instead of string #76

Merged

Update README to point to QOS Sub Project #77

Merged

Update API Specs to avoid cross-referencing schemas #78

Merged

rkandoi force-pushed the r1.2-v0.1.0 branch from fe1005e to 2f74873 Compare September 16, 2025 14:46

rkandoi mentioned this pull request Sep 17, 2025

Align ErrorInfo Schema with Commonalities #79

Merged

rkandoi and others added 2 commits September 17, 2025 15:42

r1.2 for version 0.1.0

e0d06e2

Apply suggestions from code review

0c8ae21

Added "public" keyword to the README and marked API Description to "Y" in checklist Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

rkandoi force-pushed the r1.2-v0.1.0 branch from 2f74873 to 0c8ae21 Compare September 17, 2025 13:42

tanjadegroot approved these changes Sep 17, 2025

View reviewed changes

tlohmar approved these changes Sep 17, 2025

View reviewed changes

tlohmar merged commit 431d9a1 into camaraproject:main Sep 17, 2025
2 checks passed

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

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

Uh oh!

Conversation

rkandoi commented Aug 20, 2025

What type of PR is this?

What this PR does / why we need it:

Uh oh!

Uh oh!

hdamker commented Sep 2, 2025

Uh oh!

rkandoi commented Sep 3, 2025

Uh oh!

hdamker commented Sep 5, 2025

Uh oh!

Uh oh!

hdamker commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tlohmar commented Sep 5, 2025

Uh oh!

hdamker commented Sep 5, 2025

Uh oh!

tlohmar commented Sep 5, 2025

Uh oh!

hdamker commented Sep 5, 2025

Uh oh!

tlohmar left a comment

Choose a reason for hiding this comment

Uh oh!

rkandoi commented Sep 11, 2025

Uh oh!

tlohmar left a comment

Choose a reason for hiding this comment

Uh oh!

tanjadegroot commented Sep 13, 2025

Uh oh!

tanjadegroot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hdamker Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rkandoi commented Sep 15, 2025

Uh oh!

hdamker commented Sep 16, 2025

Uh oh!

tanjadegroot commented Sep 16, 2025

Uh oh!

rkandoi commented Sep 17, 2025

Uh oh!

tanjadegroot commented Sep 17, 2025

Uh oh!

rkandoi commented Sep 17, 2025

Uh oh!

tanjadegroot left a comment

hdamker commented Sep 5, 2025 •

edited

Loading

hdamker Sep 16, 2025 •

edited

Loading