feat: add implicit-subscription API template#612
Merged
rartych merged 3 commits intocamaraproject:mainfrom Apr 21, 2026
Merged
Conversation
Adds sample-implicit-events.yaml under artifacts/api-templates/ as the canonical template for CAMARA APIs that deliver event notifications via OpenAPI callbacks on a resource-creation operation, with no dedicated /subscriptions sub-API (implicit-subscription pattern). Follows the post-camaraproject#604 layered event-schema architecture: pure CloudEvent envelope referenced from CAMARA_event_common.yaml, local ApiNotificationEvent that constrains type via ApiEventType and owns the discriminator mapping, concrete event schemas extending ApiNotificationEvent. Companion documentation update to CAMARA-API-Event-Subscription-and-Notification-Guide.md is deferred to a follow-up commit to avoid conflicts with camaraproject#606 doc edits.
2 tasks
…#608) Add a reference to the new implicit-subscription template in README.md (under artifacts/api-templates) and in section 2.1 of the Event Guide, paralleling the existing section 2.2 reference to sample-service-subscriptions.yaml.
hdamker
requested review from
PedroDiez,
eric-murray,
jlurien,
patrice-conil and
rartych
as code owners
eric-murray
approved these changes
Apr 20, 2026
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:
Adds
artifacts/api-templates/sample-implicit-events.yamlas the canonical template for the implicit-subscription pattern: event notifications via OpenAPIcallbacks:on a resource-creation operation, with no dedicated/subscriptionssub-API. Complementssample-service-subscriptions.yaml(explicit-subscription) andsample-service.yaml(request-response).Event schema layering follows the post-#604 model:
CloudEvent$ref'd fromCAMARA_event_common.yaml, a localApiNotificationEventconstrainstypeviaApiEventTypeand owns the discriminator mapping. NoSubscriptionLifecycleEventgroup — the implicit pattern has no subscription object.Also adds a template bullet under
artifacts/api-templatesinREADME.mdand an artifact pointer in section 2.1 of the Event Subscription and Notification Guide, paralleling the existing section-2.2 reference tosample-service-subscriptions.yaml.Validated on
camaraproject/ReleaseTestvia ReleaseTest#71: the template was added there as a third sample API. It passes the CAMARA validation framework v1-rc pipeline with no errors and no warnings — only the expected hints shared with the other sample APIs.Which issue(s) this PR fixes:
Fixes #608
Does this PR introduce a breaking change?
Special notes for reviewers:
3 files changed: the new template (394 lines) plus two small doc touches
(+1 line in
README.md, +2 lines in section 2.1 of the Event Guide).Changelog input
Additional documentation
This section can be blank.