Method: projects.locations.repositories.workspaces.commit

Applies a Git commit for uncommitted files in a Workspace.

HTTP request

POST https://dataform.googleapis.com/v1beta1/{name=projects/*/locations/*/repositories/*/workspaces/*}:commit

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The workspace's name.

Authorization requires the following IAM permission on the specified resource name:

  • dataform.workspaces.commit

Request body

The request body contains data with the following structure:

JSON representation 
{
  "author": {
    object (CommitAuthor)
  },
  "commitMessage": string,
  "paths": [
    string
  ]
}
Fields
author

object (CommitAuthor)

Required. The commit's author.
commitMessage

string

Optional. The commit's message.
paths[]

string

Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.

Response body

If successful, the response body is empty.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/bigquery

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • dataform.workspaces.commit

For more information, see the IAM documentation.