Skip to content

Remove allow_no_jobs and allow_no_datafeeds #969

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 2 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
141 changes: 46 additions & 95 deletions output/schema/schema.json

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

9 changes: 8 additions & 1 deletion output/schema/validation-errors.json

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

15 changes: 5 additions & 10 deletions output/typescript/types.ts

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

4 changes: 0 additions & 4 deletions specification/ml/close_job/MlCloseJobRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,6 @@ export interface Request extends RequestBase {
* @server_default true
*/
allow_no_match?: boolean
/**
* @deprecated 7.10.0 Use `allow_no_match` instead.
*/
allow_no_jobs?: boolean
/**
* Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots.
* If you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future.
Expand Down
6 changes: 3 additions & 3 deletions specification/ml/get_job_stats/MlGetJobStatsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ export interface Request extends RequestBase {
* 2. Contains the _all string or no identifiers and there are no matches.
* 3. Contains wildcard expressions and there are only partial matches.
*
* The default value is `true`, which returns an empty `jobs` array when
* 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 this parameter is `false`, the request returns a `404` status
* matches. If `false`, the API returns a `404` status
* code when there are no matches or only partial matches.
* @server_default true
*/
allow_no_jobs?: boolean
allow_no_match?: boolean
}
}
4 changes: 0 additions & 4 deletions specification/ml/get_jobs/MlGetJobsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,6 @@ export interface Request extends RequestBase {
* @server_default true
*/
allow_no_match?: boolean
/**
* @deprecated 7.10.0
*/
allow_no_jobs?: boolean
/**
* Indicates if certain fields should be removed from the configuration on
* retrieval. This allows the configuration to be in an acceptable format to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,20 @@ export interface Request extends RequestBase {
job_id: Id
}
query_parameters: {
/**
* Specifies what to do when the request:
*
* 1. Contains wildcard expressions and there are no jobs that match.
* 2. Contains the `_all` string or no identifiers and there are no matches.
* 3. Contains wildcard expressions and there are only partial matches.
*
* If `true`, the request returns an empty `jobs` array when there are no
* matches and the subset of results when there are partial matches. If this
* parameter is `false`, the request returns a `404` status code when there
* are no matches or only partial matches.
* @server_default true
*/
allow_no_match?: boolean
/**
* The span of the overall buckets. Must be greater or equal to the largest
* bucket span of the specified anomaly detection jobs, which is the default
Expand All @@ -68,49 +82,29 @@ export interface Request extends RequestBase {
* the optional `bucket_span` parameter.
*/
bucket_span?: Time
/**
* Returns overall buckets with overall scores greater than or equal to this
* value.
*/
overall_score?: double | string
/**
* The number of top anomaly detection job bucket scores to be used in the
* `overall_score` calculation.
* @server_default 1
*/
top_n?: integer
/**
* Returns overall buckets with timestamps earlier than this time.
*/
end?: Time
/**
* Returns overall buckets with timestamps after this time.
*/
start?: Time
/**
* If `true`, the output excludes interim results.
* @server_default false
*/
exclude_interim?: boolean
/**
* Specifies what to do when the request:
*
* 1. Contains wildcard expressions and there are no jobs that match.
* 2. Contains the `_all` string or no identifiers and there are no matches.
* 3. Contains wildcard expressions and there are only partial matches.
*
* If `true`, the request returns an empty `jobs` array when there are no
* matches and the subset of results when there are partial matches. If this
* parameter is `false`, the request returns a `404` status code when there
* are no matches or only partial matches.
* @server_default true
* Returns overall buckets with overall scores greater than or equal to this
* value.
*/
allow_no_match?: boolean
}
body: {
overall_score?: double | string
/**
* @deprecated 7.10.0
* Returns overall buckets with timestamps after this time.
*/
allow_no_jobs?: boolean
start?: Time
/**
* The number of top anomaly detection job bucket scores to be used in the
* `overall_score` calculation.
* @server_default 1
*/
top_n?: integer
}
}