Skip to content

Adds descriptions for cat anomaly detectors and cat datafeeds APIs #967

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.

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 3 commits into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 45 additions & 9 deletions output/schema/schema.json

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

6 changes: 2 additions & 4 deletions output/schema/validation-errors.json

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

6 changes: 4 additions & 2 deletions output/typescript/types.ts

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

29 changes: 28 additions & 1 deletion specification/cat/ml_datafeeds/CatDatafeedsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,44 @@

import { CatRequestBase } from '@cat/_types/CatBase'
import { Id } from '@_types/common'
import { TimeUnit } from '@_types/Time'

/**
* Returns configuration and usage information about datafeeds.
* This API returns a maximum of 10,000 datafeeds.
* If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
* cluster privileges to use this API.
* @rest_spec_name cat.ml_datafeeds
* @since 7.7.0
* @stability stable
* @cluster_privileges monitor_ml
*/
export interface Request extends CatRequestBase {
path_parts: {
/**
* A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase
* alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric
* characters.
*/
datafeed_id?: Id
}
query_parameters: {
allow_no_datafeeds?: boolean
/**
* Specifies what to do when the request:
*
* * Contains wildcard expressions and there are no datafeeds that match.
* * Contains the `_all` string or no identifiers and there are no matches.
* * Contains wildcard expressions and there are only partial matches.
*
* If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when
* there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only
* partial matches.
* @server_default true
*/
allow_no_match?: boolean
/**
* The unit used to display time values.
*/
time?: TimeUnit
}
}
30 changes: 29 additions & 1 deletion specification/cat/ml_jobs/CatJobsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,46 @@

import { CatRequestBase } from '@cat/_types/CatBase'
import { Bytes, Id } from '@_types/common'
import { TimeUnit } from '@_types/Time'

/**
* Returns configuration and usage information for anomaly detection jobs.
* This API returns a maximum of 10,000 jobs.
* If the Elasticsearch security features are enabled, you must have `monitor_ml`,
* `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.
* @rest_spec_name cat.ml_jobs
* @since 7.7.0
* @stability stable
* @cluster_privileges monitor_ml
*/
export interface Request extends CatRequestBase {
path_parts: {
/**
* Identifier for the anomaly detection job.
*/
job_id?: Id
}
query_parameters: {
allow_no_jobs?: boolean
/**
* Specifies what to do when the request:
*
* * Contains wildcard expressions and there are no jobs that match.
* * Contains the `_all` string or no identifiers and there are no matches.
* * Contains wildcard expressions and there are only partial matches.
*
* If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there
* are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial
* matches.
* @server_default true
*/
allow_no_match?: boolean
/**
* The unit used to display byte values.
*/
bytes?: Bytes
/**
* The unit used to display time values.
*/
time?: TimeUnit
}
}