Skip to content

Commit

Permalink
[Fleet] Improve OpenAPI accuracy and validity (#105679) (#105781)
Browse files Browse the repository at this point in the history
* Improve schema from object to $ref

* Add description and response schema for /agent-status endpoint

* Remove code related to removed /install/:os endpoint

* Add response schemas for enrollment-api-key operations

* Add response schemas for /agents/:agentId

* Fix two security scheme names

* Change format for reference selectors

* Replace Ingest Manager with Fleet in OpenAPI spec

* Replace instances of Ingest Manager with Fleet

* Update instructions to create bundled specs

Co-authored-by: John Schulz <john.schulz@elastic.co>
  • Loading branch information
kibanamachine and John Schulz authored Jul 15, 2021
1 parent eb678a0 commit 9ce1b84
Show file tree
Hide file tree
Showing 22 changed files with 1,781 additions and 1,128 deletions.
4 changes: 2 additions & 2 deletions x-pack/plugins/fleet/common/openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ For example, online viewers for the specification like these:
* 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
npx @redocly/openapi-cli bundle --ext yaml --output bundled.yaml entrypoint.yaml
npx @redocly/openapi-cli bundle --ext json --output bundled.json 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),
Expand Down
Loading

0 comments on commit 9ce1b84

Please sign in to comment.