open_api_spex v3.2.0 OpenApiSpex.OpenApi View Source

Defines the OpenApiSpex.OpenApi.t type.

Link to this section Summary

Types

t()

Link to this section Types

t() :: %OpenApiSpex.OpenApi{
  components: OpenApiSpex.Components.t() | nil,
  externalDocs: OpenApiSpex.ExternalDocumentation.t() | nil,
  info: OpenApiSpex.Info.t(),
  openapi: String.t(),
  paths: OpenApiSpex.Paths.t(),
  security: [OpenApiSpex.SecurityRequirement.t()] | nil,
  servers: [OpenApiSpex.Server.t()] | nil,
  tags: [OpenApiSpex.Tag.t()] | nil
}

OpenAPI Object

This is the root document object of the OpenAPI document.