Module utoipa::openapi::schema

source ·
Expand description

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

Structs

AllOf Composite Object component holds multiple components together where API endpoint will return a combination of all of them.
Builder for AllOf with chainable configuration methods to create a new AllOf.
Array represents Vec or slice type of items.
Builder for Array with chainable configuration methods to create a new Array.
Implements OpenAPI Components Object which holds supported reusable objects.
Builder for Components with chainable configuration methods to create a new Components.
OpenAPI Discriminator object which can be optionally used together with OneOf composite object.
Implements subset of OpenAPI Schema Object which allows adding other Schemas as properties to this Schema.
Builder for Object with chainable configuration methods to create a new Object.
OneOf Composite Object component holds multiple components together where API endpoint could return any of them.
Builder for OneOf with chainable configuration methods to create a new OneOf.
Implements OpenAPI Reference Object that can be used to reference reusable components such as Schemas or Responses.

Enums

Is super type for OpenAPI Schema Object. Schema is reusable resource what can be referenced from path operations and other components using Ref.
Additional format for SchemaType to fine tune the data type used. If the format is not supported by the UI it may default back to SchemaType alone. Format is an open value, so you can use any formats, even not those defined by the OpenAPI Specification.
Represents data type of Schema.

Traits