OpenApiTypesense.Plugins.Field (OpenApiTypesense v1.0.3)
View SourceProvides the Field struct that is used by the renderer
This struct is created by the Processor to hold only the data necessary for rendering fields and their types. It has the following fields:
name
: Name of the field in its parent schemanullable
: Whether the field is defined as nullableprivate
: Whether the field was added via theoutput.extra_fields
configurationrequired
: Whether the field is marked as required by its parent schematype
: Internal representation of the field's typedefault
: Default value provided by yaml openapi spec
Summary
Types
@type t() :: %OpenApiTypesense.Plugins.Field{ name: String.t(), nullable: boolean(), private: boolean(), required: boolean(), type: OpenAPI.Processor.Type.t() }
Processed field data used by the renderer