From 22650a1a71038db4bc209850c4b5d0d6679fc00f Mon Sep 17 00:00:00 2001 From: Nikolaj Volgushev Date: Mon, 21 Oct 2024 13:55:10 +0200 Subject: [PATCH 1/5] Fix role-related API spec --- output/openapi/elasticsearch-openapi.json | 22 ++++++++++--------- .../elasticsearch-serverless-openapi.json | 22 ++++++++++--------- output/schema/schema-serverless.json | 20 ++++++++--------- output/schema/schema.json | 20 ++++++++--------- .../delete_role/SecurityDeleteRoleRequest.ts | 2 ++ .../SecurityGetBuiltinPrivilegesRequest.ts | 2 ++ .../get_role/SecurityGetRoleRequest.ts | 4 ++-- .../put_role/SecurityPutRoleRequest.ts | 4 ++-- 8 files changed, 52 insertions(+), 44 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 311faa0237..704aef3a4e 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -26924,8 +26924,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The get roles API cannot retrieve roles that are defined in roles files.", + "summary": "Get roles API\n", + "description": "Retrieves roles in the native realm.", "operationId": "security-get-role-1", "responses": { "200": { @@ -27968,8 +27968,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The get roles API cannot retrieve roles that are defined in roles files.", + "summary": "Get roles API\n", + "description": "Retrieves roles in the native realm.", "operationId": "security-get-role", "parameters": [ { @@ -27986,8 +27986,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The create or update roles API cannot update roles that are defined in roles files.", + "summary": "Create or update roles API\n", + "description": "Create or update roles in the native realm.", "operationId": "security-put-role", "parameters": [ { @@ -28010,8 +28010,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The create or update roles API cannot update roles that are defined in roles files.", + "summary": "Create or update roles API\n", + "description": "Create or update roles in the native realm.", "operationId": "security-put-role-1", "parameters": [ { @@ -28034,7 +28034,8 @@ "tags": [ "security" ], - "summary": "Removes roles in the native realm", + "summary": "Delete roles API\n", + "description": "Removes roles in the native realm.", "operationId": "security-delete-role", "parameters": [ { @@ -28584,7 +28585,8 @@ "tags": [ "security" ], - "summary": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch", + "summary": "Get builtin privileges API\n", + "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "operationId": "security-get-builtin-privileges", "responses": { "200": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index b943b079be..b9d1d47323 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -16863,8 +16863,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The get roles API cannot retrieve roles that are defined in roles files.", + "summary": "Get roles API\n", + "description": "Retrieves roles in the native realm.", "operationId": "security-get-role", "parameters": [ { @@ -16881,8 +16881,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The create or update roles API cannot update roles that are defined in roles files.", + "summary": "Create or update roles API\n", + "description": "Create or update roles in the native realm.", "operationId": "security-put-role", "parameters": [ { @@ -16905,8 +16905,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The create or update roles API cannot update roles that are defined in roles files.", + "summary": "Create or update roles API\n", + "description": "Create or update roles in the native realm.", "operationId": "security-put-role-1", "parameters": [ { @@ -16929,7 +16929,8 @@ "tags": [ "security" ], - "summary": "Removes roles in the native realm", + "summary": "Delete roles API\n", + "description": "Removes roles in the native realm.", "operationId": "security-delete-role", "parameters": [ { @@ -16981,7 +16982,8 @@ "tags": [ "security" ], - "summary": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch", + "summary": "Get builtin privileges API\n", + "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "operationId": "security-get-builtin-privileges", "responses": { "200": { @@ -17021,8 +17023,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The get roles API cannot retrieve roles that are defined in roles files.", + "summary": "Get roles API\n", + "description": "Retrieves roles in the native realm.", "operationId": "security-get-role-1", "responses": { "200": { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 8581a26414..53d7128f4f 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -8379,7 +8379,7 @@ "stability": "stable" } }, - "description": "Removes roles in the native realm.", + "description": "Delete roles API\nRemoves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -8455,7 +8455,7 @@ "stability": "stable" } }, - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", "privileges": { @@ -8494,7 +8494,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", + "description": "Get roles API\nRetrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -8629,7 +8629,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.", + "description": "Create or update roles API\nCreate or update roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", "privileges": { @@ -38755,7 +38755,7 @@ "body": { "kind": "no_body" }, - "description": "Removes roles in the native realm.", + "description": "Delete roles API\nRemoves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -38795,7 +38795,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L35" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" }, { "body": { @@ -38997,7 +38997,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -39011,7 +39011,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L28" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L30" }, { "body": { @@ -39061,7 +39061,7 @@ "body": { "kind": "no_body" }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", + "description": "Get roles API\nRetrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -39570,7 +39570,7 @@ } ] }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.", + "description": "Create or update roles API\nCreate or update roles in the native realm.", "inherits": { "type": { "name": "RequestBase", diff --git a/output/schema/schema.json b/output/schema/schema.json index f1c3fdf046..5dbac70d40 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -15519,7 +15519,7 @@ "stability": "stable" } }, - "description": "Removes roles in the native realm.", + "description": "Delete roles API\nRemoves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -15907,7 +15907,7 @@ "stability": "stable" } }, - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", "privileges": { @@ -15993,7 +15993,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", + "description": "Get roles API\nRetrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -16686,7 +16686,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.", + "description": "Create or update roles API\nCreate or update roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", "privileges": { @@ -189744,7 +189744,7 @@ "body": { "kind": "no_body" }, - "description": "Removes roles in the native realm.", + "description": "Delete roles API\nRemoves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -189783,7 +189783,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L35" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" }, { "kind": "response", @@ -190682,7 +190682,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -190695,7 +190695,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L28" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L30" }, { "kind": "response", @@ -190834,7 +190834,7 @@ "body": { "kind": "no_body" }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", + "description": "Get roles API\nRetrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -193579,7 +193579,7 @@ } ] }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.", + "description": "Create or update roles API\nCreate or update roles in the native realm.", "inherits": { "type": { "name": "RequestBase", diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index 0f1d7e2d9b..78dcff1f9c 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Name, Refresh } from '@_types/common' /** + * Delete roles API + * Removes roles in the native realm. * @rest_spec_name security.delete_role * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index c1223b8338..c01e84f5e3 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -20,6 +20,8 @@ import { RequestBase } from '@_types/Base' /** + * Get builtin privileges API + * Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * @rest_spec_name security.get_builtin_privileges * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index 21316a24a4..f6fc4b496e 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -21,8 +21,8 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** - * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - * The get roles API cannot retrieve roles that are defined in roles files. + * Get roles API + * Retrieves roles in the native realm. * @rest_spec_name security.get_role * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/put_role/SecurityPutRoleRequest.ts b/specification/security/put_role/SecurityPutRoleRequest.ts index 09f818145b..36a93ecbb5 100644 --- a/specification/security/put_role/SecurityPutRoleRequest.ts +++ b/specification/security/put_role/SecurityPutRoleRequest.ts @@ -29,8 +29,8 @@ import { RequestBase } from '@_types/Base' import { Metadata, Name, Refresh } from '@_types/common' /** - * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - * The create or update roles API cannot update roles that are defined in roles files. + * Create or update roles API + * Create or update roles in the native realm. * @rest_spec_name security.put_role * @availability stack stability=stable * @availability serverless stability=stable visibility=public From 4ca237aae7af48fe35926c4614be4437d3ef3d81 Mon Sep 17 00:00:00 2001 From: Nikolaj Volgushev Date: Mon, 21 Oct 2024 14:21:22 +0200 Subject: [PATCH 2/5] Empty lines --- output/schema/schema-serverless.json | 24 ++++++++++++------------ output/schema/schema.json | 24 ++++++++++++------------ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 53d7128f4f..3bea1b631b 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -8379,7 +8379,7 @@ "stability": "stable" } }, - "description": "Delete roles API\nRemoves roles in the native realm.", + "description": "Delete roles API\n\nRemoves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -8455,7 +8455,7 @@ "stability": "stable" } }, - "description": "Get builtin privileges API\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", "privileges": { @@ -8494,7 +8494,7 @@ "stability": "stable" } }, - "description": "Get roles API\nRetrieves roles in the native realm.", + "description": "Get roles API\n\nRetrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -8629,7 +8629,7 @@ "stability": "stable" } }, - "description": "Create or update roles API\nCreate or update roles in the native realm.", + "description": "Create or update roles API\n\nCreate or update roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", "privileges": { @@ -38755,7 +38755,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles API\nRemoves roles in the native realm.", + "description": "Delete roles API\n\nRemoves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -38795,7 +38795,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" }, { "body": { @@ -38997,7 +38997,7 @@ "body": { "kind": "no_body" }, - "description": "Get builtin privileges API\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -39011,7 +39011,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L30" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L31" }, { "body": { @@ -39061,7 +39061,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles API\nRetrieves roles in the native realm.", + "description": "Get roles API\n\nRetrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -39088,7 +39088,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" }, { "body": { @@ -39570,7 +39570,7 @@ } ] }, - "description": "Create or update roles API\nCreate or update roles in the native realm.", + "description": "Create or update roles API\n\nCreate or update roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -39610,7 +39610,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L91" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L92" }, { "body": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 5dbac70d40..f020947150 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -15519,7 +15519,7 @@ "stability": "stable" } }, - "description": "Delete roles API\nRemoves roles in the native realm.", + "description": "Delete roles API\n\nRemoves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -15907,7 +15907,7 @@ "stability": "stable" } }, - "description": "Get builtin privileges API\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", "privileges": { @@ -15993,7 +15993,7 @@ "stability": "stable" } }, - "description": "Get roles API\nRetrieves roles in the native realm.", + "description": "Get roles API\n\nRetrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -16686,7 +16686,7 @@ "stability": "stable" } }, - "description": "Create or update roles API\nCreate or update roles in the native realm.", + "description": "Create or update roles API\n\nCreate or update roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", "privileges": { @@ -189744,7 +189744,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles API\nRemoves roles in the native realm.", + "description": "Delete roles API\n\nRemoves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -189783,7 +189783,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" }, { "kind": "response", @@ -190682,7 +190682,7 @@ "body": { "kind": "no_body" }, - "description": "Get builtin privileges API\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -190695,7 +190695,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L30" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L31" }, { "kind": "response", @@ -190834,7 +190834,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles API\nRetrieves roles in the native realm.", + "description": "Get roles API\n\nRetrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190860,7 +190860,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" }, { "kind": "response", @@ -193579,7 +193579,7 @@ } ] }, - "description": "Create or update roles API\nCreate or update roles in the native realm.", + "description": "Create or update roles API\n\nCreate or update roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -193618,7 +193618,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L91" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L92" }, { "kind": "response", From 071eafeb01625f25a921ee72355a9dfabd34fe86 Mon Sep 17 00:00:00 2001 From: Nikolaj Volgushev Date: Mon, 21 Oct 2024 14:22:38 +0200 Subject: [PATCH 3/5] Actual change --- specification/security/delete_role/SecurityDeleteRoleRequest.ts | 1 + .../SecurityGetBuiltinPrivilegesRequest.ts | 1 + specification/security/get_role/SecurityGetRoleRequest.ts | 1 + specification/security/put_role/SecurityPutRoleRequest.ts | 1 + 4 files changed, 4 insertions(+) diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index 78dcff1f9c..0c3be2a584 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -22,6 +22,7 @@ import { Name, Refresh } from '@_types/common' /** * Delete roles API + * * Removes roles in the native realm. * @rest_spec_name security.delete_role * @availability stack stability=stable diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index c01e84f5e3..9e4530c0fc 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get builtin privileges API + * * Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * @rest_spec_name security.get_builtin_privileges * @availability stack since=7.3.0 stability=stable diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index f6fc4b496e..86daabdaec 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' /** * Get roles API + * * Retrieves roles in the native realm. * @rest_spec_name security.get_role * @availability stack stability=stable diff --git a/specification/security/put_role/SecurityPutRoleRequest.ts b/specification/security/put_role/SecurityPutRoleRequest.ts index 36a93ecbb5..0333ca9018 100644 --- a/specification/security/put_role/SecurityPutRoleRequest.ts +++ b/specification/security/put_role/SecurityPutRoleRequest.ts @@ -30,6 +30,7 @@ import { Metadata, Name, Refresh } from '@_types/common' /** * Create or update roles API + * * Create or update roles in the native realm. * @rest_spec_name security.put_role * @availability stack stability=stable From 56e8f7f22f6392477c19e37714442827d1dfa919 Mon Sep 17 00:00:00 2001 From: Nikolaj Volgushev Date: Mon, 21 Oct 2024 14:44:27 +0200 Subject: [PATCH 4/5] Period --- output/openapi/elasticsearch-openapi.json | 12 +++++----- .../elasticsearch-serverless-openapi.json | 12 +++++----- output/schema/schema-serverless.json | 24 +++++++++---------- output/schema/schema.json | 24 +++++++++---------- .../delete_role/SecurityDeleteRoleRequest.ts | 3 +-- .../SecurityGetBuiltinPrivilegesRequest.ts | 3 +-- .../get_role/SecurityGetRoleRequest.ts | 3 +-- .../put_role/SecurityPutRoleRequest.ts | 3 +-- 8 files changed, 40 insertions(+), 44 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 704aef3a4e..c38334cf59 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -26924,7 +26924,7 @@ "tags": [ "security" ], - "summary": "Get roles API\n", + "summary": "Get roles API", "description": "Retrieves roles in the native realm.", "operationId": "security-get-role-1", "responses": { @@ -27968,7 +27968,7 @@ "tags": [ "security" ], - "summary": "Get roles API\n", + "summary": "Get roles API", "description": "Retrieves roles in the native realm.", "operationId": "security-get-role", "parameters": [ @@ -27986,7 +27986,7 @@ "tags": [ "security" ], - "summary": "Create or update roles API\n", + "summary": "Create or update roles API", "description": "Create or update roles in the native realm.", "operationId": "security-put-role", "parameters": [ @@ -28010,7 +28010,7 @@ "tags": [ "security" ], - "summary": "Create or update roles API\n", + "summary": "Create or update roles API", "description": "Create or update roles in the native realm.", "operationId": "security-put-role-1", "parameters": [ @@ -28034,7 +28034,7 @@ "tags": [ "security" ], - "summary": "Delete roles API\n", + "summary": "Delete roles API", "description": "Removes roles in the native realm.", "operationId": "security-delete-role", "parameters": [ @@ -28585,7 +28585,7 @@ "tags": [ "security" ], - "summary": "Get builtin privileges API\n", + "summary": "Get builtin privileges API", "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "operationId": "security-get-builtin-privileges", "responses": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index b9d1d47323..249b543cb9 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -16863,7 +16863,7 @@ "tags": [ "security" ], - "summary": "Get roles API\n", + "summary": "Get roles API", "description": "Retrieves roles in the native realm.", "operationId": "security-get-role", "parameters": [ @@ -16881,7 +16881,7 @@ "tags": [ "security" ], - "summary": "Create or update roles API\n", + "summary": "Create or update roles API", "description": "Create or update roles in the native realm.", "operationId": "security-put-role", "parameters": [ @@ -16905,7 +16905,7 @@ "tags": [ "security" ], - "summary": "Create or update roles API\n", + "summary": "Create or update roles API", "description": "Create or update roles in the native realm.", "operationId": "security-put-role-1", "parameters": [ @@ -16929,7 +16929,7 @@ "tags": [ "security" ], - "summary": "Delete roles API\n", + "summary": "Delete roles API", "description": "Removes roles in the native realm.", "operationId": "security-delete-role", "parameters": [ @@ -16982,7 +16982,7 @@ "tags": [ "security" ], - "summary": "Get builtin privileges API\n", + "summary": "Get builtin privileges API", "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "operationId": "security-get-builtin-privileges", "responses": { @@ -17023,7 +17023,7 @@ "tags": [ "security" ], - "summary": "Get roles API\n", + "summary": "Get roles API", "description": "Retrieves roles in the native realm.", "operationId": "security-get-role-1", "responses": { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 3bea1b631b..fecd065d7e 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -8379,7 +8379,7 @@ "stability": "stable" } }, - "description": "Delete roles API\n\nRemoves roles in the native realm.", + "description": "Delete roles API.\nRemoves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -8455,7 +8455,7 @@ "stability": "stable" } }, - "description": "Get builtin privileges API\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API.\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", "privileges": { @@ -8494,7 +8494,7 @@ "stability": "stable" } }, - "description": "Get roles API\n\nRetrieves roles in the native realm.", + "description": "Get roles API.\nRetrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -8629,7 +8629,7 @@ "stability": "stable" } }, - "description": "Create or update roles API\n\nCreate or update roles in the native realm.", + "description": "Create or update roles API.\nCreate or update roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", "privileges": { @@ -38755,7 +38755,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles API\n\nRemoves roles in the native realm.", + "description": "Delete roles API.\nRemoves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -38795,7 +38795,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" }, { "body": { @@ -38997,7 +38997,7 @@ "body": { "kind": "no_body" }, - "description": "Get builtin privileges API\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API.\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -39011,7 +39011,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L31" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L30" }, { "body": { @@ -39061,7 +39061,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles API\n\nRetrieves roles in the native realm.", + "description": "Get roles API.\nRetrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -39088,7 +39088,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" }, { "body": { @@ -39570,7 +39570,7 @@ } ] }, - "description": "Create or update roles API\n\nCreate or update roles in the native realm.", + "description": "Create or update roles API.\nCreate or update roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -39610,7 +39610,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L92" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L91" }, { "body": { diff --git a/output/schema/schema.json b/output/schema/schema.json index f020947150..7b296a9f72 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -15519,7 +15519,7 @@ "stability": "stable" } }, - "description": "Delete roles API\n\nRemoves roles in the native realm.", + "description": "Delete roles API.\nRemoves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -15907,7 +15907,7 @@ "stability": "stable" } }, - "description": "Get builtin privileges API\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API.\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", "privileges": { @@ -15993,7 +15993,7 @@ "stability": "stable" } }, - "description": "Get roles API\n\nRetrieves roles in the native realm.", + "description": "Get roles API.\nRetrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -16686,7 +16686,7 @@ "stability": "stable" } }, - "description": "Create or update roles API\n\nCreate or update roles in the native realm.", + "description": "Create or update roles API.\nCreate or update roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", "privileges": { @@ -189744,7 +189744,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles API\n\nRemoves roles in the native realm.", + "description": "Delete roles API.\nRemoves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -189783,7 +189783,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" }, { "kind": "response", @@ -190682,7 +190682,7 @@ "body": { "kind": "no_body" }, - "description": "Get builtin privileges API\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API.\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -190695,7 +190695,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L31" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L30" }, { "kind": "response", @@ -190834,7 +190834,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles API\n\nRetrieves roles in the native realm.", + "description": "Get roles API.\nRetrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190860,7 +190860,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" }, { "kind": "response", @@ -193579,7 +193579,7 @@ } ] }, - "description": "Create or update roles API\n\nCreate or update roles in the native realm.", + "description": "Create or update roles API.\nCreate or update roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -193618,7 +193618,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L92" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L91" }, { "kind": "response", diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index 0c3be2a584..c1473f038f 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -21,8 +21,7 @@ import { RequestBase } from '@_types/Base' import { Name, Refresh } from '@_types/common' /** - * Delete roles API - * + * Delete roles API. * Removes roles in the native realm. * @rest_spec_name security.delete_role * @availability stack stability=stable diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index 9e4530c0fc..1d409f4c46 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -20,8 +20,7 @@ import { RequestBase } from '@_types/Base' /** - * Get builtin privileges API - * + * Get builtin privileges API. * Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * @rest_spec_name security.get_builtin_privileges * @availability stack since=7.3.0 stability=stable diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index 86daabdaec..5ede1681a2 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -21,8 +21,7 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** - * Get roles API - * + * Get roles API. * Retrieves roles in the native realm. * @rest_spec_name security.get_role * @availability stack stability=stable diff --git a/specification/security/put_role/SecurityPutRoleRequest.ts b/specification/security/put_role/SecurityPutRoleRequest.ts index 0333ca9018..efab4cee49 100644 --- a/specification/security/put_role/SecurityPutRoleRequest.ts +++ b/specification/security/put_role/SecurityPutRoleRequest.ts @@ -29,8 +29,7 @@ import { RequestBase } from '@_types/Base' import { Metadata, Name, Refresh } from '@_types/common' /** - * Create or update roles API - * + * Create or update roles API. * Create or update roles in the native realm. * @rest_spec_name security.put_role * @availability stack stability=stable From ebf654e26059e7964d6ed62e1593c77c0c6f7da9 Mon Sep 17 00:00:00 2001 From: Nikolaj Volgushev Date: Mon, 21 Oct 2024 14:48:51 +0200 Subject: [PATCH 5/5] Extra newline --- output/schema/schema-serverless.json | 24 +++++++++---------- output/schema/schema.json | 24 +++++++++---------- .../delete_role/SecurityDeleteRoleRequest.ts | 1 + .../SecurityGetBuiltinPrivilegesRequest.ts | 1 + .../get_role/SecurityGetRoleRequest.ts | 1 + .../put_role/SecurityPutRoleRequest.ts | 1 + 6 files changed, 28 insertions(+), 24 deletions(-) diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index fecd065d7e..577baa208a 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -8379,7 +8379,7 @@ "stability": "stable" } }, - "description": "Delete roles API.\nRemoves roles in the native realm.", + "description": "Delete roles API.\n\nRemoves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -8455,7 +8455,7 @@ "stability": "stable" } }, - "description": "Get builtin privileges API.\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API.\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", "privileges": { @@ -8494,7 +8494,7 @@ "stability": "stable" } }, - "description": "Get roles API.\nRetrieves roles in the native realm.", + "description": "Get roles API.\n\nRetrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -8629,7 +8629,7 @@ "stability": "stable" } }, - "description": "Create or update roles API.\nCreate or update roles in the native realm.", + "description": "Create or update roles API.\n\nCreate or update roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", "privileges": { @@ -38755,7 +38755,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles API.\nRemoves roles in the native realm.", + "description": "Delete roles API.\n\nRemoves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -38795,7 +38795,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" }, { "body": { @@ -38997,7 +38997,7 @@ "body": { "kind": "no_body" }, - "description": "Get builtin privileges API.\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API.\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -39011,7 +39011,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L30" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L31" }, { "body": { @@ -39061,7 +39061,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles API.\nRetrieves roles in the native realm.", + "description": "Get roles API.\n\nRetrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -39088,7 +39088,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" }, { "body": { @@ -39570,7 +39570,7 @@ } ] }, - "description": "Create or update roles API.\nCreate or update roles in the native realm.", + "description": "Create or update roles API.\n\nCreate or update roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -39610,7 +39610,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L91" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L92" }, { "body": { diff --git a/output/schema/schema.json b/output/schema/schema.json index 7b296a9f72..be65f0248b 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -15519,7 +15519,7 @@ "stability": "stable" } }, - "description": "Delete roles API.\nRemoves roles in the native realm.", + "description": "Delete roles API.\n\nRemoves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -15907,7 +15907,7 @@ "stability": "stable" } }, - "description": "Get builtin privileges API.\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API.\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "name": "security.get_builtin_privileges", "privileges": { @@ -15993,7 +15993,7 @@ "stability": "stable" } }, - "description": "Get roles API.\nRetrieves roles in the native realm.", + "description": "Get roles API.\n\nRetrieves roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -16686,7 +16686,7 @@ "stability": "stable" } }, - "description": "Create or update roles API.\nCreate or update roles in the native realm.", + "description": "Create or update roles API.\n\nCreate or update roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "name": "security.put_role", "privileges": { @@ -189744,7 +189744,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles API.\nRemoves roles in the native realm.", + "description": "Delete roles API.\n\nRemoves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -189783,7 +189783,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L37" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" }, { "kind": "response", @@ -190682,7 +190682,7 @@ "body": { "kind": "no_body" }, - "description": "Get builtin privileges API.\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges API.\n\nRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -190695,7 +190695,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L30" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L31" }, { "kind": "response", @@ -190834,7 +190834,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles API.\nRetrieves roles in the native realm.", + "description": "Get roles API.\n\nRetrieves roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190860,7 +190860,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" }, { "kind": "response", @@ -193579,7 +193579,7 @@ } ] }, - "description": "Create or update roles API.\nCreate or update roles in the native realm.", + "description": "Create or update roles API.\n\nCreate or update roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -193618,7 +193618,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L91" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L92" }, { "kind": "response", diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index c1473f038f..b93b84a622 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -22,6 +22,7 @@ import { Name, Refresh } from '@_types/common' /** * Delete roles API. + * * Removes roles in the native realm. * @rest_spec_name security.delete_role * @availability stack stability=stable diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index 1d409f4c46..15e290be52 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * Get builtin privileges API. + * * Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * @rest_spec_name security.get_builtin_privileges * @availability stack since=7.3.0 stability=stable diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index 5ede1681a2..170b4f8a99 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -22,6 +22,7 @@ import { Names } from '@_types/common' /** * Get roles API. + * * Retrieves roles in the native realm. * @rest_spec_name security.get_role * @availability stack stability=stable diff --git a/specification/security/put_role/SecurityPutRoleRequest.ts b/specification/security/put_role/SecurityPutRoleRequest.ts index efab4cee49..cebcc3da17 100644 --- a/specification/security/put_role/SecurityPutRoleRequest.ts +++ b/specification/security/put_role/SecurityPutRoleRequest.ts @@ -30,6 +30,7 @@ import { Metadata, Name, Refresh } from '@_types/common' /** * Create or update roles API. + * * Create or update roles in the native realm. * @rest_spec_name security.put_role * @availability stack stability=stable