APIDoc v0.0.1-pro0 APIDoc.Doc.Endpoint View Source

Link to this section Summary

Link to this section Types

Link to this type t() View Source
t() :: %APIDoc.Doc.Endpoint{
  description: String.t() | nil,
  id: String.t(),
  method: :get | :post | :put | :patch | :delete,
  parameters: [APIDoc.Doc.Param.t()],
  path: [String.t() | atom()],
  responses: [APIDoc.Doc.Response.t()],
  security: [atom() | [atom()]],
  summary: String.t(),
  tags: [String.t()]
}