SchemaOpenApi class

Implemented types
Available extensions
Annotations
  • @SpecsSerializable.new()

Constructors

SchemaOpenApi({Map? originalJson, String? name, String? title, String? description, Object? example, TypeOpenApi? type, FormatOpenApi? format, List<Object>? enum$, RefOr<SchemaOpenApi>? items, Map<String, RefOr<SchemaOpenApi>>? properties, RefOr<SchemaOpenApi>? additionalProperties, List<RefOr<SchemaOpenApi>>? allOf, List<String>? required, bool nullable = false, Object? default$, Object? $original, bool? uniqueItems})
const
SchemaOpenApi.fromJson(Map map)
factory

Properties

$original → Object?
final
additionalProperties → RefOr<SchemaOpenApi>?
With TypeOpenApi.object. It define a Map<String, *>
final
allOf → List<RefOr<SchemaOpenApi>>?
final
default$ → Object?
final
description → String?
final
enum$ → List<Object>?
With TypeOpenApi.integer | TypeOpenApi.string
final
example → Object?
final
format → FormatOpenApi?
final
hashCode → int
The hash code for this object.
no setterinherited
isClass → bool

Available on SchemaOpenApi, provided by the SchemaOpenApiX extension

no setter
isEnum → bool

Available on SchemaOpenApi, provided by the SchemaOpenApiX extension

no setter
items → RefOr<SchemaOpenApi>?
Must be present if the type is TypeOpenApi.array
final
name → String?
final
nullable → bool
final
originalJson → Map?
finalinherited
properties → Map<String, RefOr<SchemaOpenApi>>?
With TypeOpenApi.object
final
required → List<String>?
With TypeOpenApi.object
final
requireName → String
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
title → String?
final
type → TypeOpenApi?
final
uniqueItems → bool?
Json Properties
final

Methods

canNull(String name, SchemaOpenApi schema) → bool

Available on SchemaOpenApi, provided by the SchemaOpenApiX extension

A schema contains this property A property name
ensureIsNotNull<T>(String fieldName, T? value) → T
inherited
isRequired(String name) → bool

Available on SchemaOpenApi, provided by the SchemaOpenApiX extension

A schema contains this property A property name
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resolve(ComponentsOpenApi components) → SchemaOpenApi
override
resolveAllOf(ComponentsOpenApi components) → List<SchemaOpenApi>?

Available on SchemaOpenApi, provided by the SchemaOpenApiX extension

resolveAllProperties(ComponentsOpenApi components) → Map<String, SchemaOpenApi>

Available on SchemaOpenApi, provided by the SchemaOpenApiX extension

resolveProperties(ComponentsOpenApi components) → Map<String, SchemaOpenApi>?

Available on SchemaOpenApi, provided by the SchemaOpenApiX extension

toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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