[Doc] Add doc pages for cross-cluter API key APIs#96415
Merged
ywangd merged 5 commits intoelastic:mainfrom Jun 8, 2023
Merged
Conversation
This PR adds API doc pages for the new create and update cross-cluster API key APIs. Relates: elastic#95714, elastic#96085
Contributor
|
Documentation preview: |
ywangd
commented
May 30, 2023
| ++++ | ||
|
|
||
| TODO: Placeholder | ||
| Creates an API key of the `cross_cluster` type for the API key based remote cluster access. |
Member
Author
There was a problem hiding this comment.
Once we add relevant docs for "API key based remote cluster model", we can link to it from here to give more context. For now, this remains to be just plain text.
ywangd
commented
May 30, 2023
Comment on lines
+39
to
+40
| } else { | ||
| systemProperty 'tests.rest.blacklist', ['*/create-cross-cluster-api-key/*', '*/update-cross-cluster-api-key/*'] |
Member
Author
There was a problem hiding this comment.
Skip the new pages for doc test in release build since they are still behind feature flag.
ywangd
added
>docs
elasticsearchmachine
added
Team:Docs
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
Collaborator
|
Pinging @elastic/es-security (Team:Security) |
alaudazzi
approved these changes
Jun 6, 2023
Contributor
alaudazzi
left a comment
alaudazzi
left a comment
There was a problem hiding this comment.
Left a few editing suggestions, otherwise LGTM.
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
x-pack/docs/en/rest-api/security/create-cross-cluster-api-key.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
…asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Member
Author
|
@elasticmachine update branch |
elasticsearchmachine
pushed a commit
that referenced
this pull request
Jul 24, 2023
ywangd
added a commit
to ywangd/elasticsearch
that referenced
this pull request
Jul 24, 2023
The syntax requires a comma separated string instead of a list. Relates: elastic#96415 Resolves: elastic#97871
elasticsearchmachine
pushed a commit
that referenced
this pull request
Jul 24, 2023
jrodewig
pushed a commit
that referenced
this pull request
Jul 24, 2023
Relates to elastic/docs#2722, #96415 This PR provides a work-around for the following doc build broken links: ``` 13:40:21 INFO:build_docs:Bad cross-document links: 13:40:21 INFO:build_docs: /tmp/docsbuild/target_repo/html/en/elasticsearch/client/javascript-api/8.9/api-reference.html contains broken links to: 13:40:21 INFO:build_docs: - en/elasticsearch/reference/8.9/security-api-create-cross-cluster-api-key.html 13:40:21 INFO:build_docs: - en/elasticsearch/reference/8.9/security-api-update-cross-cluster-api-key.html 13:40:21 INFO:build_docs: /tmp/docsbuild/target_repo/html/en/elasticsearch/client/javascript-api/current/api-reference.html contains broken links to: 13:40:21 INFO:build_docs: - en/elasticsearch/reference/8.9/security-api-create-cross-cluster-api-key.html 13:40:21 INFO:build_docs: - en/elasticsearch/reference/8.9/security-api-update-cross-cluster-api-key.html ```
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR adds API doc pages for the new create and update cross-cluster API key APIs.
Relates: #95714, #96085