v1

latestOpenAPI 3.0.32026-07-13351892.0 KB
Registry

TagApiSpecRevision adds a tag to a specified revision of a spec.

post/v1/projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}:tagRevision

Path parameters

projectstring required

The project id.

locationstring required

The location id.

apistring required

The api id.

versionstring required

The version id.

specstring required

The spec id.

Request body

namestring required

Required. The name of the spec to be tagged, including the revision ID.

tagstring required

Required. The tag to apply. The tag should be at most 40 characters, and match [a-z][a-z0-9-]{3,39}.

Response

OK

namestring

Resource name.

filenamestring

A possibly-hierarchical name used to refer to the spec from other specs.

descriptionstring

A detailed description.

revisionIdstring

Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.

createTimestring date-time

Output only. Creation timestamp; when the spec resource was created.

revisionCreateTimestring date-time

Output only. Revision creation timestamp; when the represented revision was created.

revisionUpdateTimestring date-time

Output only. Last update timestamp: when the represented revision was last modified.

mimeTypestring

A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include "application/vnd.apigee.proto", "application/vnd.apigee.openapi", and "application/vnd.apigee.graphql", with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").

sizeBytesinteger

Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.

hashstring

Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.

sourceUristring

The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.

contentsstring bytes

Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.

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.