Skip to content

[Ingest Manager] Split up OpenAPI spec file #80107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Oct 13, 2020
Merged

[Ingest Manager] Split up OpenAPI spec file #80107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
98bc067
split spec into many yaml files
Oct 9, 2020
e3ef143
Remove examples & re-bundle
Oct 9, 2020
7ea645d
Fix spec error for param
Oct 9, 2020
3cef9a7
snake_case files
Oct 9, 2020
4bb5f91
snake_case files
Oct 9, 2020
66c8c5e
snake_case files
Oct 9, 2020
87f0503
Add JSON version of bundle
Oct 9, 2020
ed3e554
Remove a stray example. Re-bundle
Oct 9, 2020
4ab1037
Undo entrypoint path param renames
Oct 10, 2020
f85bcc3
delete spec_oas3.json. Use bundled.json now
Oct 10, 2020
fa17d4f
snake_case components/parameters/* files
Oct 10, 2020
4f77965
rename(?) schemas/agent.y aml
Oct 10, 2020
dff3067
Drop leading fleet from paths & files
Oct 12, 2020
b4874ca
Add README.md files in `openapi` root, `components`, and `paths` folders
Oct 12, 2020
236e326
Move & rename xsrf header spec file
Oct 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions x-pack/plugins/ingest_manager/common/openapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## The `openapi` folder

* `entrypoint.yaml` is the overview file which links to the various files on disk.
* `bundled.{yaml,json}` is the resolved output of that entry & other files in a single file. It's currently generated with:

```
npx swagger-cli bundle -o bundled.json -t json entrypoint.yaml
npx swagger-cli bundle -o bundled.yaml -t yaml entrypoint.yaml
```
* [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

Loading