[DOCS] Automate docs for push case and case case config APIs #144657
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
docs
Feature:Cases
lcawl
changed the title
lcawl
changed the title
|
Pinging @elastic/response-ops (Team:ResponseOps) |
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
cnasikas
approved these changes
Nov 8, 2022
💚 Build Succeeded
Metrics [docs]Unknown metric groupsESLint disabled in files
ESLint disabled line counts
Total ESLint disabled count
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
that referenced
this pull request
Nov 8, 2022
…144657) (#144832) # Backport This will backport the following commits from `main` to `8.5`: - [[DOCS] Automate docs for push case and case case config APIs (#144657)](#144657) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2022-11-08T17:34:52Z","message":"[DOCS] Automate docs for push case and case case config APIs (#144657)","sha":"9bf262dd1c1660528e6388b8ae257c41d18c3884","branchLabelMapping":{"^v8.6.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:skip","Team:ResponseOps","docs","Feature:Cases","v8.6.0","v8.5.1"],"number":144657,"url":"https://github.com/elastic/kibana/pull/144657","mergeCommit":{"message":"[DOCS] Automate docs for push case and case case config APIs (#144657)","sha":"9bf262dd1c1660528e6388b8ae257c41d18c3884"}},"sourceBranch":"main","suggestedTargetBranches":["8.5"],"targetPullRequestStates":[{"branch":"main","label":"v8.6.0","labelRegex":"^v8.6.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/144657","number":144657,"mergeCommit":{"message":"[DOCS] Automate docs for push case and case case config APIs (#144657)","sha":"9bf262dd1c1660528e6388b8ae257c41d18c3884"}},{"branch":"8.5","label":"v8.5.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
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.
Summary
Relates to #137240
This PR uses the open API v3 specification (OAS) to generate output for the following 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 changed the request body in push case from
{}to a nullable object, since otherwise the open API generator returned this error: