search

camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs
Apache License 2.0
14 stars 28 forks source link

Include Reference Link to CAMARA API Design Guidelines in Notification Cloud Events Artifact #290

Open PedroDiez opened 2 months ago

PedroDiez commented 2 months ago

Problem description

In current artifact: https://github.com/camaraproject/Commonalities/blob/main/artifacts/notification-as-cloud-event.yaml#L37

It could be added the link to the documentation: https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#122-event-notification

Expected action

Include reference (highlighted below)

This endpoint describes the event notification received on subscription listener side when the event occurred. A detailed description of the event notification is provided in the CAMARA API design guideline document.

Additional context Issue proposed for MetaRelease Spring 25 - https://github.com/camaraproject/Commonalities/issues/273

rartych commented 1 month ago

If we agree on API Design Guidelines cleanup: https://github.com/camaraproject/Commonalities/issues/306 then then link will change.

rartych commented 1 month ago

Decided to be resolved together with https://github.com/camaraproject/Commonalities/issues/306