Skip to content

Commit

Permalink
Some edits to READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
John Schulz committed Sep 14, 2020
1 parent a6da8cd commit 63f9354
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
11 changes: 7 additions & 4 deletions x-pack/plugins/ingest_manager/common/openapi/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
## The `openapi` folder

This folder contains your entrypoint `openapi.yaml`.
* `spec_entry.json` is the version which links to the various files on disk.
* `spec_bundled.json` is the resolved output of that entry & other files in one file. It's currently generated with

That file contains references to the entire API definition.

* [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method.
`npx swagger-cli bundle spec_entry.json -o spec_bundled.json`
* [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method.
* [Components](components/README.md): Reusable components like [`schemas`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject),
[`responses`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject)
[`parameters`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject), etc
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Reusable components
- `parameters` - reusable [Parameter Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject)
- `examples` - reusable [Example Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject)
- `headers` - reusable [Header Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#headerObject)
- `requestBodies` - reusable [Request Body Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject)
- `request_bodies` - reusable [Request Body Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject)
- `links` - reusable [Link Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#linkObject)
- `callbacks` - reusable [Callback Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#callbackObject)
- `securitySchemes` - reusable [Security Scheme Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#securitySchemeObject)
- `security_schemes` - reusable [Security Scheme Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#securitySchemeObject)
* Filename of files inside the folders represent component name, e.g. `Customer.yaml`

0 comments on commit 63f9354

Please sign in to comment.