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

Remove reference to protocol in sink description #338

Closed
jlurien opened this issue Aug 9, 2024 · 3 comments
Closed

Remove reference to protocol in sink description #338

jlurien opened this issue Aug 9, 2024 · 3 comments
Assignees
Labels
correction correction in documentation or alignment with commonalities Fall24 Relevant for maintenance of Fall24 release

Comments

@jlurien
Copy link
Collaborator

jlurien commented Aug 9, 2024

Problem description

sink description includes a reference to the "selected protocol" but we are not including the protocol property

Expected behavior

Remove that reference or indicate explicitly that it must be HTTP:

"The address to which events shall be delivered using the selected protocol." -> "The address to which events shall be delivered." or "The address to which events shall be delivered, using the "HTTP" protocol."

Alternative solution

Add the protocol property as in the artifact to be prepared in the future to allow protocols other than HTTP, but this could be done in a future release. In this case it would be better to group all related properties under a new object, e.g. "notifications: { sink, sinkCredential, protocol, etc } and probably it would be good to indicate the model for implicit subscriptions more clearly in the guidelines.

Additional context

We may add the description fix to the PR #336, make a separate PR, merge it and then rebranch PR #336, or wait for rc.2

@jlurien jlurien added the correction correction in documentation or alignment with commonalities label Aug 9, 2024
@jlurien
Copy link
Collaborator Author

jlurien commented Aug 9, 2024

@hdamker for your consideration

@hdamker hdamker mentioned this issue Aug 9, 2024
5 tasks
@hdamker hdamker self-assigned this Aug 9, 2024
@hdamker hdamker added the Fall24 Relevant for maintenance of Fall24 release label Aug 9, 2024
@hdamker
Copy link
Collaborator

hdamker commented Aug 9, 2024

@jlurien Within quality-on-demand we had addressed that already in #335. Have done now the alignment of the sink description between quality-on-demand and qod-provisioning within #336 and updated the PR description.

@hdamker
Copy link
Collaborator

hdamker commented Aug 9, 2024

Fixed in #336

@hdamker hdamker closed this as completed Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation or alignment with commonalities Fall24 Relevant for maintenance of Fall24 release
Projects
None yet
Development

No branches or pull requests

2 participants