ApiSpec class

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.

Constructors

ApiSpec({Map<String, String>? annotations, String? contents, String? createTime, String? description, String? filename, String? hash, Map<String, String>? labels, String? mimeType, String? name, String? revisionCreateTime, String? revisionId, String? revisionUpdateTime, int? sizeBytes, String? sourceUri})

ApiSpec.fromJson(Map json_)

Properties

annotations ↔ Map<String, String>?

Annotations attach non-identifying metadata to resources.

getter/setter pair

contents ↔ String?

Input only.

getter/setter pair

contentsAsBytes ↔ List<int>

getter/setter pair

createTime ↔ String?

Creation timestamp; when the spec resource was created.

getter/setter pair

description ↔ String?

A detailed description.

getter/setter pair

filename ↔ String?

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

getter/setter pair

hash ↔ String?

A SHA-256 hash of the spec's contents.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

labels ↔ Map<String, String>?

Labels attach identifying metadata to resources.

getter/setter pair

mimeType ↔ String?

A style (format) descriptor for this spec that is specified as a Media Type.

getter/setter pair

name ↔ String?

Resource name.

getter/setter pair

revisionCreateTime ↔ String?

Revision creation timestamp; when the represented revision was created.

getter/setter pair

revisionId ↔ String?

The revision ID of the spec.

getter/setter pair

revisionUpdateTime ↔ String?

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

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sizeBytes ↔ int?

The size of the spec file in bytes.

getter/setter pair

sourceUri ↔ String?

The original source URI of the spec (if one exists).

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited