Sign in

v1

latestOpenAPI 3.0.32026-07-13351892.0 KB
Registry

UpdateApiVersion can be used to modify a specified version.

patch/v1/projects/{project}/locations/{location}/apis/{api}/versions/{version}

Path parameters

projectstring required

The project id.

locationstring required

The location id.

apistring required

The api id.

versionstring required

The version id.

Query parameters

updateMaskstring field-mask

The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If a "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

allowMissingboolean

If set to true, and the version is not found, a new version will be created. In this situation, update_mask is ignored.

Request body

namestring

Resource name.

displayNamestring

Human-meaningful name.

descriptionstring

A detailed description.

createTimestring date-time

Output only. Creation timestamp.

updateTimestring date-time

Output only. Last update timestamp.

statestring

A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g. "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED".

labelsobject

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

annotationsobject

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

Response

OK

namestring

Resource name.

displayNamestring

Human-meaningful name.

descriptionstring

A detailed description.

createTimestring date-time

Output only. Creation timestamp.

updateTimestring date-time

Output only. Last update timestamp.

statestring

A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g. "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED".

labelsobject

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

annotationsobject

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.