spec_revisions

Creates, updates, deletes, gets or lists a spec_revisions resource.

Overview

Name	spec_revisions
Type	Resource
Id	google.apigeeregistry.spec_revisions

Fields

The following fields are returned by SELECT queries:

projects_locations_apis_versions_specs_list_revisions

Successful response

Name	Datatype	Description
name	string	Resource name.
annotations	object	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.
contents	string (byte)	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.
createTime	string (google-datetime)	Output only. Creation timestamp; when the spec resource was created.
description	string	A detailed description.
filename	string	A possibly-hierarchical name used to refer to the spec from other specs.
hash	string	Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
labels	object	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.
mimeType	string	A style (format) descriptor for this spec that is specified as a 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").
revisionCreateTime	string (google-datetime)	Output only. Revision creation timestamp; when the represented revision was created.
revisionId	string	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.
revisionUpdateTime	string (google-datetime)	Output only. Last update timestamp: when the represented revision was last modified.
sizeBytes	integer (int32)	Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
sourceUri	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_apis_versions_specs_list_revisions	select	projectsId, locationsId, apisId, versionsId, specsId	pageSize, pageToken, filter	Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.
projects_locations_apis_versions_specs_delete_revision	delete	projectsId, locationsId, apisId, versionsId, specsId		Deletes a revision of a spec.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
apisId	string
locationsId	string
projectsId	string
specsId	string
versionsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_apis_versions_specs_list_revisions

Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.

SELECT
name,
annotations,
contents,
createTime,
description,
filename,
hash,
labels,
mimeType,
revisionCreateTime,
revisionId,
revisionUpdateTime,
sizeBytes,
sourceUri
FROM google.apigeeregistry.spec_revisions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND versionsId = '{{ versionsId }}' -- required
AND specsId = '{{ specsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

DELETE examples

projects_locations_apis_versions_specs_delete_revision

Deletes a revision of a spec.

DELETE FROM google.apigeeregistry.spec_revisions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND versionsId = '{{ versionsId }}' --required
AND specsId = '{{ specsId }}' --required;