Public release r1.2 for Fall25 M4 milestone #78

XunliYang · 2025-08-25T09:41:02Z

What type of PR is this?

Add one of the following kinds:

subproject management

What this PR does / why we need it:

Create the initial public release of NetworkSliceBooking API to be included in Fall25 Meta release.

Modify content relevant to subproject management such as updating versions and links, including:

CHANGELOG.MD
API definition .yaml file
Test definition .feature files
API Readiness checklist
README.MD

Which issue(s) this PR fixes:

Fixes #77

Changelog input

 release-note

tanjadegroot

Hi Team,
quite a few comments, but most are easy to fix, and a number can wait for the next release, so you can create issues for them.

some were discovered by running an AI reviewer that Herbert is testing to help automating the reviews. You were used as a test case, but I thought it is worth including them in the review.

please go ahead and do the needed fixes, but the rest is up to you to do now or later.

tanjadegroot · 2025-09-10T23:23:56Z

CHANGELOG.md


 ## Table of Contents
 - [r1.1](#r1.1)
+- [r1.2](#r1.2)


this line should be put before line 4 (most recent at the top)

tanjadegroot · 2025-09-10T23:36:29Z

CHANGELOG.md

+## network-slice-booking v0.1.0
+
+**network-slice-booking v0.1.0 is first public release version of the network-slice-booking API**
+


the 3 links to view the API are missing (see as in r1.1, but links to r1.2, and same as in readme)

tanjadegroot · 2025-09-10T23:38:56Z

CHANGELOG.md

+**network-slice-booking v0.1.0 is first public release version of the network-slice-booking API**
+
+### Changed
+* Fix megalinter issues in [#71](https://github.com/camaraproject/NetworkSliceBooking/pull/71) 


CAMARA internal "administrative" commits do not need to be captured here (they are still visible in the full changelog), only the functional changes to the API useful for API providers and consumers

tanjadegroot · 2025-09-10T23:46:52Z

README.md

+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.2/code/API_definitions/network-slice-booking.yaml)
+
 <!-- The latest public release is available here: https://github.com/camaraproject/§repo_name§/releases/latest -->


Suggested change



The latest public release is available here: https://github.com/camaraproject/NetworkSliceBooking/releases/latest

tanjadegroot · 2025-09-10T23:47:18Z

README.md

+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.2/code/API_definitions/network-slice-booking.yaml)
+
 <!-- The latest public release is available here: https://github.com/camaraproject/§repo_name§/releases/latest -->


Suggested change



The latest public release is available here: https://github.com/camaraproject/NetworkSliceBooking/releases/latest

tanjadegroot · 2025-09-11T14:55:06Z

code/API_definitions/network-slice-booking.yaml

Need to remove 410 GONE from createSession operation (line 90) - per CAMARA standards, 410 is only for callback endpoints
Possibly use the 503 SERVICE_UNAVAILABLE error in case of resource exhaustion (see CAMARA_common.yaml)

Please note that this also implies updating the test file of createSession

tanjadegroot · 2025-09-11T15:04:55Z

code/API_definitions/network-slice-booking.yaml

ENUM naming convention:

AreaType uses ALL_CAPS (CIRCLE, POLYGON) instead of camelCase per CAMARA guidelines

updateing this would also impact the test files

could be done for next release.

Hi @tanjadegroot , I'm a little confusing that I see AreaType has used ALL_CAPS (CIRCLE, POLYGON) and only the schemas use camelCase.

Hi @XunliYang, you are right that the CAMARA_common.yaml contains the same. Please ignore this comment.
I will check with the Commonalities team on this point.

tanjadegroot · 2025-09-11T15:13:59Z

code/API_definitions/network-slice-booking.yaml

the parameter x-correlator is defined, but not used in the API operations
please check the same in QualityOnDemand - quality-on-demand.yaml API on how to do this

corresponding tests on x-correlator parameters can be added in next release.

tanjadegroot · 2025-09-11T15:22:48Z

code/API_definitions/network-slice-booking.yaml

TimeUnitEnum and RateUnitEnum define enum values.
when using these enum values (in the examples), there should not be any quotes around them.
e.g. line 690: unit: "bps"
should be: unit: bps

same for other enum values used throughout the file and maybe in the test files

tanjadegroot · 2025-09-11T15:24:51Z

code/Test_definitions/network-slice-booking-createSession.feature

Comment for future version: add tests for polygon area validation limits (between 3-15 points)

XunliYang · 2025-09-16T07:04:24Z

Hi @tanjadegroot, Thank you for your review and feedback.
We have addressed comments and updated the code accordingly. Here is a summary of the changes. Please take another look when you have a moment.

API definition Yaml

[1]Generic422 rename to "NetworkSlideBooking422"

I noticed that the Generic422 error is actually not generic, but a specific error for network slide booking
To be more explicit, it could be renamed to "NetworkSlideBooking422".

also there are several reasons listed in the example which seem worth having their own 422 error : service area is not supported, resources are insufficient - for better problem understand, rather than having them in the same error.

Could be done for the next release.

FIXED:

Rename the Generic422 error to "NetworkSliceBooking422"
Create issue Generic422 error rename to be more explicit #81. Split the 422 error with "service area is not supported" error and "resources are insufficient" error in next release.

[2]API design documentation link

the local reference to the API design documentation in line 6 does not work, as the context is github.io, not the API repository.

FIXED:

Rename the actual documentation file to "Network_Slice_Booking_API_Design.md"
Update the link in the yaml file to https://github.com/camaraproject/NetworkSliceBooking/blob/r1.2/documentation/API_documentation/Network_Slice_Booking_API_Design.md

[3]Remove 410 GONE from createSession operation

Need to remove 410 GONE from createSession operation (line 90) - per CAMARA standards, 410 is only for callback endpoints
Possibly use the 503 SERVICE_UNAVAILABLE error in case of resource exhaustion (see CAMARA_common.yaml)

Please note that this also implies updating the test file of createSession

FIXED:

Remove 410 GONE. As error statuses 5xx are not documented by default in the API specification, 503 SERVICE_UNAVAILABLE is not added.
Remove 410 in createSeesion test file.
Plan to add asynchronous callback in the next release(issue Add asynchronous callback in the createSession operation #84)

[4]ENUM AreaType naming convention

ENUM naming convention:

AreaType uses ALL_CAPS (CIRCLE, POLYGON) instead of camelCase per CAMARA guidelines

updateing this would also impact the test files

could be done for next release.

FIXED:

Create issue ENUM AreaType naming convention #80
No need to modify

[5]Parameter x-correlator use in the API operations

the parameter x-correlator is defined, but not used in the API operations
please check the same in QualityOnDemand - quality-on-demand.yaml API on how to do this

corresponding tests on x-correlator parameters can be added in next release.

FIXED:

Add x-correlator as request parameters in all operations.
Add x-correlator as headers in response code 201、204、200
Create issue Add corresponding tests on x-correlator parameters #83. Add corresponding tests on x-correlator parameters in next release.

[6]unit "bps" to bps

TimeUnitEnum and RateUnitEnum define enum values.
when using these enum values (in the examples), there should not be any quotes around them.
e.g. line 690: unit: "bps"
should be: unit: bps

same for other enum values used throughout the file and maybe in the test files

FIXED:

Modify enum values "bps"、"Milliseconds"in yaml
No need to modify in test files

Test files

[1]"specifies" to "specified"

FIXED:

Fix in three feature file

[2]getSession and deleteSession | line 53: the error should be "OUT_OF_RANGE"

FIXED:

"INVALID_ARGUMENT" to "OUT_OF_RANGE"

[3]add tests for polygon area validation limits (between 3-15 points)

FIXED:

Create issue Add tests for polygon area validation limits (between 3-15 points) #82, finish in the next release

CHANGELOG

[1]the position of "[r1.2]" should be put before "[r1.1]"

this line should be put before line 4 (most recent at the top)

FIXED:

Move "[r1.2]" to before "[r1.1]"

[2]the 3 links to view the API in r1.2 are missing

the 3 links to view the API are missing (see as in r1.1, but links to r1.2, and same as in readme)

FIXED:

Modify all three link: NetworkSliceBooking.yaml to network-slice-booking.yaml
Add API review links in r1.2 which linked to r1.2(line 30)

[3]"administrative" commits should not be captured here

CAMARA internal "administrative" commits do not need to be captured here (they are still visible in the full changelog), only the functional changes to the API useful for API providers and consumers

FIXED:

Remove "Fix megalinter issues in [Fix MegaLinter Issues #71]"
Remove "Fix trailing-spaces issues in [Fix trailing-spaces #73]"

[4]"Release note:" to "Release Notes"

FIXED:

line18: "Release note:" to "Release Notes"
line41: "Release note:" to "Release Notes"

README

[1]remove the annotations

you have copied the line, but you could just remove the comments as I did for the above sections. so now you can remove this line 31

FIXED:

Remove line 30 and line 31
Add "The latest public release is available here: https://github.com/camaraproject/NetworkSliceBooking/releases/latest"

[2]API view link fix "NetworkSliceBooking.yaml" to "network-slice-booking.yaml"

FIXED:

Modify all three link
The same in changelog file both in r1.1 and r1.2

tanjadegroot

Hi team,
thanks very much for all the updates you have done and for registering the future updates in the issues ! excellent result :-)

LGTM from Release Management

chinaunicomyangfan

LGTM

ChinaUnicomXiaoDongrui and others added 3 commits August 25, 2025 16:12

update something in M4 review

e93bfe2

Merge branch 'camaraproject:main' into main

0ffcfb5

Add r1.2 changelog

b4fc8c9

XunliYang requested review from a team, DanXu-ChinaTelecom, Kai-hw and chinaunicomyangfan as code owners August 25, 2025 09:41

hdamker mentioned this pull request Aug 25, 2025

NetworkSliceBooking (Fall25 M4) release review camaraproject/ReleaseManagement#297

Closed

34 tasks

Modify urls for r1.2

6f9910c

tanjadegroot requested changes Sep 11, 2025

View reviewed changes

This was referenced Sep 12, 2025

ENUM AreaType naming convention #80

Closed

Generic422 error rename to be more explicit #81

Closed

Add tests for polygon area validation limits (between 3-15 points) #82

Open

XunliYang and others added 7 commits September 15, 2025 15:32

Add x-correlator in request parameters and response headers

5c2e78e

Correct the link to API_Design.md

a1b38ac

Rename Generic422

bec2b65

Remove 410 GONE

5fbcbb1

Correct field format and naming conventions

01c9257

update readme file according to M4 Review

f4eb328

Update CHANGELOG file

7181389

tanjadegroot approved these changes Sep 16, 2025

View reviewed changes

chinaunicomyangfan approved these changes Sep 17, 2025

View reviewed changes

chinaunicomyangfan merged commit 3bc5b23 into camaraproject:main Sep 17, 2025
2 checks passed

		## network-slice-booking v0.1.0

		network-slice-booking v0.1.0 is first public release version of the network-slice-booking API

	<!-- The latest public release is available here: https://github.com/camaraproject/§repo_name§/releases/latest -->
	The latest public release is available here: https://github.com/camaraproject/NetworkSliceBooking/releases/latest

Public release r1.2 for Fall25 M4 milestone #78

Public release r1.2 for Fall25 M4 milestone #78

Uh oh!

Conversation

XunliYang commented Aug 25, 2025

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Changelog input

Uh oh!

tanjadegroot left a comment

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

XunliYang commented Sep 16, 2025

API definition Yaml

Test files

CHANGELOG

README

Uh oh!

tanjadegroot left a comment

Choose a reason for hiding this comment

Uh oh!

chinaunicomyangfan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants