View Source OpenAPI.Reader.State (OpenAPI Generator v0.1.0-rc.3)

State of the reader phase of code generation

This struct is created at the beginning of the read phase using data from the overall OpenAPI.State. It is fully managed by the read phase, and it is unlikely that client libraries would read or write to this struct.

Link to this section Summary

Types

Decode function for raw Yaml

Decode function for raw Yaml

t()

OpenAPI reader state

Raw Yaml input

Link to this section Types

@type decoder() :: decoder(term())

Decode function for raw Yaml

@type decoder(t) :: (t, yaml() -> {map(), t})

Decode function for raw Yaml

@type t() :: %OpenAPI.Reader.State{
  base_file: String.t() | nil,
  base_file_path: [OpenAPI.Spec.path_segment()],
  config: OpenAPI.Reader.Config.t(),
  current_file: String.t() | nil,
  current_file_path: [OpenAPI.Spec.path_segment()],
  files: %{optional(String.t()) => yaml() | nil},
  last_ref_file: String.t() | nil,
  last_ref_path: [OpenAPI.Spec.path_segment()],
  path_parameters: [OpenAPI.Spec.Path.Parameter.t()],
  refs: %{optional(String.t()) => map()},
  schema_specs_by_path: %{
    required(OpenAPI.Spec.full_path()) => OpenAPI.Spec.Schema.t()
  },
  spec: OpenAPI.Spec.t() | nil
}

OpenAPI reader state

@type yaml() :: map() | list()

Raw Yaml input