docs: add extensibility and forward compatibility guidelines#290
Open
gsmith85 wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
Open
docs: add extensibility and forward compatibility guidelines#290gsmith85 wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
gsmith85 wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
Conversation
- Added "Extensibility and Forward Compatibility" section to the schema authoring guide. - Defined standards for Open vs. Closed Enumerations to prevent breaking changes in code-generated clients. - Added guidance on avoiding 'additionalProperties: false' to ensure forward compatibility for objects. - Clarified the impact of modern code generators (e.g., Quicktype) on schema-to-type validation. - Updated the comprehensive capability schema example to align with these new extensibility rules.
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.
Description
Re: #244 (comment), 040684c
Type of change
Please delete options that are not relevant.
functionality to not work as expected, including removal of schema files
or fields)
Checklist