Skip to content

Commit 6401805

Browse files
committed
Add some starter information in the README file
1 parent 983116b commit 6401805

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Overlays for OpenAPI
2+
3+
This NodeJS library is an implementation of the in-progress [OpenAPI Overlays Specification](https://github.com/OAI/Overlay-Specification/blob/main/versions/1.0.0.md). It assumes a switch from JMESPath to JSONPath, which can be found [in this pull request](https://github.com/OAI/Overlay-Specification/pull/18).
4+
5+
## About Overlays
6+
7+
Overlays are a way to extend or enhance an existing [OpenAPI description](https://www.openapis.org/) by adding, updating or removing fields. For example:
8+
9+
* The OpenAPI description lives in the codebase, but your tech writers need to add examples and information before documentation is produced.
10+
* Your organisation uses OpenAPI but it's generated from code, and needs amendments or additions to be useful to users.
11+
* You're using other tools such as API client generators, that can make use of additional context added to the API description, such as tags to remove certain endpoints, which aren't in the main API description file.
12+
13+
**By using Overlays to describe and apply the changes, when the API description is updated, the same changes can instantly be re-applied.**
14+
15+
## Installation
16+
17+
This project isn't published as a package yet, so:
18+
19+
* Clone this repo
20+
* Run `npm install` to get the dependencies
21+
* Run `npm install -g` to get `overlayjs` as a command
22+
23+
> **Pro-tip:** you can also use `node index.js` from the root of the project if you don't want to install a global command.
24+
25+
## Usage
26+
27+
Example: `overlayjs --openapi openapi.yml --overlay add-sparkle.yaml`
28+
29+
Use `overlayjs --help` to see the usage information.
30+
31+
## Project status
32+
33+
This project is very much at idea stage but feedback, comments and questions are all very welcome as issues on this repository - and pull requests are also gratefully received. It would be excellent to hear what problem this tool can solve, and how you get on with it. Bonus points if you can share examples (working or broken) of what you tried.
34+
35+
:warning: please be aware that absolutely anything may change at any time, it would probably be safest to pin to a specific commit for now.

0 commit comments

Comments
 (0)