Skip to content

feat: adds information about overlay and comments in descriptions #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
baywet merged 2 commits into from
Oct 31, 2025
Merged

feat: adds information about overlay and comments in descriptions #213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75f6db8
feat: adds information about overlay and comments in descriptions
baywet Oct 31, 2025
088fc1a
Merge branch 'main' into feat/comments-appendix
ralfhandl Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions versions/1.1.0-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,10 @@ The extensions may or may not be supported by the available tooling, but those m
Overlay files MAY choose to follow the convention of a `purpose.overlay.yaml` file naming pattern.
Other file naming conventions are also supported.

### Comments in OpenAPI descriptions

Some formats, like [YAML](https://yaml.org/) or [JSONC](https://jsonc.org/), support using comments which do not impact the semantic meaning of the description. Applying Overlay Actions to a description MAY result in the loss of such comments in the updated description. The exact behavior is specific to the tool implementing the Overlay Specification.

## Appendix A: Revision History

| Version | Date | Notes |
Expand Down