Clarification on using multiple event types#477
Merged
rartych merged 7 commits intocamaraproject:mainfrom Jun 11, 2025
Merged
Conversation
2 tasks
Contributor
Author
|
Conflict resolved after changes in #475 |
bigludo7
reviewed
Jun 10, 2025
| | types | SubscriptionEventType | Type of event subscribed. This attribute **must** be present in the `POST` request. It is required by API project to provide an enum for this attribute. The event type must follow the format: `org.camaraproject.<api-name>.<event-version>.<event-name>` - see chapter [2.3. Event versioning](#23-event-versioning) - Note: An array of types could be passed **but as of now only one value MUST be passed**. Use of multiple value will be open later at API level. | mandatory | | ||
| | sink | string | The URL, to which event notifications shall be sent - `format: uri` should be used to require a string that is compliant with [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986). The URI-scheme shall be set according to the definition of the `protocol` value, e.g. the URI-scheme is `https` when `HTTP`is the value of the `protocol` property. The [security considerations](43#notifications-security-considerations) should be followed. | mandatory | | ||
| | sinkCredential | object | Sink credential provides authorization information necessary to enable delivery of events to a target. In order to be updated in future this object is polymorphic. See detail below. To protect the notification endpoint providing sinkCredential is RECOMMENDED. <br> The sinkCredential must **not** be present in `POST` and `GET` responses. | optional | | ||
| | types | SubscriptionEventType | Type of event subscribed. This attribute **must** be present in the `POST` request. It is rquired by API project to provide an enum for this attributee. The event type must follow the format: `org.camaraproject.<api-name>.<event-version>.<event-name>` - see chapter [2.3. Event versioning](#23-event-versioning) - Note: An array of types could be passed. The decision to use multiple event types in a single subscription will be made at the API level. | mandatory | |
Collaborator
There was a problem hiding this comment.
2 small miscues:
It is required by API project to provide an enum for this attribute
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
Clarification on using multiple event types in a single subscriptions.
Error 422 MULTIEVENT_COMBINATION_TEMPORARILY_NOT_SUPPORTED added to the
event-subscription-template.yamlWhich issue(s) this PR fixes:
Fixes #460
Does this PR introduce a breaking change?
Special notes for reviewers:
Changelog input