Skip to content

Commit 2fdec29

Browse files
authored
Fix role-related API spec (#3033)
There is a display glitch in the ES serverless API: see live [spec](https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-security-get-role). where details of several APIs are rendered as API headers. This PR fixes the rendering issue by including the relevant header info in top-level comments for each affected API.
1 parent 8650a71 commit 2fdec29

File tree

8 files changed

+60
-48
lines changed

8 files changed

+60
-48
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 12 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 12 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema-serverless.json

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/security/delete_role/SecurityDeleteRoleRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base'
2121
import { Name, Refresh } from '@_types/common'
2222

2323
/**
24+
* Delete roles API.
25+
*
26+
* Removes roles in the native realm.
2427
* @rest_spec_name security.delete_role
2528
* @availability stack stability=stable
2629
* @availability serverless stability=stable visibility=public

specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Get builtin privileges API.
24+
*
25+
* Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
2326
* @rest_spec_name security.get_builtin_privileges
2427
* @availability stack since=7.3.0 stability=stable
2528
* @availability serverless stability=stable visibility=public

specification/security/get_role/SecurityGetRoleRequest.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base'
2121
import { Names } from '@_types/common'
2222

2323
/**
24-
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
25-
* The get roles API cannot retrieve roles that are defined in roles files.
24+
* Get roles API.
25+
*
26+
* Retrieves roles in the native realm.
2627
* @rest_spec_name security.get_role
2728
* @availability stack stability=stable
2829
* @availability serverless stability=stable visibility=public

specification/security/put_role/SecurityPutRoleRequest.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ import { RequestBase } from '@_types/Base'
2929
import { Metadata, Name, Refresh } from '@_types/common'
3030

3131
/**
32-
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
33-
* The create or update roles API cannot update roles that are defined in roles files.
32+
* Create or update roles API.
33+
*
34+
* Create or update roles in the native realm.
3435
* @rest_spec_name security.put_role
3536
* @availability stack stability=stable
3637
* @availability serverless stability=stable visibility=public

0 commit comments

Comments
 (0)