View Source OpenApiSpex.Paths (open_api_spex v3.21.1)

Defines the OpenApiSpex.Paths.t type.

Summary

Functions

from_router(router)

Create a Paths map from the routes in the given router module.

from_routes(routes)

Create a Paths map from a list of routes.

Types

path()

@type path() :: String.t()

Paths Object

Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due to ACL constraints.

t()

@type t() :: %{required(path()) => OpenApiSpex.PathItem.t()}

Functions

from_router(router)

@spec from_router(module()) :: t()

Create a Paths map from the routes in the given router module.

from_routes(routes)

@spec from_routes([OpenApiSpex.PathItem.route()]) :: t()

Create a Paths map from a list of routes.

Example

Paths.from_routes([
  %{path: "/v1/contacts", verb: :post, plug: MyAppWeb.V1.ContactController, plug_opts: :create}
])