View Source GoogleApi.ApigeeRegistry.V1.Model.ApiSpec (google_api_apigee_registry v0.4.0)

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

annotations (type: map(), default: nil) - 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 (type: String.t, default: nil) - 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 (type: DateTime.t, default: nil) - Output only. Creation timestamp; when the spec resource was created.
description (type: String.t, default: nil) - A detailed description.
filename (type: String.t, default: nil) - A possibly-hierarchical name used to refer to the spec from other specs.
hash (type: String.t, default: nil) - 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 (type: map(), default: nil) - 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 (type: String.t, default: nil) - 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").
name (type: String.t, default: nil) - Resource name.
revisionCreateTime (type: DateTime.t, default: nil) - Output only. Revision creation timestamp; when the represented revision was created.
revisionId (type: String.t, default: nil) - 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 (type: DateTime.t, default: nil) - Output only. Last update timestamp: when the represented revision was last modified.
sizeBytes (type: integer(), default: nil) - Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
sourceUri (type: String.t, default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ApigeeRegistry.V1.Model.ApiSpec{
  annotations: map() | nil,
  contents: String.t() | nil,
  createTime: DateTime.t() | nil,
  description: String.t() | nil,
  filename: String.t() | nil,
  hash: String.t() | nil,
  labels: map() | nil,
  mimeType: String.t() | nil,
  name: String.t() | nil,
  revisionCreateTime: DateTime.t() | nil,
  revisionId: String.t() | nil,
  revisionUpdateTime: DateTime.t() | nil,
  sizeBytes: integer() | nil,
  sourceUri: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.