View Source ExOpenAI.Codegen.DocsParser.Parameter (ex_openai.ex v2.0.0-beta2)

Represents an OpenAPI parameter.

Summary

Functions

Parses a single parameter definition.

Parses a list of parameters.

Types

@type t() :: %ExOpenAI.Codegen.DocsParser.Parameter{
  allow_empty_value: boolean() | nil,
  allow_reserved: boolean() | nil,
  deprecated: boolean() | nil,
  description: String.t() | nil,
  example: any() | nil,
  examples: map() | nil,
  explode: boolean() | nil,
  in: String.t(),
  name: String.t(),
  required: boolean(),
  schema: map() | nil,
  style: String.t() | nil
}

Functions

@spec parse_parameter(map()) :: t()

Parses a single parameter definition.

Link to this function

parse_parameters(parameters)

View Source
@spec parse_parameters([map()] | nil) :: [t()] | nil

Parses a list of parameters.