SchemaOpenApi class

Implemented types
Available extensions
Annotations
  • @SpecsSerializable()

Constructors

SchemaOpenApi({String? title, String? description, Object? example, TypeOpenApi? type, FormatOpenApi? format, List<Object>? enum$, SchemaOpenApi? items, Map<String, SchemaOpenApi>? properties, SchemaOpenApi? additionalProperties, List<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 SchemaOpenApi?
With TypeOpenApi.object. It define a Map<String, *>
final
allOf List<SchemaOpenApi>?
final
allProperties Map<String, SchemaOpenApi>

Available on SchemaOpenApi, provided by the SchemaOpenApiX extension

no setter
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 SchemaOpenApi?
Must be present if the type is TypeOpenApi.array
final
nullable bool
final
properties Map<String, SchemaOpenApi>?
With TypeOpenApi.object
final
required List<String>?
With TypeOpenApi.object
final
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
fold<R>(R onRef(String ref), R on(SchemaOpenApi p1)) → R
override
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
toJson() Map<String, dynamic>
override
toString() String
A string representation of this object.
inherited

Operators

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