ApiSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes a version of an API in a structured way. ApiSpecs provide formal descriptions that consumers can use to use a version. ApiSpec resources are intended to be fully-resolved descriptions of an ApiVersion. When specs consist of multiple files, these should be bundled together (e.g., in a zip archive) and stored as a unit. Multiple specs can exist to provide representations in different API description formats. Synchronization of these representations would be provided by tooling and background services.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Resource name. |
filename |
str
A possibly-hierarchical name used to refer to the spec from other specs. |
description |
str
A detailed description. |
revision_id |
str
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. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Creation timestamp; when the spec resource was created. |
revision_create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Revision creation timestamp; when the represented revision was created. |
revision_update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Last update timestamp: when the represented revision was last modified. |
mime_type |
str
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").
|
size_bytes |
int
Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec. |
hash_ |
str
Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec. |
source_uri |
str
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. |
contents |
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. |
labels |
MutableMapping[str, str]
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.
|
annotations |
MutableMapping[str, str]
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. |
Classes
AnnotationsEntry
AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |