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

"CAMARA-API-access-and-user-consent.md" aligment with last decisions made in profile doc #154

Closed
jpengar opened this issue May 16, 2024 · 5 comments · Fixed by #155
Closed
Assignees
Labels
documentation Improvements or additions to documentation v0.2-candidate Custom label for issues that are candidates to be fixed in v0.2 (if needed)

Comments

@jpengar
Copy link
Collaborator

jpengar commented May 16, 2024

Problem description

As raised in the 08/05 WG meeting, it is required to align CAMARA-API-access-and-user-consent.md document with the last decisions made in the CAMARA-Security-Interoperability.md profile document. Mainly related to the purpose management solution agreed in the profile.

Expected action

Clean up and update the CAMARA-API-access-and-user-consent.md document to reflect the latest profile decisions and/or to include references(*) to the new profile document where appropriate.

Additional context

(*)NOTE: These references need to be updated before the next release generation to change the path according to the next release tag. To avoid problems with broken links we had in the past.

@jpengar jpengar added documentation Improvements or additions to documentation v0.2-candidate Custom label for issues that are candidates to be fixed in v0.2 (if needed) labels May 16, 2024
@jpengar
Copy link
Collaborator Author

jpengar commented May 16, 2024

Already working on PR...

@hdamker hdamker assigned hdamker and jpengar and unassigned hdamker May 16, 2024
@hdamker
Copy link
Collaborator

hdamker commented May 16, 2024

Already working on PR...

Thanks @jpengar ... have assigned the issue to show this clearly.

@AxelNennker
Copy link
Collaborator

I suggest moving the OpenAPI security scheme "openid" from CAMARA-API-access-and-user-consent.md Commonalities API design guidelines because the API design guideline already have a section that describe how a Camara API should be in OpenAPI.

Please see: camaraproject/Commonalities#208

@jpengar
Copy link
Collaborator Author

jpengar commented May 20, 2024

I suggest moving the OpenAPI security scheme "openid" from CAMARA-API-access-and-user-consent.md Commonalities API design guidelines because the API design guideline already have a section that describe how a Camara API should be in OpenAPI.

Please see: camaraproject/Commonalities#208

@AxelNennker I would keep the discussion here tied to the original goal of the issue, and deal with this other topic you raise above in a separate issue (independent of #154 and PR #155). And I would keep camaraproject/Commonalities#208 in DRAFT until a decision is made in the ICM WG. ICM, as Commonalities WG, also provides guidance to API subprojects and this should be well-known. This particular guideline comes from ICM and I personally would keep this information within ICM.

camaraproject/Commonalities#208 is intended to adapt the CAMARA API Design Guidelines document to the new ICM Security and Interoperability Profile. But moving this section is not related to the content of the profile. I would suggest to discuss relevant issues like this before proposing a PR in Commonalities.

@jpengar
Copy link
Collaborator Author

jpengar commented May 23, 2024

I suggest moving the OpenAPI security scheme "openid" from CAMARA-API-access-and-user-consent.md Commonalities API design guidelines because the API design guideline already have a section that describe how a Camara API should be in OpenAPI.
Please see: camaraproject/Commonalities#208

@AxelNennker I would keep the discussion here tied to the original goal of the issue, and deal with this other topic you raise above in a separate issue (independent of #154 and PR #155). And I would keep camaraproject/Commonalities#208 in DRAFT until a decision is made in the ICM WG. ICM, as Commonalities WG, also provides guidance to API subprojects and this should be well-known. This particular guideline comes from ICM and I personally would keep this information within ICM.

camaraproject/Commonalities#208 is intended to adapt the CAMARA API Design Guidelines document to the new ICM Security and Interoperability Profile. But moving this section is not related to the content of the profile. I would suggest to discuss relevant issues like this before proposing a PR in Commonalities.

#160 created as agreed during the ICM meeting on 22 May.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v0.2-candidate Custom label for issues that are candidates to be fixed in v0.2 (if needed)
Projects
None yet
3 participants