https://github.com/OAI/Overlay-Specification

The OAI Overlay Specification
https://github.com/OAI/Overlay-Specification

Last synced: 8 days ago
JSON representation

The OAI Overlay Specification

• Host: GitHub
• URL: https://github.com/OAI/Overlay-Specification
• Owner: OAI
• License: apache-2.0
• Created: 2021-04-20T15:32:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-18T13:30:05.000Z (26 days ago)
• Last Synced: 2024-10-29T15:31:46.284Z (15 days ago)
• Language: JavaScript
• Homepage:
• Size: 116 KB
• Stars: 52
• Watchers: 22
• Forks: 14
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Overlay Specification

The [Overlay Specification](https://spec.openapis.org/overlay/latest.html) defines a document format for information that augments an existing OpenAPI description yet remains separate from the OpenAPI description's source document(s).

This specification is a community-driven, open specification within the [OpenAPI Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project.

Overlays support a range of scenarios, including:

- Translating documentation into another language

- Providing configuration information for different deployment environments

- Allowing separation of concerns for metadata such as gateway configuration or SLA information

- Supporting a traits-like capability for applying a set of configuration data, such as multiple parameters or multiple headers, for targeted objects

- Providing default responses or parameters where they were not explicitly provided

- Applying configuration data globally or based on filter conditions

## Tools that Support Overlays

If you are looking for tools to use with Overlays, try these:

- [Bump.sh CLI](https://github.com/bump-sh/cli)

- [Speakeasy CLI](https://www.speakeasy.com/docs/speakeasy-cli/getting-started)

- [overlays-js](https://github.com/lornajane/openapi-overlays-js)

- [apigee-go-gen CLI](https://apigee.github.io/apigee-go-gen/transform/commands/oas-overlay/)

(Is something missing from the list? Send us a pull request to add it!)

## Licensing

See: [License (Apache-2.0)](./LICENSE)