APISchemaObject class

Represents a schema object in the OpenAPI specification.

Inheritance

Constructors

APISchemaObject()
APISchemaObject.array({APIType ofType, APISchemaObject ofSchema })
APISchemaObject.boolean()
APISchemaObject.empty()
APISchemaObject.file({bool isBase64Encoded: false })
APISchemaObject.freeForm()
APISchemaObject.integer()
APISchemaObject.map({APIType ofType, APISchemaObject ofSchema, bool any: false })
APISchemaObject.number()
APISchemaObject.object(Map<String, APISchemaObject> properties)
APISchemaObject.string({String format })

Properties

additionalPropertyPolicy APISchemaAdditionalPropertyPolicy
read / write
additionalPropertySchema APISchemaObject
read / write
allOf ↔ List<APISchemaObject>
read / write
anyOf ↔ List<APISchemaObject>
read / write
castMap → Map<String, Cast>
read-only, override
defaultValue ↔ dynamic
read / write
description ↔ String
read / write
enumerated ↔ List
The value of this keyword MUST be an array. This array SHOULD have at least one element. Elements in the array SHOULD be unique. [...]
read / write
exclusiveMaximum ↔ bool
The value of "exclusiveMaximum" MUST be a boolean, representing whether the limit in "maximum" is exclusive or not. [...]
read / write
exclusiveMinimum ↔ bool
The value of "exclusiveMinimum" MUST be a boolean, representing whether the limit in "minimum" is exclusive or not. An undefined value is the same as false. If "exclusiveMinimum" is true, then a numeric instance SHOULD NOT be equal to the value specified in "minimum". If "exclusiveMinimum" is false (or not specified), then a numeric instance MAY be equal to the value of "minimum".
read / write
format ↔ String
read / write
isDeprecated ↔ bool
read / write
isNullable ↔ bool
read / write
isReadOnly ↔ bool
read / write
isWriteOnly ↔ bool
read / write
items APISchemaObject
read / write
maximum ↔ num
The value of "maximum" MUST be a number, representing an upper limit for a numeric instance. [...]
read / write
maxItems ↔ int
The value of this keyword MUST be an integer. This integer MUST be greater than, or equal to, 0. [...]
read / write
maxLength ↔ int
The value of this keyword MUST be a non-negative integer. [...]
read / write
maxProperties ↔ int
The value of this keyword MUST be an integer. This integer MUST be greater than, or equal to, 0. [...]
read / write
minimum ↔ num
The value of "minimum" MUST be a number, representing a lower limit for a numeric instance. If the instance is a number, then this keyword validates if "exclusiveMinimum" is true and instance is greater than the provided value, or else if the instance is greater than or exactly equal to the provided value.
read / write
minItems ↔ int
The value of this keyword MUST be an integer. This integer MUST be greater than, or equal to, 0. [...]
read / write
minLength ↔ int
A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword. [...]
read / write
minProperties ↔ int
The value of this keyword MUST be an integer. This integer MUST be greater than, or equal to, 0. [...]
read / write
multipleOf ↔ num
The value of "multipleOf" MUST be a number, strictly greater than 0. A numeric instance is only valid if division by this keyword's value results in an integer.
read / write
not APISchemaObject
read / write
oneOf ↔ List<APISchemaObject>
read / write
pattern ↔ String
The value of this keyword MUST be a string. This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. [...]
read / write
properties ↔ Map<String, APISchemaObject>
read / write
required ↔ List<String>
The value of this keyword MUST be an array. This array MUST have at least one element. Elements of this array MUST be strings, and MUST be unique. [...]
read / write
title ↔ String
A title for the object.
read / write
type APIType
read / write
uniqueItems ↔ bool
The value of this keyword MUST be a boolean. [...]
read / write
extensions ↔ Map<String, dynamic>
read / write, inherited
hashCode → int
The hash code for this object.
read-only, inherited
referenceURI ↔ Uri
read / write, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

decode(KeyedArchive object) → void
override
encode(KeyedArchive object) → void
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited