k8s v0.5.2 K8s.Operation.Path

Generates Kubernetes REST API Paths

Link to this section Summary

Functions

Generates the API path for a K8s.Operation.

Find valid path params in a URL path.

Replaces path variables with options.

Link to this section Functions

Link to this function

build(operation)

build(K8s.Operation.t()) ::
  {:ok, binary()} | {:error, :missing_required_param, [atom()]}

Generates the API path for a K8s.Operation.

Examples

Generate a path for a cluster scoped resource:

iex> resource = K8s.Resource.build("apps/v1", "CertificateSigningRequest", "foo")
...> operation = %K8s.Operation{
...>  method: :put,
...>  verb: :update,
...>  data: resource,
...>  path_params: [name: "foo"],
...>  api_version: "apps/v1",
...>  name: "certificatesigningrequests"
...> }
...> K8s.Operation.Path.build(operation)
{:ok, "/apis/apps/v1/certificatesigningrequests/foo"}

Generate a path for a namespace scoped resource:

iex> resource = K8s.Resource.build("v1", "Pod", "default", "foo")
...> operation = %K8s.Operation{
...>  method: :put,
...>  verb: :update,
...>  data: resource,
...>  path_params: [namespace: "default", name: "foo"],
...>  api_version: "v1",
...>  name: "pods"
...> }
...> K8s.Operation.Path.build(operation)
{:ok, "/api/v1/namespaces/default/pods/foo"}

Generate a path for a namespace scoped resource on the collection: (ie create, list)

iex> resource = K8s.Resource.build("v1", "Pod", "default", "foo")
...> operation = %K8s.Operation{
...>  method: :post,
...>  verb: :create,
...>  data: resource,
...>  path_params: [namespace: "default", name: "foo"],
...>  api_version: "v1",
...>  name: "pods"
...> }
...> K8s.Operation.Path.build(operation)
{:ok, "/api/v1/namespaces/default/pods"}

Generating a listing path for a namespace:

iex> operation = %K8s.Operation{
...>  method: :get,
...>  verb: :list,
...>  data: nil,
...>  path_params: [namespace: "default"],
...>  api_version: "v1",
...>  name: "pods"
...> }
...> K8s.Operation.Path.build(operation)
{:ok, "/api/v1/namespaces/default/pods"}

Generating a listing path for a all namespaces:

iex> operation = %K8s.Operation{
...>  method: :get,
...>  verb: :list_all_namespaces,
...>  data: nil,
...>  path_params: [namespace: "default"],
...>  api_version: "v1",
...>  name: "pods"
...> }
...> K8s.Operation.Path.build(operation)
{:ok, "/api/v1/pods"}

Generating a path for a subresource:

iex> operation = %K8s.Operation{
...>  method: :get,
...>  verb: :get,
...>  data: nil,
...>  path_params: [namespace: "default", name: "foo"],
...>  api_version: "v1",
...>  name: "pods/status"
...> }
...> K8s.Operation.Path.build(operation)
{:ok, "/api/v1/namespaces/default/pods/foo/status"}

Deleting a collection:

iex> operation = %K8s.Operation{
...>  method: :delete,
...>  verb: :deletecollection,
...>  data: nil,
...>  path_params: [namespace: "default"],
...>  api_version: "v1",
...>  name: "pods"
...> }
...> K8s.Operation.Path.build(operation)
{:ok, "/api/v1/namespaces/default/pods"}
Link to this function

find_params(path_with_args)

find_params(binary()) :: [atom()]

Find valid path params in a URL path.

Examples

iex> K8s.Operation.Path.find_params("/foo/{name}")
[:name]

iex> K8s.Operation.Path.find_params("/foo/{namespace}/bar/{name}")
[:namespace, :name]

iex> K8s.Operation.Path.find_params("/foo/bar")
[]
Link to this function

replace_path_vars(path_template, opts)

replace_path_vars(binary(), keyword(atom())) :: binary()

Replaces path variables with options.

Examples

iex> K8s.Operation.Path.replace_path_vars("/foo/{name}", name: "bar")
"/foo/bar"