Skip to content

Commit 378b154

Browse files
szabostevedelvedor
authored andcommitted
[ML] Adds description to the DELETE DFA API spec (#538)
* [ML] Adds description to the DELETE DFA API spec. * [ML] Updates schema.
1 parent b19f280 commit 378b154

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
@@ -107706,6 +107706,7 @@
107706107706
},
107707107707
"path": [
107708107708
{
107709+
"description": "Identifier for the data frame analytics job.",
107709107710
"name": "id",
107710107711
"required": true,
107711107712
"type": {
@@ -107719,6 +107720,7 @@
107719107720
],
107720107721
"query": [
107721107722
{
107723+
"description": "If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.",
107722107724
"name": "force",
107723107725
"required": false,
107724107726
"serverDefault": false,
@@ -107731,6 +107733,7 @@
107731107733
}
107732107734
},
107733107735
{
107736+
"description": "The time to wait for the job to be deleted.",
107734107737
"name": "timeout",
107735107738
"required": false,
107736107739
"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)