open_api_spex v3.19.0

View Source OpenApiSpex.Paths (open_api_spex v3.19.0)

Defines the OpenApiSpex.Paths.t type.

Link to this section Summary

Types

path()

Paths Object

t()

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.

Link to this section Types

Link to this type

path()

View Source 
@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.

Link to this type

t()

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

Link to this section Functions

Link to this function

from_router(router)

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

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

Link to this function

from_routes(routes)

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

Create a Paths map from a list of routes.

example

 Example 

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