View Source OpenAPI.Processor.Schema (OpenAPI Generator v0.1.0-rc.4)
Processed schema used by the renderer
This struct is created by the Processor to hold only the data necessary for rendering schemas and their types. It has the following fields:
context
: List of contexts where the schema is found in the API description.fields
: List ofOpenAPI.Processor.Schema.Field.t/0
structs contained in the schema.module_name
: Name of the module where the schema will be defined.output_format
: Intended format of the output (ex. struct or typespec).ref
: Reference of the schema and its original spec in the processor state.type_name
: Name of the schema's type within its module.
All of this data is managed by the code generator, and it is unlikely that a callback would need to modify this struct directly.
Link to this section Summary
Link to this section Types
@type format() :: :struct | :type | :none
Format of rendering the schema (full struct or inline typespec)
@type t() :: %OpenAPI.Processor.Schema{ context: [tuple()], fields: [OpenAPI.Processor.Schema.Field.t()], module_name: module(), output_format: format() | nil, ref: reference(), type_name: atom() }
Processed schema used by the renderer