Skip to content

Commit

Permalink
Add extra line after summaries
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Oct 22, 2024
1 parent 7975a6e commit dc8609a
Show file tree
Hide file tree
Showing 28 changed files with 38 additions and 10 deletions.
3 changes: 2 additions & 1 deletion specification/security/activate_user_profile/Request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ import { GrantType } from '@security/_types/GrantType'
import { RequestBase } from '@_types/Base'

/**
* Create or update a user profile.
* Activate a user profile.
*
* Create or update a user profile on behalf of another user.
* @rest_spec_name security.activate_user_profile
* @availability stack since=8.2.0 stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base'

/**
* Authenticate a user.
*
* Authenticates a user and returns information about the authenticated user.
* Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).
* A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Refresh } from '@_types/common'

/**
* Bulk delete roles.
*
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
* The bulk delete roles API cannot delete roles that are defined in roles files.
* @rest_spec_name security.bulk_delete_role
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import { Refresh } from '@_types/common'

/**
* Bulk create or update roles.
*
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
* The bulk create or update roles API cannot update roles that are defined in roles files.
* @rest_spec_name security.bulk_put_role
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Password, Refresh, Username } from '@_types/common'

/**
* Change passwords.
*
* Change the passwords of users in the native realm and built-in users.
* @rest_spec_name security.change_password
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Ids } from '@_types/common'

/**
* Clear the API key cache.
*
* Evict a subset of all entries from the API key cache.
* The cache is also automatically cleared on state changes of the security index.
* @rest_spec_name security.clear_api_key_cache
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Name } from '@_types/common'

/**
* Clear the privileges cache.
*
* Evict privileges from the native application privilege cache.
* The cache is also automatically cleared for applications that have their privileges updated.
* @rest_spec_name security.clear_cached_privileges
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Names } from '@_types/common'

/**
* Clear the user cache.
*
* Evict users from the user cache. You can completely clear the cache or evict specific users.
* @rest_spec_name security.clear_cached_realms
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Names } from '@_types/common'

/**
* Clear the roles cache.
*
* Evict roles from the native role cache.
* @rest_spec_name security.clear_cached_roles
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Names, Namespace, Service } from '@_types/common'

/**
* Clear service account token caches.
*
* Evict a subset of all entries from the service account token caches.
* @rest_spec_name security.clear_cached_service_tokens
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import { Duration } from '@_types/Time'

/**
* Create an API key.
*
* Create an API key for access without requiring basic authentication.
* A successful request returns a JSON structure that contains the API key, its unique id, and its name.
* If applicable, it also returns expiration information for the API key in milliseconds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Name, Namespace, Refresh, Service } from '@_types/common'

/**
* Create a service account token.
*
* Create a service accounts token for access without requiring basic authentication.
* @rest_spec_name security.create_service_token
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ import { Name, Refresh } from '@_types/common'

/**
* Delete roles.
* Remove roles in the native realm.
*
* Delete roles in the native realm.
* @rest_spec_name security.delete_role
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Name, Namespace, Refresh, Service } from '@_types/common'

/**
* Delete service account tokens.
*
* Delete service account tokens for a service in a specified namespace.
* @rest_spec_name security.delete_service_token
* @availability stack since=5.5.0 stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Refresh, Username } from '@_types/common'

/**
* Delete users.
*
* Delete users from the native realm.
* @rest_spec_name security.delete_user
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base'
import { Refresh, Username } from '@_types/common'

/**
* Deactivate users.
* Deactivate users in the native realm.
* Disable users.
*
* Disable users in the native realm.
* @rest_spec_name security.disable_user
* @availability stack stability=stable
*/
Expand Down
5 changes: 3 additions & 2 deletions specification/security/disable_user_profile/Request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ import { RequestBase } from '@_types/Base'
import { Refresh } from '@_types/common'

/**
* Deactivate a user profile.
* Deactivated user profiles are not visible in user profile searches.
* Disable a user profile.
*
* Disable user profiles so that they are not visible in user profile searches.
* @rest_spec_name security.disable_user_profile
* @availability stack since=8.2.0 stability=stable
* @availability serverless stability=stable visibility=private
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ import { RequestBase } from '@_types/Base'
import { Refresh, Username } from '@_types/common'

/**
* Activate users.
* Activate users in the native realm.
* Enable users.
*
* Enable users in the native realm.
* @rest_spec_name security.enable_user
* @availability stack stability=stable
*/
Expand Down
5 changes: 3 additions & 2 deletions specification/security/enable_user_profile/Request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ import { RequestBase } from '@_types/Base'
import { Refresh } from '@_types/common'

/**
* Activate a user profile.
* Activated user profiles are visible in user profile searches.
* Enable a user profile.
*
* Enable user profiles to make them visible in user profile searches.
* @rest_spec_name security.enable_user_profile
* @availability stack since=8.2.0 stability=stable
* @availability serverless stability=stable visibility=private
Expand Down
1 change: 1 addition & 0 deletions specification/security/enroll_kibana/Request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base'

/**
* Enroll Kibana.
*
* Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.
* @rest_spec_name security.enroll_kibana
* @availability stack since=8.0.0 stability=stable
Expand Down
1 change: 1 addition & 0 deletions specification/security/enroll_node/Request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base'

/**
* Enroll a node.
*
* Enroll a new node to allow it to join an existing cluster with security features enabled.
* @rest_spec_name security.enroll_node
* @availability stack since=8.0.0 stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Id, Name, Username } from '@_types/common'

/**
* Get API key information.
*
* Retrieves information for one or more API keys.
* NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
* If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base'

/**
* Get builtin privileges.
*
* Get 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
Expand Down
1 change: 1 addition & 0 deletions specification/security/get_role/SecurityGetRoleRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Names } from '@_types/common'

/**
* Get roles.
*
* Get roles in the native realm.
* @rest_spec_name security.get_role
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Names } from '@_types/common'

/**
* Get role mappings.
*
* Role mappings define which roles are assigned to each user.
* The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.
* The get role mappings API cannot retrieve role mappings that are defined in role mapping files.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Namespace, Service } from '@_types/common'

/**
* Get service accounts.
*
* Get a list of service accounts that match the provided path parameters.
* @rest_spec_name security.get_service_accounts
* @availability stack since=7.13.0 stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import { AccessTokenGrantType } from './types'

/**
* Get a token.
*
* Create a bearer token for access without requiring basic authentication.
* @rest_spec_name security.get_token
* @availability stack since=5.5.0 stability=stable
Expand Down
1 change: 1 addition & 0 deletions specification/security/get_user/SecurityGetUserRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Username } from '@_types/common'

/**
* Get users.
*
* Get information about users in the native realm and built-in users.
* @rest_spec_name security.get_user
* @availability stack stability=stable
Expand Down

0 comments on commit dc8609a

Please sign in to comment.