open_api_spex

v3.4.0

open_api_spex v3.4.0 OpenApiSpex.Paths View Source

Defines the OpenApiSpex.Paths.t type.

Link to this section Summary

Types

t()

Paths Object

Functions

from_router(router)

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

Link to this section Types

Link to this type

t() View Source 
t() :: %{optional(String.t()) => OpenApiSpex.PathItem.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 section Functions

Link to this function

from_router(router) View Source 
from_router(module()) :: t()

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