Release r1.1 with 0.1.0-rc.1 version (Fall'25 M3)#15
Release r1.1 with 0.1.0-rc.1 version (Fall'25 M3)#15Kevsy merged 34 commits intocamaraproject:mainfrom
Conversation
documentation/API_documentation/Application-Endpoint-Registration-API-Readiness-Checklist.md
Outdated
Show resolved
Hide resolved
|
Apart from that small typo in comment above, LGTM. |
As per API versioning guidelines "For initial public API versions 0.y.z, the MINOR number MUST be included in the URL, e.g. v0.y. "
Kevsy
left a comment
There was a problem hiding this comment.
LGTM (I fixed the the API version in the URL)
| <!-- Pre-releases of this sub project are available in https://github.com/camaraproject/ApplicationEndpointRegistration/releases --> | ||
| <!-- The latest public release is available here: https://github.com/camaraproject/ApplicationEndpointRegistration/releases/latest --> | ||
| <!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/main/CHANGELOG.md) --> | ||
| Pre-releases of this sub project are available in https://github.com/camaraproject/ApplicationEndpointRegistration/releases |
There was a problem hiding this comment.
| Pre-releases of this sub project are available in https://github.com/camaraproject/ApplicationEndpointRegistration/releases | |
| Pre-releases of this API repository are available in https://github.com/camaraproject/ApplicationEndpointRegistration/releases |
There was a problem hiding this comment.
Commented out because there are no pre-releases
There was a problem hiding this comment.
Actually should this line be used, with r1.1 there is a release in this repository.
But change it a little bit (template need to be updated):
Pre-releases of this API repository are available in https://github.com/camaraproject/ApplicationEndpointRegistration/releases
There was a problem hiding this comment.
Actually should this line be used, with r1.1 there is a release in this repository
Ah yes - I forgot the clarification on the Wiki: "
A pre-release is a GitHub release of an alpha or release-candidate API version. Note: the term release is also often used here but it should be clear from the context."
Thanks, and I'll update the text to state "API repository" as suggested above.
tanjadegroot
left a comment
There was a problem hiding this comment.
One important change to align on standard API design practice, and a few tweeks and you will be ok to go.
| @@ -2,7 +2,7 @@ | |||
| openapi: 3.0.3 | |||
| info: | |||
| title: Application Endpoints Registration | |||
There was a problem hiding this comment.
The CAMARA (and industry) recommendation is to have the resource name always as plural.
then the POST and GET operation are on the same endpoint.
Although I agree this is a bit counter intuitive, your above approach is not standard practice for REST APIs (for developers using the API), which is to use plural for the resource name.
I recommend that you group the POST and GET operations under /application-endpoint-lists (in plural)
Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>
Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>
|
@tanjadegroot Thank you for the comments. I have done the changes, could you please review. |
code/Test_definitions/application-endpoint-registration.feature
Outdated
Show resolved
Hide resolved
code/Test_definitions/application-endpoint-registration.feature
Outdated
Show resolved
Hide resolved
Kevsy
left a comment
There was a problem hiding this comment.
Just a few changes (see suggestions to commit above)
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
|
Thank you @Kevsy for the comments, I have updated the Test file. |
code/Test_definitions/application-endpoint-registration.feature
Outdated
Show resolved
Hide resolved
|
@urvika-v you can proceed with the PR merge, pre-release and wiki update: or if you let me know within the next 30 minutes of this comment I can do it :) These are the tasks:
|
|
@urvika-v this reviewed/approved PR was closed without merging, please proceed with the tasks from my comment above (or I can do them, just let me know) |
|
@Kevsy , I guess I am not code owner. The option to merge is not available for me. |
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Publication of Fall'25 M3 release candidate v0.1.0-rc.1
Which issue(s) this PR fixes:
Fixes #
Special notes for reviewers:
None
Changelog input
Additional documentation
This section can be blank.