Skip to content

[DOCS] Add stub docs for QueryApiKey API #76670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 18, 2021
Merged

[DOCS] Add stub docs for QueryApiKey API #76670

merged 1 commit into from
Aug 18, 2021

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Aug 18, 2021 •
edited
Loading

This PR addresses the following documentation build failure:

09:39:38 INFO:build_docs:Bad cross-document links:
09:39:38 INFO:build_docs: /tmp/docsbuild/target_repo/html/en/elasticsearch/client/javascript-api/7.x/api-reference.html contains broken links to:
09:39:38 INFO:build_docs: - en/elasticsearch/reference/7.x/security-api-query-api-key.html
09:39:38 INFO:build_docs: /tmp/docsbuild/target_repo/html/en/elasticsearch/client/javascript-api/current/api-reference.html contains broken links to:
09:39:38 INFO:build_docs: - en/elasticsearch/reference/7.x/security-api-query-api-key.html
09:39:38 INFO:build_docs: /tmp/docsbuild/target_repo/html/en/elasticsearch/client/javascript-api/master/api-reference.html contains broken links to:
09:39:38 INFO:build_docs: - en/elasticsearch/reference/master/security-api-query-api-key.html
09:39:51 runbld>>> <<<<<<<<<<<< SCRIPT EXECUTION END <<<<<<<<<<<<

It is related to a URL that was added to the rest api spec in #76238, but which won't exist until #76521 is merged. This PR creates a stop-gap stub of that page.

@lcawl lcawl added >docs General docs changes Team:Security Meta label for security team v7.15.0 :Security/Security Security issues without another label labels Aug 18, 2021
@lcawl lcawl marked this pull request as ready for review August 18, 2021 17:31
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Aug 18, 2021
@elasticmachine
Copy link
Collaborator

elasticmachine commented Aug 18, 2021

Pinging @elastic/es-security (Team:Security)

@elasticmachine
Copy link
Collaborator

elasticmachine commented Aug 18, 2021

Pinging @elastic/es-docs (Team:Docs)

@lcawl lcawl mentioned this pull request Aug 18, 2021
Merged
lockewritesdocs
lockewritesdocs approved these changes Aug 18, 2021
View reviewed changes
Copy link
Contributor

@lockewritesdocs lockewritesdocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lcawl!

@lcawl lcawl merged commit 1784805 into elastic:master Aug 18, 2021
@lcawl lcawl deleted the api-stub branch August 18, 2021 18:01
@ywangd ywangd mentioned this pull request Jul 8, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@lockewritesdocs lockewritesdocs lockewritesdocs approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

>docs General docs changes :Security/Security Security issues without another label Team:Docs Meta label for docs team Team:Security Meta label for security team v7.15.0 v8.0.0-alpha2

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@lcawl @elasticmachine @lockewritesdocs @jakelandis @elasticsearchmachine