[DOCS] Automate docs for create/update/delete case APIs #142929
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Documentation preview: |
lcawl
added
Team:ResponseOps
|
Pinging @elastic/response-ops (Team:ResponseOps) |
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
x-pack/plugins/cases/docs/openapi/components/schemas/connector_properties_resilient.yaml
Show resolved
Hide resolved
x-pack/plugins/cases/docs/openapi/components/schemas/connector_properties_servicenow_sir.yaml
Show resolved
Hide resolved
x-pack/plugins/cases/docs/openapi/components/schemas/create_case_request.yaml
Outdated
Show resolved
Hide resolved
x-pack/plugins/cases/docs/openapi/components/schemas/update_case_connector_cases_webhook.yaml
Outdated
Show resolved
Hide resolved
jonathan-buttner
approved these changes
Oct 17, 2022
💚 Build Succeeded
Metrics [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 |
lcawl
added a commit
to lcawl/kibana
that referenced
this pull request
Oct 20, 2022
(cherry picked from commit f92c76c)
lcawl
added a commit
that referenced
this pull request
Oct 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to #137240
This PR uses the open API v3 specification (OAS) to generate output for the "create case", "update case", and "delete case" APIs. It takes output from the open-api generator, in particular the HTML generator, applies a custom template and uses that output in a passthrough block in an appendix in the Kibana Guide.
A notable change to the existing OAS is that I've used "oneOf" to make it clear that the create/update case API request bodies vary depending on the connector type.