Skip to content

Commit 4012755

Browse files
yoshi-automationBenjamin E. Coe
authored andcommitted
fix(workflows): update the API
#### workflows:v1 The following keys were changed: - resources.projects.resources.locations.resources.workflows.methods.create.description - resources.projects.resources.locations.resources.workflows.methods.get.description - resources.projects.resources.locations.resources.workflows.methods.get.parameters.name.description - resources.projects.resources.locations.resources.workflows.methods.list.description - resources.projects.resources.locations.resources.workflows.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.workflows.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.workflows.methods.patch.description - schemas.ListWorkflowsResponse.properties.workflows.description - schemas.Workflow.properties.createTime.description - schemas.Workflow.properties.labels.description - schemas.Workflow.properties.revisionCreateTime.description - schemas.Workflow.properties.updateTime.description
1 parent ae68b4f commit 4012755

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

discovery/workflows-v1.json

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@
275275
"workflows": {
276276
"methods": {
277277
"create": {
278-
"description": "Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.",
278+
"description": "Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error.",
279279
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows",
280280
"httpMethod": "POST",
281281
"id": "workflows.projects.locations.workflows.create",
@@ -333,7 +333,7 @@
333333
]
334334
},
335335
"get": {
336-
"description": "Gets details of a single Workflow.",
336+
"description": "Gets details of a single workflow.",
337337
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}",
338338
"httpMethod": "GET",
339339
"id": "workflows.projects.locations.workflows.get",
@@ -342,7 +342,7 @@
342342
],
343343
"parameters": {
344344
"name": {
345-
"description": "Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}",
345+
"description": "Required. Name of the workflow for which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}",
346346
"location": "path",
347347
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$",
348348
"required": true,
@@ -358,7 +358,7 @@
358358
]
359359
},
360360
"list": {
361-
"description": "Lists Workflows in a given project and location. The default order is not specified.",
361+
"description": "Lists workflows in a given project and location. The default order is not specified.",
362362
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows",
363363
"httpMethod": "GET",
364364
"id": "workflows.projects.locations.workflows.list",
@@ -372,12 +372,12 @@
372372
"type": "string"
373373
},
374374
"orderBy": {
375-
"description": "Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a \" desc\" suffix. If not specified, the results will be returned in an unspecified order.",
375+
"description": "Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a \"desc\" suffix. If not specified, the results are returned in an unspecified order.",
376376
"location": "query",
377377
"type": "string"
378378
},
379379
"pageSize": {
380-
"description": "Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.",
380+
"description": "Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.",
381381
"format": "int32",
382382
"location": "query",
383383
"type": "integer"
@@ -404,7 +404,7 @@
404404
]
405405
},
406406
"patch": {
407-
"description": "Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.",
407+
"description": "Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions.",
408408
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}",
409409
"httpMethod": "PATCH",
410410
"id": "workflows.projects.locations.workflows.patch",
@@ -444,7 +444,7 @@
444444
}
445445
}
446446
},
447-
"revision": "20220406",
447+
"revision": "20221208",
448448
"rootUrl": "https://workflows.googleapis.com/",
449449
"schemas": {
450450
"Empty": {
@@ -505,7 +505,7 @@
505505
"type": "array"
506506
},
507507
"workflows": {
508-
"description": "The workflows which match the request.",
508+
"description": "The workflows that match the request.",
509509
"items": {
510510
"$ref": "Workflow"
511511
},
@@ -644,7 +644,7 @@
644644
"id": "Workflow",
645645
"properties": {
646646
"createTime": {
647-
"description": "Output only. The timestamp of when the workflow was created.",
647+
"description": "Output only. The timestamp for when the workflow was created.",
648648
"format": "google-datetime",
649649
"readOnly": true,
650650
"type": "string"
@@ -657,15 +657,15 @@
657657
"additionalProperties": {
658658
"type": "string"
659659
},
660-
"description": "Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.",
660+
"description": "Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed.",
661661
"type": "object"
662662
},
663663
"name": {
664664
"description": "The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}",
665665
"type": "string"
666666
},
667667
"revisionCreateTime": {
668-
"description": "Output only. The timestamp that the latest revision of the workflow was created.",
668+
"description": "Output only. The timestamp for the latest revision of the workflow's creation.",
669669
"format": "google-datetime",
670670
"readOnly": true,
671671
"type": "string"
@@ -697,7 +697,7 @@
697697
"type": "string"
698698
},
699699
"updateTime": {
700-
"description": "Output only. The last update timestamp of the workflow.",
700+
"description": "Output only. The timestamp for when the workflow was last updated.",
701701
"format": "google-datetime",
702702
"readOnly": true,
703703
"type": "string"

src/apis/workflows/v1.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ export namespace workflows_v1 {
167167
*/
168168
unreachable?: string[] | null;
169169
/**
170-
* The workflows which match the request.
170+
* The workflows that match the request.
171171
*/
172172
workflows?: Schema$Workflow[];
173173
}
@@ -268,23 +268,23 @@ export namespace workflows_v1 {
268268
*/
269269
export interface Schema$Workflow {
270270
/**
271-
* Output only. The timestamp of when the workflow was created.
271+
* Output only. The timestamp for when the workflow was created.
272272
*/
273273
createTime?: string | null;
274274
/**
275275
* Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
276276
*/
277277
description?: string | null;
278278
/**
279-
* Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
279+
* Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed.
280280
*/
281281
labels?: {[key: string]: string} | null;
282282
/**
283283
* The resource name of the workflow. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
284284
*/
285285
name?: string | null;
286286
/**
287-
* Output only. The timestamp that the latest revision of the workflow was created.
287+
* Output only. The timestamp for the latest revision of the workflow's creation.
288288
*/
289289
revisionCreateTime?: string | null;
290290
/**
@@ -304,7 +304,7 @@ export namespace workflows_v1 {
304304
*/
305305
state?: string | null;
306306
/**
307-
* Output only. The last update timestamp of the workflow.
307+
* Output only. The timestamp for when the workflow was last updated.
308308
*/
309309
updateTime?: string | null;
310310
}
@@ -1072,7 +1072,7 @@ export namespace workflows_v1 {
10721072
}
10731073

10741074
/**
1075-
* Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.
1075+
* Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error.
10761076
* @example
10771077
* ```js
10781078
* // Before running the sample:
@@ -1354,7 +1354,7 @@ export namespace workflows_v1 {
13541354
}
13551355

13561356
/**
1357-
* Gets details of a single Workflow.
1357+
* Gets details of a single workflow.
13581358
* @example
13591359
* ```js
13601360
* // Before running the sample:
@@ -1380,7 +1380,7 @@ export namespace workflows_v1 {
13801380
*
13811381
* // Do the magic
13821382
* const res = await workflows.projects.locations.workflows.get({
1383-
* // Required. Name of the workflow which information should be retrieved. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
1383+
* // Required. Name of the workflow for which information should be retrieved. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
13841384
* name: 'projects/my-project/locations/my-location/workflows/my-workflow',
13851385
* });
13861386
* console.log(res.data);
@@ -1489,7 +1489,7 @@ export namespace workflows_v1 {
14891489
}
14901490

14911491
/**
1492-
* Lists Workflows in a given project and location. The default order is not specified.
1492+
* Lists workflows in a given project and location. The default order is not specified.
14931493
* @example
14941494
* ```js
14951495
* // Before running the sample:
@@ -1517,9 +1517,9 @@ export namespace workflows_v1 {
15171517
* const res = await workflows.projects.locations.workflows.list({
15181518
* // Filter to restrict results to specific workflows.
15191519
* filter: 'placeholder-value',
1520-
* // Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.
1520+
* // Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "desc" suffix. If not specified, the results are returned in an unspecified order.
15211521
* orderBy: 'placeholder-value',
1522-
* // Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.
1522+
* // Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.
15231523
* pageSize: 'placeholder-value',
15241524
* // A page token, received from a previous `ListWorkflows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflows` must match the call that provided the page token.
15251525
* pageToken: 'placeholder-value',
@@ -1633,7 +1633,7 @@ export namespace workflows_v1 {
16331633
}
16341634

16351635
/**
1636-
* Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.
1636+
* Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions.
16371637
* @example
16381638
* ```js
16391639
* // Before running the sample:
@@ -1808,7 +1808,7 @@ export namespace workflows_v1 {
18081808
export interface Params$Resource$Projects$Locations$Workflows$Get
18091809
extends StandardParameters {
18101810
/**
1811-
* Required. Name of the workflow which information should be retrieved. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
1811+
* Required. Name of the workflow for which information should be retrieved. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
18121812
*/
18131813
name?: string;
18141814
}
@@ -1819,11 +1819,11 @@ export namespace workflows_v1 {
18191819
*/
18201820
filter?: string;
18211821
/**
1822-
* Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.
1822+
* Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "desc" suffix. If not specified, the results are returned in an unspecified order.
18231823
*/
18241824
orderBy?: string;
18251825
/**
1826-
* Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.
1826+
* Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.
18271827
*/
18281828
pageSize?: number;
18291829
/**

0 commit comments

Comments
 (0)