Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.43 KB
Raw

Contribute to the OpenAPI Overlay Specification

We welcome contributions and discussion. Bug reports and feature requests are welcome, please add an issue explaining your use case. Pull requests are also welcome, but it is recommended to create an issue first, to allow discussion.

Questions and comments are also welcome - use the GitHub Discussions feature. You will also find notes from past meetings in the Discussion tab.

Build the HTML version to publish

We use ReSpec to render the markdown specification as HTML for publishing and easier reading. These instructions explain how you can build the HTML locally.

You will need NodeJS 18 or later.

Install dependencies:

npm install

Produce stand-alone HTML files in the local deploy/overlay folder:

npm run build

Note that Linux users may need to add --no-sandbox to run npx respec as found in the scripts/md2html/build.sh file.

Style guide for Overlay Specification

Some terminology and when to use it:

  • Overlay Specification - https://spec.openapis.org/overlay/latest.html , the full specification document.
  • Overlay - a file containing Overlay specification content, that can be overlaid onto an OpenAPI description. (Note: "Overlay" is a noun, unlike OpenAPI where the file would be "OpenAPI description").
  • Overlays - more informal form, can refer to more than one Overlay, or to the general concept covered by the Overlay Specification.