Skip to content

Commit

Permalink
fix(workflows): update the API
Browse files Browse the repository at this point in the history 
#### 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
  • Loading branch information
@yoshi-automation @bcoe
yoshi-automation authored and bcoe committed Dec 22, 2022
1 parent ae68b4f commit 4012755
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
26 changes: 13 additions & 13 deletions discovery/workflows-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@
"workflows": {
"methods": {
"create": {
"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.",
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows",
"httpMethod": "POST",
"id": "workflows.projects.locations.workflows.create",
Expand Down Expand Up @@ -333,7 +333,7 @@
]
},
"get": {
"description": "Gets details of a single Workflow.",
"description": "Gets details of a single workflow.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}",
"httpMethod": "GET",
"id": "workflows.projects.locations.workflows.get",
Expand All @@ -342,7 +342,7 @@
],
"parameters": {
"name": {
"description": "Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}",
"description": "Required. Name of the workflow for which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$",
"required": true,
Expand All @@ -358,7 +358,7 @@
]
},
"list": {
"description": "Lists Workflows in a given project and location. The default order is not specified.",
"description": "Lists workflows in a given project and location. The default order is not specified.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows",
"httpMethod": "GET",
"id": "workflows.projects.locations.workflows.list",
Expand All @@ -372,12 +372,12 @@
"type": "string"
},
"orderBy": {
"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.",
"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.",
"location": "query",
"type": "string"
},
"pageSize": {
"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.",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
Expand All @@ -404,7 +404,7 @@
]
},
"patch": {
"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.",
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}",
"httpMethod": "PATCH",
"id": "workflows.projects.locations.workflows.patch",
Expand Down Expand Up @@ -444,7 +444,7 @@
}
}
},
"revision": "20220406",
"revision": "20221208",
"rootUrl": "https://workflows.googleapis.com/",
"schemas": {
"Empty": {
Expand Down Expand Up @@ -505,7 +505,7 @@
"type": "array"
},
"workflows": {
"description": "The workflows which match the request.",
"description": "The workflows that match the request.",
"items": {
"$ref": "Workflow"
},
Expand Down Expand Up @@ -644,7 +644,7 @@
"id": "Workflow",
"properties": {
"createTime": {
"description": "Output only. The timestamp of when the workflow was created.",
"description": "Output only. The timestamp for when the workflow was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
Expand All @@ -657,15 +657,15 @@
"additionalProperties": {
"type": "string"
},
"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.",
"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.",
"type": "object"
},
"name": {
"description": "The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}",
"type": "string"
},
"revisionCreateTime": {
"description": "Output only. The timestamp that the latest revision of the workflow was created.",
"description": "Output only. The timestamp for the latest revision of the workflow's creation.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
Expand Down Expand Up @@ -697,7 +697,7 @@
"type": "string"
},
"updateTime": {
"description": "Output only. The last update timestamp of the workflow.",
"description": "Output only. The timestamp for when the workflow was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
Expand Down
30 changes: 15 additions & 15 deletions src/apis/workflows/v1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ export namespace workflows_v1 {
*/
unreachable?: string[] | null;
/**
* The workflows which match the request.
* The workflows that match the request.
*/
workflows?: Schema$Workflow[];
}
Expand Down Expand Up @@ -268,23 +268,23 @@ export namespace workflows_v1 {
*/
export interface Schema$Workflow {
/**
* Output only. The timestamp of when the workflow was created.
* Output only. The timestamp for when the workflow was created.
*/
createTime?: string | null;
/**
* Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
*/
description?: string | null;
/**
* 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.
* 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.
*/
labels?: {[key: string]: string} | null;
/**
* The resource name of the workflow. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
*/
name?: string | null;
/**
* Output only. The timestamp that the latest revision of the workflow was created.
* Output only. The timestamp for the latest revision of the workflow's creation.
*/
revisionCreateTime?: string | null;
/**
Expand All @@ -304,7 +304,7 @@ export namespace workflows_v1 {
*/
state?: string | null;
/**
* Output only. The last update timestamp of the workflow.
* Output only. The timestamp for when the workflow was last updated.
*/
updateTime?: string | null;
}
Expand Down Expand Up @@ -1072,7 +1072,7 @@ export namespace workflows_v1 {
}

/**
* 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.
* 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.
* @example
* ```js
* // Before running the sample:
Expand Down Expand Up @@ -1354,7 +1354,7 @@ export namespace workflows_v1 {
}

/**
* Gets details of a single Workflow.
* Gets details of a single workflow.
* @example
* ```js
* // Before running the sample:
Expand All @@ -1380,7 +1380,7 @@ export namespace workflows_v1 {
*
* // Do the magic
* const res = await workflows.projects.locations.workflows.get({
* // Required. Name of the workflow which information should be retrieved. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
* // Required. Name of the workflow for which information should be retrieved. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
* name: 'projects/my-project/locations/my-location/workflows/my-workflow',
* });
* console.log(res.data);
Expand Down Expand Up @@ -1489,7 +1489,7 @@ export namespace workflows_v1 {
}

/**
* Lists Workflows in a given project and location. The default order is not specified.
* Lists workflows in a given project and location. The default order is not specified.
* @example
* ```js
* // Before running the sample:
Expand Down Expand Up @@ -1517,9 +1517,9 @@ export namespace workflows_v1 {
* const res = await workflows.projects.locations.workflows.list({
* // Filter to restrict results to specific workflows.
* filter: 'placeholder-value',
* // 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.
* // 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.
* orderBy: 'placeholder-value',
* // 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.
* // 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.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
Expand Down Expand Up @@ -1633,7 +1633,7 @@ export namespace workflows_v1 {
}

/**
* 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.
* 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.
* @example
* ```js
* // Before running the sample:
Expand Down Expand Up @@ -1808,7 +1808,7 @@ export namespace workflows_v1 {
export interface Params$Resource$Projects$Locations$Workflows$Get
extends StandardParameters {
/**
* Required. Name of the workflow which information should be retrieved. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
* Required. Name of the workflow for which information should be retrieved. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}
*/
name?: string;
}
Expand All @@ -1819,11 +1819,11 @@ export namespace workflows_v1 {
*/
filter?: string;
/**
* 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.
* 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.
*/
orderBy?: string;
/**
* 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.
* 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.
*/
pageSize?: number;
/**
Expand Down

0 comments on commit 4012755

Please sign in to comment.