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

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

Open
PedroDiez opened this issue Aug 30, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation Spring25 subscriptions

Comments

@PedroDiez
Copy link
Collaborator

PedroDiez commented Aug 30, 2024

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 - #273

@rartych
Copy link
Collaborator

rartych commented Oct 1, 2024

If we agree on API Design Guidelines cleanup: #306 then then link will change.

@rartych
Copy link
Collaborator

rartych commented Oct 25, 2024

Decided to be resolved together with #306

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 Spring25 subscriptions
Projects
None yet
Development

No branches or pull requests

3 participants