OpenApiTypesense.Plugins.Field (OpenApiTypesense v1.0.3)

View Source

Provides 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 schema
  • nullable: Whether the field is defined as nullable
  • private: Whether the field was added via the output.extra_fields configuration
  • required: Whether the field is marked as required by its parent schema
  • type: Internal representation of the field's type
  • default: Default value provided by yaml openapi spec

Summary

Types

t()

Processed field data used by the renderer

Types

t()

@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