-
Notifications
You must be signed in to change notification settings - Fork 28
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
Update event-subscription-template.yaml: Attribute startsAt set optional, info and servers object, sinkCredential description #267
Conversation
In Subscription Request description moved to SinkCredential schema; as it is generic enough to be reused in the 2 $ref to this schema, and the allOf removed.
@rartych initial comment. It is also needed to update https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#121-subscription Suggestion: CLARIFICATION about my comment: Avoiding the use of "ACTIVE" status wording as in MetaRelease v0.4 the implementation of STATUS is optional |
As Cloudevents Subscriptions OpenAPI was used for the template, it defines 2 components: The rationale for changing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 626: terminationDescription
needs a description
to avoid a spectral linter warning
Line 453: Spectral warning, " |
Let's discuss this attribute within #243 |
'Event-typeNotification' changed to 'EventTypeNotification'
It is fine to wait to Ludovic for the API design guidelines, and fine to have for final Commonalities Release v0.4.0. Indeed i like more your proposal Rafal for the wording:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Corrected by rartych@52d754e |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/LGTM
What type of PR is this?
What this PR does / why we need it:
Attribute startsAt is optional in API Design Guidelines, so it should be in event subscription template file .
Corrections made in
info
andservers
object according to API Design Guidelines.In SubscriptionRequest description moved to SinkCredential schema; as it is generic enough to be reused in the 2 $ref to this schema, and the allOf above removed.
Which issue(s) this PR fixes:
Fixes #262 #271
Special notes for reviewers:
Changelog input