Skip to content
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.

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

Link within mandatory text for all APIs points to main branch - need to be corrected in rc.2 #185

Closed
hdamker opened this issue Jul 31, 2024 · 0 comments · Fixed by #186
Closed
Assignees
Labels
correction API specification needs correction

Comments

@hdamker
Copy link
Collaborator

hdamker commented Jul 31, 2024

Problem description

The mandatory template text which got copied into every API Version for the meta-release contains a link to the main branch of Identify and Consent Management:

Authorization and authentication

Camara Security and Interoperability Profile provides details on how a client requests an access token.

Shortly after the Fall24 meta release this branch will not any more contain the version which is the relevant one for the meta-release. Actually this link would hinder the working group to work on the Profile in the expected way.

This issue was originally brought up by @sfnuser in camaraproject/NumberVerification#121 (comment) and was discussed within camaraproject/ReleaseManagement#51.

Expected behavior

As the preferred short-term solution it was identified that there should be only a link to the ICM repository, not the concrete document. The README of the repository then should guide to the correct released version of the profile.

Text proposal:

### Authorization and authentication

The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.

The README.md of ICM should have a link to the document which is the valid one for the Fall24 meta-release (similar to the links on Commonalities to the most important documents)

Alternative solution

Other solutions were discussed in camaraproject/ReleaseManagement#51:

  • links to a concrete release tag of ICM wouldn't work as ICM would lose the option to release patch releases of the Profile
  • introducing additional "meta" tags was postponed to a later release cycle

Additional context

@hdamker hdamker added the correction API specification needs correction label Jul 31, 2024
@hdamker hdamker changed the title Link within mandatory text for all APIs points to main branch - need to corrected Link within mandatory text for all APIs points to main branch - need to be corrected in rc.2 Jul 31, 2024
@hdamker hdamker self-assigned this Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment