Skip to content

Commit 2e7d354

Browse files
authored
[ML] Adds description to the DELETE DFA API spec (#538)
* [ML] Adds description to the DELETE DFA API spec. * [ML] Updates schema.
1 parent 3be4215 commit 2e7d354

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

output/schema/schema.json

+3
Original file line numberDiff line numberDiff line change
@@ -107712,6 +107712,7 @@
107712107712
},
107713107713
"path": [
107714107714
{
107715+
"description": "Identifier for the data frame analytics job.",
107715107716
"name": "id",
107716107717
"required": true,
107717107718
"type": {
@@ -107725,6 +107726,7 @@
107725107726
],
107726107727
"query": [
107727107728
{
107729+
"description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.",
107728107730
"name": "force",
107729107731
"required": false,
107730107732
"serverDefault": false,
@@ -107737,6 +107739,7 @@
107737107739
}
107738107740
},
107739107741
{
107742+
"description": "The time to wait for the job to be deleted.",
107740107743
"name": "timeout",
107741107744
"required": false,
107742107745
"serverDefault": "1m",

specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts

+11-2
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,21 @@ import { Time } from '@_types/Time'
2828
*/
2929
export interface Request extends RequestBase {
3030
path_parts?: {
31+
/**
32+
* Identifier for the data frame analytics job.
33+
*/
3134
id: Id
3235
}
3336
query_parameters?: {
34-
/** @server_default false */
37+
/**
38+
* If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.
39+
* @server_default false
40+
*/
3541
force?: boolean
36-
/** @server_default 1m */
42+
/**
43+
* The time to wait for the job to be deleted.
44+
* @server_default 1m
45+
*/
3746
timeout?: Time
3847
}
3948
}

0 commit comments

Comments
 (0)