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

Represents an OpenAPI operation (HTTP method handler).

Summary

Functions

Parses a single operation definition.

Types

@type t() :: %ExOpenAI.Codegen.DocsParser.Operation{
  callbacks: map() | nil,
  deprecated: boolean() | nil,
  description: String.t() | nil,
  external_docs: map() | nil,
  method: String.t(),
  operation_id: String.t() | nil,
  parameters: [ExOpenAI.Codegen.DocsParser.Parameter.t()] | nil,
  request_body: ExOpenAI.Codegen.DocsParser.RequestBody.t() | nil,
  responses: %{required(String.t()) => ExOpenAI.Codegen.DocsParser.Response.t()},
  security: [map()] | nil,
  servers: [map()] | nil,
  summary: String.t() | nil,
  tags: [String.t()] | nil
}

Functions

Link to this function

parse_operation(method, data)

View Source
@spec parse_operation(String.t(), map()) :: t()

Parses a single operation definition.