openapi

Types

Components

pub type Components {
  Components(schemas: List(#(String, schema.Schema)))
}

Constructors

Components(schemas: List(#(String, schema.Schema)))

Info

</>

pub type Info {
  Info(
    title: String,
    version: String,
    description: option.Option(String),
  )
}

Constructors

Info(
  title: String,
  version: String,
  description: option.Option(String),
)

OpenAPI

</>

pub type OpenAPI {
  OpenAPI(
    version: version.Version,
    info: Info,
    servers: List(Server),
    paths: List(#(String, PathItem)),
    components: option.Option(Components),
  )
}

Constructors

OpenAPI(
  version: version.Version,
  info: Info,
  servers: List(Server),
  paths: List(#(String, PathItem)),
  components: option.Option(Components),
)

PathItem

</>

pub type PathItem {
  PathItem(
    get: option.Option(operation.Operation),
    post: option.Option(operation.Operation),
    put: option.Option(operation.Operation),
    delete: option.Option(operation.Operation),
    patch: option.Option(operation.Operation),
  )
}

Constructors

PathItem(
  get: option.Option(operation.Operation),
  post: option.Option(operation.Operation),
  put: option.Option(operation.Operation),
  delete: option.Option(operation.Operation),
  patch: option.Option(operation.Operation),
)

Server

</>

pub type Server {
  Server(url: String)
}

Constructors

```
Server(url: String)
```

Values

from_json_string

</>

pub fn from_json_string(
  json_string: String,
) -> Result(OpenAPI, error.Error)

openapi_decoder

</>

pub fn openapi_decoder() -> decode.Decoder(OpenAPI)