[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs #195333
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
Feature:Security/Spaces
lcawl
changed the title
Co-authored-by: Elena Shostak <[email protected]>
Co-authored-by: Elena Shostak <[email protected]>
…y_url_aliases.ts Co-authored-by: Elena Shostak <[email protected]>
Co-authored-by: Elena Shostak <[email protected]>
Co-authored-by: Elena Shostak <[email protected]>
Generally OpenAPI documents support markdown per https://spec.openapis.org/oas/v3.0.3#rich-text-formatting. I haven't tried adding links within the automatically-generated content yet, in part because things are still moving around enough that I think link breakages would occur a lot right now and we don't have any sort of link checking set up yet. In the longer term, particularly when it comes to linking from API docs to our other guides, I'm thinking externalDocs would potentially give us more options for keeping those URLs up-to-date and version-specific. |
💚 Build Succeeded
Metrics [docs]
History
|
elena-shostak
approved these changes
Oct 18, 2024
|
Starting backport for target branches: 8.16, 8.x |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Oct 18, 2024
… APIs (elastic#195333) Co-authored-by: Elena Shostak <[email protected]> (cherry picked from commit 2656e5a)
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Oct 18, 2024
… APIs (elastic#195333) Co-authored-by: Elena Shostak <[email protected]> (cherry picked from commit 2656e5a)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Oct 18, 2024
…r space APIs (#195333) (#196943) # Backport This will backport the following commits from `main` to `8.16`: - [[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333)](#195333) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-18T19:03:06Z","message":"[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333)\n\nCo-authored-by: Elena Shostak <[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Security/Spaces","release_note:skip","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"title":"[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs","number":195333,"url":"https://github.com/elastic/kibana/pull/195333","mergeCommit":{"message":"[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333)\n\nCo-authored-by: Elena Shostak <[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195333","number":195333,"mergeCommit":{"message":"[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333)\n\nCo-authored-by: Elena Shostak <[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Lisa Cawley <[email protected]>
kibanamachine
added a commit
that referenced
this pull request
Oct 18, 2024
… space APIs (#195333) (#196944) # Backport This will backport the following commits from `main` to `8.x`: - [[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333)](#195333) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-18T19:03:06Z","message":"[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333)\n\nCo-authored-by: Elena Shostak <[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Security/Spaces","release_note:skip","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"title":"[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs","number":195333,"url":"https://github.com/elastic/kibana/pull/195333","mergeCommit":{"message":"[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333)\n\nCo-authored-by: Elena Shostak <[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195333","number":195333,"mergeCommit":{"message":"[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333)\n\nCo-authored-by: Elena Shostak <[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Lisa Cawley <[email protected]>
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 #192153
This PR copies descriptions and response codes from the old spaces API docs into the automated OpenAPI document. It also adds some missing operation tags and summaries. Since per #188926 examples aren't integrated into the automated documents yet, I've added them via overlays.
It also removes the old API docs and creates temporary redirects until links can be cleaned out of the entire library. The multi-step example from the update saved object spaces API page is moved to the "managing saved objects" page. Preview: https://kibana_bk_195333.docs-preview.app.elstc.co/guide/en/kibana/master/managing-saved-objects.html#managing-saved-objects-share-to-space