DocumentationVersion class

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.
Documenting an API, DocumentationPart, DocumentationVersions

Constructors

DocumentationVersion({DateTime? createdDate, String? description, String? version})
DocumentationVersion.fromJson(Map<String, dynamic> json)
factory

Properties

createdDate DateTime?
The date when the API documentation snapshot is created.
final
description String?
The description of the API documentation snapshot.
final
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
version String?
The version identifier of the API documentation snapshot.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited