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

Broken link in v0.1 of CAMARA-API-access-and-user-consent.md #139

Closed
hdamker opened this issue Mar 13, 2024 · 2 comments · Fixed by #147
Closed

Broken link in v0.1 of CAMARA-API-access-and-user-consent.md #139

hdamker opened this issue Mar 13, 2024 · 2 comments · Fixed by #147
Assignees
Labels
correction API specification needs correction

Comments

@hdamker
Copy link
Collaborator

hdamker commented Mar 13, 2024

Problem description

https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-API-access-and-user-consent.md points to https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-AuthN-AuthZ-Concept.md in main branch which was deleted after the release of v0.1.

Expected behavior

Bring https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-AuthN-AuthZ-Concept.md back into main but with a disclaimer that the document is deprecated and will be deleted after ICM v0.2 and Commonalities v0.4 are released.

This approach would also address camaraproject/Commonalities#167

Alternative solution

Patch the link within v0.1.x of ICM with the correct link to https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-AuthN-AuthZ-Concept.md

Additional context

@jpengar
Copy link
Collaborator

jpengar commented Apr 8, 2024

As I said in the SP-ICM 2024-03-13 meeting (sorry, I thought it was updated in the issue as a comment), I'm actually fine with both options, either the proposed solution or the alternative.

@hdamker
Copy link
Collaborator Author

hdamker commented May 1, 2024

Learning from this issue: references to documents should always be links to a released version, not to main. In case the documents are released together, the links need to be updated latest within the release PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction API specification needs correction
Projects
None yet
2 participants