OAI / OAI/Overlay-Specification
Overlay scenarios
Open
@darrelmiller is already working on this.
Since Apr 10, 2021.
enhancement
help wanted
- Dominant language
- JavaScript
- Stars
- 121
- Forks
- 38
- Avg merge
- 53m
- Merged PRs (30d)
- 6
Description
Scenarios
[Emmanuel]
Adding a big chunk of OpenAPI (e.g. adding a path)
Adding beta methods
Adding vertical specific annotations
Is language translation a viable scenario for overlays?
[Ron]
Multiple environments (prod/test/staging)
[Jonathan]
Is our current solution too complex?
[Darrel]
Is versioning a scenario for overlays?
[Mike]
Annotating/extending OAS documents created from code or other API description formats
Removing private or sunsetted elements
Bulk document updates (i.e. where the overlay document is transient and generated from a UI/CLI)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.