Skip to content

Refactor configuration schema in CAMARA_event_common.yaml #670

Draft
rartych wants to merge 4 commits into
camaraproject:mainfrom
rartych:Config-fix
Draft

Refactor configuration schema in CAMARA_event_common.yaml #670
rartych wants to merge 4 commits into
camaraproject:mainfrom
rartych:Config-fix

Conversation

@rartych

@rartych rartych commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • correction

What this PR does / why we need it:

Applied the ConfigConfigBase refactor across the Commonalities repo:

  1. artifacts/common/CAMARA_event_common.yaml — Renamed Config to ConfigBase, removed the required subscriptionDetail property and its internal $ref, removed the now-unused CreateSubscriptionDetail stub.

  2. artifacts/api-templates/sample-service-subscriptions.yaml — Added a locally-defined Config schema that extends ConfigBase via allOf and adds the required subscriptionDetail (typed against a newly added local CreateSubscriptionDetail stub). Updated the two config: property refs (in SubscriptionRequest and Subscription) to point to the local #/components/schemas/Config instead of the common file.

  3. documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md — Added a note under the config attributes table explaining the ConfigBase/Config split and showing the allOf pattern API projects must follow, with a pointer to the updated template.

Which issue(s) this PR fixes:

Fixes #659

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

Changelog input

Refactored configuration schema in CAMARA_event_common.yaml 

Additional documentation

This section can be blank.

docs

rartych added 4 commits July 12, 2026 06:56
Renamed Config to ConfigBase and updated its description. Removed CreateSubscriptionDetail schema definition.
Added API-specific Config schema with subscriptionDetail.
 Added details on the config schema split and how to define the Config schema in API projects.
Updated references to Config and SubscriptionId schemas to use local definitions instead of external files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Config schema in CAMARA_event_common.yaml cannot be reused via $ref across API definitions

1 participant