Skip to content

Commit 9e3ffaa

Browse files
jrodewigjrodewig
authored
[DOCS] Fix title abbrevs for API docs (#68118) (#68122)
1 parent 68bfa48 commit 9e3ffaa

12 files changed

+38
-2
lines changed

‎docs/reference/search/count.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[search-count]]
22
=== Count API
3+
++++
4+
<titleabbrev>Count</titleabbrev>
5+
++++
36

47
Gets the number of matches for a search query.
58

‎docs/reference/search/explain.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[search-explain]]
22
=== Explain API
3+
++++
4+
<titleabbrev>Explain</titleabbrev>
5+
++++
36

47
Returns information about why a specific document matches (or doesn't match) a
58
query.

‎docs/reference/search/profile.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[search-profile]]
22
=== Profile API
3+
++++
4+
<titleabbrev>Profile</titleabbrev>
5+
++++
36

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

‎docs/reference/search/search-shards.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[search-shards]]
2-
=== Search Shards API
2+
=== Search shards API
3+
++++
4+
<titleabbrev>Search shards</titleabbrev>
5+
++++
36

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

‎docs/reference/search/validate.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[[search-validate]]
22
=== Validate API
3+
++++
4+
<titleabbrev>Validate</titleabbrev>
5+
++++
36

47
Validates a potentially expensive query without executing it.
58

‎x-pack/docs/en/rest-api/security/oidc-authenticate-api.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[role="xpack"]
22
[[security-api-oidc-authenticate]]
33
=== OpenID Connect authenticate API
4+
++++
5+
<titleabbrev>OpenID Connect authenticate</titleabbrev>
6+
++++
47

58
Submits the response to an oAuth 2.0 authentication request for consumption from
69
{es}. Upon successful validation, {es} will respond with an {es} internal Access

‎x-pack/docs/en/rest-api/security/oidc-logout-api.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[role="xpack"]
22
[[security-api-oidc-logout]]
33
=== OpenID Connect logout API
4+
++++
5+
<titleabbrev>OpenID Connect logout</titleabbrev>
6+
++++
47

58
Submits a request to invalidate a refresh token and an access token that was
69
generated as a response to a call to `/_security/oidc/authenticate`.

‎x-pack/docs/en/rest-api/security/oidc-prepare-authentication-api.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[role="xpack"]
22
[[security-api-oidc-prepare-authentication]]
3-
=== OpenID Connect Prepare Authentication API
3+
=== OpenID Connect prepare authentication API
4+
++++
5+
<titleabbrev>OpenID Connect prepare authentication</titleabbrev>
6+
++++
47

58
Creates an oAuth 2.0 authentication request as a URL string based on the
69
configuration of the respective OpenID Connect authentication realm in {es}.

‎x-pack/docs/en/rest-api/security/saml-authenticate-api.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[role="xpack"]
22
[[security-api-saml-authenticate]]
33
=== SAML authenticate API
4+
++++
5+
<titleabbrev>SAML authenticate</titleabbrev>
6+
++++
47

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

‎x-pack/docs/en/rest-api/security/saml-invalidate-api.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[role="xpack"]
22
[[security-api-saml-invalidate]]
33
=== SAML invalidate API
4+
++++
5+
<titleabbrev>SAML invalidate</titleabbrev>
6+
++++
47

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

‎x-pack/docs/en/rest-api/security/saml-logout-api.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[role="xpack"]
22
[[security-api-saml-logout]]
33
=== SAML logout API
4+
++++
5+
<titleabbrev>SAML logout</titleabbrev>
6+
++++
47

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

‎x-pack/docs/en/rest-api/security/saml-prepare-authentication-api.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[role="xpack"]
22
[[security-api-saml-prepare-authentication]]
33
=== SAML prepare authentication API
4+
++++
5+
<titleabbrev>SAML prepare authentication</titleabbrev>
6+
++++
47

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

0 commit comments

Comments
 (0)