Public release r1.2 for Fall25 M4 milestone#78
Public release r1.2 for Fall25 M4 milestone#78chinaunicomyangfan merged 11 commits intocamaraproject:mainfrom
Conversation
tanjadegroot
left a comment
There was a problem hiding this comment.
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.
|
|
||
| ## Table of Contents | ||
| - [r1.1](#r1.1) | ||
| - [r1.2](#r1.2) |
There was a problem hiding this comment.
this line should be put before line 4 (most recent at the top)
| ## network-slice-booking v0.1.0 | ||
|
|
||
| **network-slice-booking v0.1.0 is first public release version of the network-slice-booking API** | ||
|
|
There was a problem hiding this comment.
the 3 links to view the API are missing (see as in r1.1, but links to r1.2, and same as in readme)
CHANGELOG.md
Outdated
| **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) |
There was a problem hiding this comment.
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
README.md
Outdated
| - [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 --> |
There was a problem hiding this comment.
| <!-- 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 |
README.md
Outdated
| - [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 --> |
There was a problem hiding this comment.
| <!-- 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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Hi @tanjadegroot , I'm a little confusing that I see AreaType has used ALL_CAPS (CIRCLE, POLYGON) and only the schemas use camelCase.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Comment for future version: add tests for polygon area validation limits (between 3-15 points)
|
Hi @tanjadegroot, Thank you for your review and feedback. API definition Yaml[1]Generic422 rename to "NetworkSlideBooking422"
FIXED:
[2]API design documentation link
FIXED:
[3]Remove 410 GONE from createSession operation
FIXED:
[4]ENUM AreaType naming convention
FIXED:
[5]Parameter x-correlator use in the API operations
FIXED:
[6]unit "bps" to bps
FIXED:
Test files[1]"specifies" to "specified" FIXED:
[2] FIXED:
[3]add tests for polygon area validation limits (between 3-15 points) FIXED:
CHANGELOG[1]the position of "[r1.2]" should be put before "[r1.1]"
FIXED:
[2]the 3 links to view the API in r1.2 are missing
FIXED:
[3]"administrative" commits should not be captured here
FIXED:
[4]"Release note:" to "Release Notes" FIXED:
README[1]remove the annotations
FIXED:
[2]API view link fix "NetworkSliceBooking.yaml" to "network-slice-booking.yaml" FIXED:
|
tanjadegroot
left a comment
There was a problem hiding this comment.
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
What type of PR is this?
Add one of the following kinds:
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:
Which issue(s) this PR fixes:
Fixes #77
Changelog input