Skip to content

Commit ec0a748

Browse files
authored
Replace or remove more doc URLs (elastic#1502)
1 parent 4fd0198 commit ec0a748

File tree

11 files changed

+30
-27
lines changed

11 files changed

+30
-27
lines changed

output/schema/schema.json

+18-12
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

+1-1
Original file line numberDiff line numberDiff line change
@@ -374,4 +374,4 @@ field-and-document-access-control,https://www.elastic.co/guide/en/elasticsearch/
374374
run-as-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/master/run-as-privilege.html
375375
sql-rest-filtering,https://www.elastic.co/guide/en/elasticsearch/reference/master/sql-rest-filtering.html
376376
sql-rest-format,https://www.elastic.co/guide/en/elasticsearch/reference/master/sql-rest-format.html
377-
cron-expressions,https://www.elastic.co/guide/en/elasticsearch/reference/master/cron-expressions.html
377+
cron-expressions,https://www.elastic.co/guide/en/elasticsearch/reference/master/api-conventions.html#api-cron-expressions

specification/security/_types/Privileges.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export enum ClusterPrivilege {
7979
export class IndicesPrivileges {
8080
/**
8181
* The document fields that the owners of the role have read access to.
82-
* @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html
82+
* @doc_id field-and-document-access-control
8383
*/
8484
field_security?: FieldSecurity | FieldSecurity[]
8585
/**

specification/security/create_api_key/SecurityCreateApiKeyRequest.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export interface Request extends RequestBase {
3939
name?: Name
4040
/**
4141
* An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
42-
* @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html
42+
* @doc_id security-api-put-role
4343
*/
4444
role_descriptors?: Dictionary<string, RoleDescriptor>
4545
/**

specification/security/get_role/SecurityGetRoleRequest.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html#roles-management-file).
24+
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
2525
* The get roles API cannot retrieve roles that are defined in roles files.
2626
* @rest_spec_name security.get_role
2727
* @since 0.0.0

specification/security/put_role/SecurityPutRoleRequest.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html#roles-management-file).
32+
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
3333
* The create or update roles API cannot update roles that are defined in roles files.
3434
* @rest_spec_name security.put_role
3535
* @since 0.0.0
@@ -69,7 +69,7 @@ export interface Request extends RequestBase {
6969
metadata?: Metadata
7070
/**
7171
* A list of users that the owners of this role can impersonate.
72-
* @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html
72+
* @doc_id run-as-privilege
7373
*/
7474
run_as?: string[]
7575
/**

specification/security/query_api_keys/QueryApiKeysRequest.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface Request extends RequestBase {
4242
* @server_default 0
4343
*/
4444
from?: integer
45-
/** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html */
45+
/** @doc_id sort-search-results */
4646
sort?: Sort
4747
/**
4848
* The number of hits to return. By default, you cannot page through more

specification/snapshot/_types/SnapshotShardsStatsStage.ts

-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,6 @@
1717
* under the License.
1818
*/
1919

20-
/**
21-
* @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/get-snapshot-status-api.html
22-
*/
2320
export enum ShardsStatsStage {
2421
/** Number of shards in the snapshot that were successfully stored in the repository. */
2522
DONE = 0,

specification/sql/query/QuerySqlRequest.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import { Time } from '@_types/Time'
3333
export interface Request extends RequestBase {
3434
query_parameters: {
3535
/**
36-
* @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-format.html#sql-rest-format
36+
* @doc_id sql-rest-format
3737
*/
3838
format?: string
3939
}
@@ -51,7 +51,7 @@ export interface Request extends RequestBase {
5151
fetch_size?: integer
5252
/**
5353
* Optional Elasticsearch query DSL for additional filtering.
54-
* @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-filtering.html
54+
* @doc_id sql-rest-filtering
5555
* @server_default none
5656
*/
5757
filter?: QueryContainer

specification/watcher/_types/Action.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export enum ActionType {
6363

6464
export enum ActionExecutionMode {
6565
/**
66-
* The action execution is simulated. Each action type defines its own simulation operation mode. For example, the [email action](https://www.elastic.co/guide/en/elasticsearch/reference/current/actions-email.html) creates the email that would have been sent but does not actually send it. In this mode, the action might be throttled if the current state of the watch indicates it should be.
66+
* The action execution is simulated. Each action type defines its own simulation operation mode. For example, the email action creates the email that would have been sent but does not actually send it. In this mode, the action might be throttled if the current state of the watch indicates it should be.
6767
*/
6868
simulate,
6969
/**

specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export interface Request extends RequestBase {
4949
}
5050
body: {
5151
/**
52-
* Determines how to handle the watch actions as part of the watch execution. See [Action execution modes](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html#watcher-api-execute-watch-action-mode) for more information.
52+
* Determines how to handle the watch actions as part of the watch execution.
5353
*/
5454
action_modes?: Dictionary<string, ActionExecutionMode>
5555
/**
@@ -72,7 +72,7 @@ export interface Request extends RequestBase {
7272
*/
7373
trigger_data?: ScheduleTriggerEvent
7474
/**
75-
* When present, this [watch](https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html#watch-definition) is used instead of the one specified in the request. This watch is not persisted to the index and record_execution cannot be set.
75+
* When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and record_execution cannot be set.
7676
* @server_default null
7777
*/
7878
watch?: Watch

0 commit comments

Comments
 (0)