Refactor configuration schema in CAMARA_event_common.yaml #670
Draft
rartych wants to merge 4 commits into
Draft
Conversation
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.
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
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:
Applied the
Config→ConfigBaserefactor across the Commonalities repo:artifacts/common/CAMARA_event_common.yaml— RenamedConfigtoConfigBase, removed the requiredsubscriptionDetailproperty and its internal$ref, removed the now-unusedCreateSubscriptionDetailstub.artifacts/api-templates/sample-service-subscriptions.yaml— Added a locally-definedConfigschema that extendsConfigBaseviaallOfand adds the requiredsubscriptionDetail(typed against a newly added localCreateSubscriptionDetailstub). Updated the twoconfig:property refs (inSubscriptionRequestandSubscription) to point to the local#/components/schemas/Configinstead of the common file.documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md— Added a note under theconfigattributes table explaining theConfigBase/Configsplit and showing theallOfpattern 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?
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.