OpenAPISchema extension type

OpenAPI / JSON Schema object.

This is the one OpenAPI type that is not always map-backed: it supports both object schemas and boolean schemas.

on

• Object

Constructors

OpenAPISchema.additional(Map<String, Object?> additional)

Wraps arbitrary JSON Schema object fields.

factory

OpenAPISchema.allOf(List<OpenAPISchema> schemas, {Map<String, Object?>? additional})

Creates an allOf schema.

factory

OpenAPISchema.anyOf(List<OpenAPISchema> schemas, {Map<String, Object?>? additional})

Creates an anyOf schema.

factory

OpenAPISchema.anything()

Creates a schema that matches everything.

factory

OpenAPISchema.array(OpenAPISchema items, {int? minItems, int? maxItems, String? description, Map<String, Object?>? additional})

Creates an array schema.

factory

OpenAPISchema.boolean({String? description, Map<String, Object?>? additional})

Creates a boolean schema.

factory

OpenAPISchema.integer({String? format, num? minimum, num? maximum, String? description, Map<String, Object?>? additional})

Creates an integer schema.

factory

OpenAPISchema.nothing()

Creates a schema that matches nothing.

factory

OpenAPISchema.null_({String? description, Map<String, Object?>? additional})

Creates a null schema.

factory

OpenAPISchema.nullable(OpenAPISchema schema)

Makes a schema nullable using OpenAPI 3.1 type: [T, 'null'].

factory

OpenAPISchema.number({num? minimum, num? maximum, String? description, Map<String, Object?>? additional})

Creates a number schema.

factory

OpenAPISchema.object(Map<String, OpenAPISchema> properties, {List<String>? requiredProperties, Object? additionalProperties, String? description, Map<String, Object?>? additional})

Creates an object schema.

factory

OpenAPISchema.oneOf(List<OpenAPISchema> schemas, {Map<String, Object?>? additional})

Creates a oneOf schema.

factory

OpenAPISchema.ref(String $ref)

Creates a $ref schema.

factory

OpenAPISchema.string({String? format, String? description, String? pattern, int? minLength, int? maxLength, Map<String, Object?>? additional})

Creates a string schema.

factory