Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13263478.2 KB
projects

Creates a specified spec.

post/v1/{+parent}/specs

Path parameters

parentstring required

Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*

Query parameters

apiSpecIdstring

Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.

Request body

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.

sizeBytesinteger

Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size 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.

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.

descriptionstring

A detailed description.

revisionUpdateTimestring google-datetime

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. 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").

filenamestring

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

contentsstring 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.

namestring

Resource name.

createTimestring google-datetime

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

revisionCreateTimestring google-datetime

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

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.

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

Successful response