[DOCS] Automate final case APIs #145007
Merged
[DOCS] Automate final case APIs #145007
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
lcawl
added
Team:ResponseOps
|
Documentation preview: |
|
Pinging @elastic/response-ops (Team:ResponseOps) |
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
cnasikas
reviewed
Nov 14, 2022
| @@ -1,5 +1,7 @@ | |||
| type: object | |||
| properties: | |||
| assignees: | |||
There was a problem hiding this comment.
The assignees property is optional (as the severity). Is this captured in theassignees.yaml file?
There was a problem hiding this comment.
All properties are assumed to be optional in an object; if there are required properties, we'd need to add a "required" list per https://swagger.io/docs/specification/data-models/data-types/#object
There was a problem hiding this comment.
I see. Thanks, Lisa! Should we put the title, the description, etc on the "required" list?
cnasikas
approved these changes
Nov 14, 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 failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
jloleysens
added a commit
to jloleysens/kibana
that referenced
this pull request
Nov 15, 2022
* main: (65 commits) Migrate server-side `Root` and `Server` to packages (elastic#144990) [Discover] Handle no data views state for `esQuery` alert (elastic#145052) [ML] Allow updates for number of allocations and priority for trained model deployments (elastic#144704) [api-docs] 2022-11-15 Daily api_docs build (elastic#145203) [Security solution] remove guided onboarding feature flag (elastic#144247) [DOCS] Automate final case APIs (elastic#145007) [Enterprise Search] Name and description flyout for connectors (elastic#143827) [Guided onboarding] Update header button logic (elastic#144634) [Lens] Multi metric partition charts (elastic#143966) [Dashboard] [Controls] Add unmapped runtime field support to options list (elastic#144947) [Security Solution] Add Task Metric Collection to New Tasks (elastic#145181) [TriggersActionsUi] disable jest config in CI (elastic#145186) [TableListView] Enhance tag filtering (elastic#142108) [Cloud Posture] Compliance by CIS section table (elastic#145114) [8.6][Session View] Fix hidden alert flyout in session view (elastic#145141) [customIntegrations] async load all components (elastic#145166) Fix time for logs smoke tests in integration test (elastic#145130) [RAM] Update rule status (elastic#140882) Update babel (main) (elastic#145060) [Actionable Observability] Add context.alertDetailsUrl variable to action connector template for APM rule types (elastic#144791) ...
lcawl
added a commit
to lcawl/kibana
that referenced
this pull request
Nov 15, 2022
(cherry picked from commit 5348e39)
💚 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 15, 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.
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.
The changes to the specification are as follows:
assignees.yamlfile to be re-used across multiple endpointsuser_properties.yamlThis PR also removes the -min. temporary files, since we've now completed the full set of case APIs.