Sign in

UpdateApi can be used to modify a specified API.

patch/v1/projects/{project}/apis/{api}

Path parameters

projectstring required

The project id.

apistring required

The api id.

Query parameters

update_maskstring

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.

Request body

namestring

Resource name.

display_namestring

Human-meaningful name.

descriptionstring

A detailed description.

create_timestring RFC3339

Creation timestamp.

update_timestring RFC3339

Last update timestamp.

availabilitystring

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g. "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

recommended_versionstring

The recommended version of the API. Format: apis/{api}/versions/{version}

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 "registry.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. Annotations are returned only when the FULL view is requested.

Response

OK

namestring

Resource name.

display_namestring

Human-meaningful name.

descriptionstring

A detailed description.

create_timestring RFC3339

Creation timestamp.

update_timestring RFC3339

Last update timestamp.

availabilitystring

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g. "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

recommended_versionstring

The recommended version of the API. Format: apis/{api}/versions/{version}

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 "registry.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. Annotations are returned only when the FULL view is requested.

Changes