Add open API specification for find connector #133840
Conversation
lcawl
added
release_note:skip
|
Pinging @elastic/response-ops (Team:ResponseOps) |
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
| @@ -31,7 +31,8 @@ | |||
| "paths": { | |||
| "/api/cases": { | |||
| "post": { | |||
| "description": "Creates a case. You must have all privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the case you're creating.\n", | |||
| "summary": "Creates a case.", | |||
There was a problem hiding this comment.
Just curious, are these auto generated by the paths yaml files?
There was a problem hiding this comment.
For now, they're generated using the npx commands in https://github.com/elastic/kibana/blob/main/x-pack/plugins/cases/docs/openapi/README.md
The goal is to ultimately render them in the new documentation system, but for now the simplest method is to import it in a tool like SwaggerHub |
💛 Build succeeded, but was flakyFailed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: |
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
(cherry picked from commit 4eda70e)
(cherry picked from commit 4eda70e) Co-authored-by: Lisa Cawley <[email protected]>
Summary
Relates to #133345
This PR copies the layout used in https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/openapi to model the following APIs:
https://www.elastic.co/guide/en/kibana/master/cases-api-find-connectors.html
It also adds a "summary" property for each operation, since that enables us to separate the short summary text from the longer description.