Skip to content

Commit 09afa6b

Browse files
authored
Merge pull request #213 from baywet/feat/comments-appendix
feat: adds information about overlay and comments in descriptions
2 parents c1ba33a + 088fc1a commit 09afa6b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

versions/1.1.0-dev.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,10 @@ The extensions may or may not be supported by the available tooling, but those m
282282
Overlay files MAY choose to follow the convention of a `purpose.overlay.yaml` file naming pattern.
283283
Other file naming conventions are also supported.
284284

285+
### Comments in OpenAPI descriptions
286+
287+
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.
288+
285289
## Appendix A: Revision History
286290

287291
| Version | Date | Notes |

0 commit comments

Comments
 (0)