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

Question

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

jpengar opened this issue 6 months ago · 5 comments

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.

Answer 1 · 2024-05-16T08:56:06.000Z

Already working on PR...

Answer 2 · 2024-05-16T09:48:03.000Z

Already working on PR...

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

Answer 3 · 2024-05-19T19:04:35.000Z

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

Answer 4 · 2024-05-20T07:58:57.000Z

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.

Answer 5 · 2024-05-23T09:56:14.000Z

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.