瀏覽代碼

[DOCS] Fixes get settings and update settings security API docs (#105686)

* [DOCS] Fixes get settings and update settings security API docs.

* [DOCS] Further edits.
István Zoltán Szabó 1 年之前
父節點
當前提交
2d4a49af53

+ 2 - 0
docs/reference/rest-api/security.asciidoc

@@ -12,6 +12,8 @@ Use the following APIs to perform security activities.
 * <<security-api-has-privileges>>
 * <<security-api-ssl>>
 * <<security-api-get-builtin-privileges>>
+* <<security-api-get-settings>>
+* <<security-api-update-settings>>
 * <<security-api-get-user-privileges>>
 
 [discrete]

+ 8 - 1
docs/reference/rest-api/security/get-settings.asciidoc

@@ -5,6 +5,8 @@
 <titleabbrev>Get Security settings</titleabbrev>
 ++++
 
+Retrieves settings for the security internal indices.
+
 [[security-api-get-settings-prereqs]]
 ==== {api-prereq-title}
 
@@ -14,11 +16,16 @@
 ==== {api-description-title}
 This API allows a user to retrieve the user-configurable settings for the 
 Security internal index (`.security` and associated indices). Only a subset of 
-the index settings — those that are user-configurable—will be shown. This includes:
+the index settings — those that are user-configurable—will be shown. This
+includes:
 
 - `index.auto_expand_replicas`
 - `index.number_of_replicas`
 
+
+[[security-api-get-settings-example]]
+==== {api-examples-title}
+
 An example of retrieving the security settings:
 
 [source,console]

+ 24 - 15
docs/reference/rest-api/security/update-settings.asciidoc

@@ -5,11 +5,31 @@
 <titleabbrev>Update Security settings</titleabbrev>
 ++++
 
+Updates the settings of the security internal indices.
+
+
 [[security-api-update-settings-prereqs]]
 ==== {api-prereq-title}
 
 * To use this API, you must have at least the `manage_security` cluster privilege.
 
+
+[[security-api-update-settings-request-body]]
+==== {api-request-body-title}
+
+`security`::
+(Optional, object) Settings to be used for the index used for most security 
+configuration, including Native realm users and roles configured via the API.
+
+`security-tokens`::
+(Optional, object) Settings to be used for the index used to store 
+<<security-api-get-token,tokens>>.
+
+`security`::
+(Optional, object) Settings to be used for the index used to store 
+<<security-api-activate-user-profile, profile>> information.
+
+
 [[security-api-update-settings-desc]]
 ==== {api-description-title}
 This API allows a user to modify the settings for the Security internal indices 
@@ -19,6 +39,10 @@ be modified. This includes:
 - `index.auto_expand_replicas`
 - `index.number_of_replicas`
 
+
+[[security-api-update-settings-example]]
+==== {api-examples-title}
+
 An example of modifying the Security settings:
 
 [source,console]
@@ -43,18 +67,3 @@ The configured settings can be retrieved using the
 is not in use on the system, but settings are provided for it, the request will 
 be rejected - this API does not yet support configuring the settings for these 
 indices before they are in use.
-
-
-==== {api-request-body-title}
-
-`security`::
-(Optional, object) Settings to be used for the index used for most security 
-configuration, including Native realm users and roles configured via the API.
-
-`security-tokens`::
-(Optional, object) Settings to be used for the index used to store 
-<<security-api-get-token,tokens>>.
-
-`security`::
-(Optional, object) Settings to be used for the index used to store 
-<<security-api-activate-user-profile, profile>> information.