Packages

api_doc

0.0.1-pro1

0.1.3 0.1.2 0.1.1 0.1.0 0.0.1-pro1 0.0.1-pro0

API documentation generator for Elixir.

HexDocs

Current section

Files

Jump to

Readme 6 Versions 0 Dependencies Dependants Files Activity

api_doc lib doc response.ex

Raw

lib/doc/response.ex

defmodule APIDoc.Doc.Response do
  @moduledoc ~S"""

  """

  @typedoc @moduledoc
  @type t :: %__MODULE__{
          status: pos_integer | :default,
          description: String.t(),
          content: map
        }

  @enforce_keys [
    :status,
    :description,
    :content
  ]
  defstruct @enforce_keys
end

Search filters

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".