Skip to content

Fix role-related API spec #3033

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.

Sign up for GitHub

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 5 commits into from
Oct 21, 2024
Merged

Fix role-related API spec #3033

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
22650a1
Fix role-related API spec
n1v0lg Oct 21, 2024
4ca237a
Empty lines
n1v0lg Oct 21, 2024
071eafe
Actual change
n1v0lg Oct 21, 2024
56e8f7f
Period
n1v0lg Oct 21, 2024
ebf654e
Extra newline
n1v0lg Oct 21, 2024
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
22 changes: 12 additions & 10 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 12 additions & 10 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 10 additions & 10 deletions output/schema/schema-serverless.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 10 additions & 10 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions specification/security/delete_role/SecurityDeleteRoleRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base'
import { Name, Refresh } from '@_types/common'

/**
* Delete roles API
Copy link
Member

@flobernd flobernd Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be an empty line between the header and the description.

The JSDoc is interpreted as markdown which means that no new paragraph is created without the empty line.

Same for all other places 🙂

Copy link
Contributor Author

@n1v0lg n1v0lg Oct 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flobernd thanks!

Is this what you had in mind: 071eafe?

I don't think it affected the output directory so I don't think it'll make a difference in rendering though.

Copy link
Member

@flobernd flobernd Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@n1v0lg Yes, the previous commit looks good! It should affect the ouput as well 😅 (maybe we have a bug here in the spec compiler, if it really does not..).

* Removes roles in the native realm.
* @rest_spec_name security.delete_role
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions specification/security/get_role/SecurityGetRoleRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions specification/security/put_role/SecurityPutRoleRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down