Skip to content

[7.10] [DOCS] Fix title abbrevs for API docs (#68118) #68122

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.

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

Merged
merged 1 commit into from
Jan 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/reference/search/count.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[search-count]]
=== Count API
++++
<titleabbrev>Count</titleabbrev>
++++

Gets the number of matches for a search query.

Expand Down
3 changes: 3 additions & 0 deletions docs/reference/search/explain.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[search-explain]]
=== Explain API
++++
<titleabbrev>Explain</titleabbrev>
++++

Returns information about why a specific document matches (or doesn't match) a
query.
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/search/profile.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[search-profile]]
=== Profile API
++++
<titleabbrev>Profile</titleabbrev>
++++

WARNING: The Profile API is a debugging tool and adds significant overhead to search execution.

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/search/search-shards.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[search-shards]]
=== Search Shards API
=== Search shards API
++++
<titleabbrev>Search shards</titleabbrev>
++++

Returns the indices and shards that a search request would be executed against.

Expand Down
3 changes: 3 additions & 0 deletions docs/reference/search/validate.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[search-validate]]
=== Validate API
++++
<titleabbrev>Validate</titleabbrev>
++++

Validates a potentially expensive query without executing it.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[role="xpack"]
[[security-api-oidc-authenticate]]
=== OpenID Connect authenticate API
++++
<titleabbrev>OpenID Connect authenticate</titleabbrev>
++++

Submits the response to an oAuth 2.0 authentication request for consumption from
{es}. Upon successful validation, {es} will respond with an {es} internal Access
Expand Down
3 changes: 3 additions & 0 deletions x-pack/docs/en/rest-api/security/oidc-logout-api.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[role="xpack"]
[[security-api-oidc-logout]]
=== OpenID Connect logout API
++++
<titleabbrev>OpenID Connect logout</titleabbrev>
++++

Submits a request to invalidate a refresh token and an access token that was
generated as a response to a call to `/_security/oidc/authenticate`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[role="xpack"]
[[security-api-oidc-prepare-authentication]]
=== OpenID Connect Prepare Authentication API
=== OpenID Connect prepare authentication API
++++
<titleabbrev>OpenID Connect prepare authentication</titleabbrev>
++++

Creates an oAuth 2.0 authentication request as a URL string based on the
configuration of the respective OpenID Connect authentication realm in {es}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[role="xpack"]
[[security-api-saml-authenticate]]
=== SAML authenticate API
++++
<titleabbrev>SAML authenticate</titleabbrev>
++++

Submits a SAML `Response` message to {es} for consumption.

Expand Down
3 changes: 3 additions & 0 deletions x-pack/docs/en/rest-api/security/saml-invalidate-api.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[role="xpack"]
[[security-api-saml-invalidate]]
=== SAML invalidate API
++++
<titleabbrev>SAML invalidate</titleabbrev>
++++

Submits a SAML LogoutRequest message to {es} for consumption.

Expand Down
3 changes: 3 additions & 0 deletions x-pack/docs/en/rest-api/security/saml-logout-api.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[role="xpack"]
[[security-api-saml-logout]]
=== SAML logout API
++++
<titleabbrev>SAML logout</titleabbrev>
++++

Submits a request to invalidate an access token and refresh token.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[role="xpack"]
[[security-api-saml-prepare-authentication]]
=== SAML prepare authentication API
++++
<titleabbrev>SAML prepare authentication</titleabbrev>
++++

Creates a SAML authentication request (`<AuthnRequest>`) as a URL string, based on the configuration of the respective SAML realm in {es}.

Expand Down