Module utoipa::openapi::schema

Implements OpenAPI Schema Object types which can be used to define field properties, enum values, array or object types.

Structs

Array

Component represents Vec or slice type of items.

ArrayBuilder

Builder for Array with chainable configuration methods to create a new Array.

Components

Implements OpenAPI Components Object which holds supported reusable objects.

ComponentsBuilder

Builder for Components with chainable configuration methods to create a new Components.

Object

Implements subset of OpenAPI Schema Object which allows adding other Components as properties to this Component.

ObjectBuilder

Builder for Object with chainable configuration methods to create a new Object.

OneOf

OneOf Discriminator Object component holds multiple components together where API endpoint could return any of them.

OneOfBuilder

Builder for OneOf with chainable configuration methods to create a new OneOf.

Property

Implements special subset of OpenAPI Schema Object which can be used to define field property or enum values or type for array items.

PropertyBuilder

Builder for Property with chainable configuration methods to create a new Property.

Ref

Implements OpenAPI Reference Object that can be used to reference reusable components.

Enums

Component

Is super type for OpenAPI Schema Object components. Component is reusable resource what can be referenced from path operations and other components using Ref component.

ComponentFormat

Additional format for ComponentType to fine tune the data type used. If the format is not supported by the UI it may default back to ComponentType alone.

ComponentType

Represents data type of Component.

Traits

ToArray