Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "pack/k8s/kubernetes/api"

Index

Type aliases

K8sApiAction

K8sApiAction: "create" | "delete" | "list" | "patch" | "read" | "replace"

Kubernetes API verbs.

K8sRequestResponse

Union type of all response types.

Functions

appendName

  • Return whether the name of the resource should be appended to the API URI path. When creating and listing resources, it is not appended.

    Parameters

    Returns boolean

    true if name should be appended to URI

namespaceRequired

  • namespaceRequired(resource: V1APIResource, action: K8sApiAction): boolean
  • Return whether namespace must be included in resource API URI. It returns true of the resource is namespaced and the action is not "list". The namespace can be provided when the action is "list", but it need not be.

    Parameters

    Returns boolean

    true is the namespace is required in the API URI path

Generated using TypeDoc