Skip to content

Commit 193f6b6

Browse files
authored
Adds descriptions to delete transform API (#1070) (#1071)
1 parent 2817bc6 commit 193f6b6

File tree

3 files changed

+23
-7
lines changed

3 files changed

+23
-7
lines changed

output/schema/schema.json

Lines changed: 10 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/transform/delete_transform/DeleteTransformRequest.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,28 @@
1818
*/
1919

2020
import { RequestBase } from '@_types/Base'
21-
import { Name } from '@_types/common'
21+
import { Id } from '@_types/common'
2222

2323
/**
24+
* Deletes a transform.
2425
* @rest_spec_name transform.delete_transform
2526
* @since 7.5.0
2627
* @stability stable
28+
* @cluster_privileges manage_transform
2729
*/
2830
export interface Request extends RequestBase {
2931
path_parts: {
30-
transform_id: Name
32+
/**
33+
* Identifier for the transform.
34+
*/
35+
transform_id: Id
3136
}
3237
query_parameters: {
38+
/**
39+
* If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
40+
* deleted regardless of its current state.
41+
* @server_default false
42+
*/
3343
force?: boolean
3444
}
3545
}

0 commit comments

Comments
 (0)