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

Represents an OpenAPI path with its operations.

Summary

Types

t()

Functions

parse_path(path_string, data)

Parses a single path definition.

parse_paths(paths)

Parses paths section from OpenAPI specification.

Types

t()

@type t() :: %ExOpenAI.Codegen.DocsParser.Path{
  description: String.t() | nil,
  operations: %{
    required(String.t()) => ExOpenAI.Codegen.DocsParser.Operation.t()
  },
  parameters: [ExOpenAI.Codegen.DocsParser.Parameter.t()] | nil,
  path: String.t(),
  servers: [map()] | nil,
  summary: String.t() | nil
}

Functions

parse_path(path_string, data)

@spec parse_path(String.t(), map()) :: t()

Parses a single path definition.

parse_paths(paths)

@spec parse_paths(map() | nil) :: %{required(String.t()) => t()}

Parses paths section from OpenAPI specification.