A collection of path parameter definitions for Tesla.Middleware.PathParams.

Tesla.OpenAPI.PathParams keeps static path parameter metadata separate from per-request values. Since path parameter definitions usually come from a static operation specification, prefer defining the collection in a module attribute, storing it in Tesla.Env.private/0, and passing only the dynamic values through opts[:path_params].

defmodule MyApi.Operation.GetItem do
  alias Tesla.OpenAPI.{PathParam, PathParams}

  @path_params PathParams.new!([
                 PathParam.new!("id"),
                 PathParam.new!("coords", style: :matrix, explode: true)
               ])

  @private PathParams.put_private(@path_params)

  def request(client) do
    Tesla.get(client, "/items/{id}{coords}",
      opts: [path_params: %{"id" => 5, "coords" => ["blue", "black"]}],
      private: @private
    )
  end
end