Skip to main content
Module

x/k8s_fetch/index.ts>K8sApiPathsWithCrd

JavaScript Fetch Client (Deno + node.js) for Kubernetes APIs
shopstic/k8s-fetch
Latest
type alias K8sApiPathsWithCrd
import { type K8sApiPathsWithCrd } from "https://deno.land/x/k8s_fetch@1.1.0/index.ts";

Type Parameters

Paths
Def extends { apiVersion: string; kind: string; }
optional
PluralName extends string = DeriveCrdPluralName<Def>
optional
Version extends string = ExtractCrdApiVersion<Def>
optional
Kind extends string = ExtractCrdKind<Def>
optional
ListDef = { apiVersion: Version; kind: `${Kind}List`; metadata: { continue: string; resourceVersion: string; }; items: Def[]; }
definition:
& [path in `/apis/${Version}/${PluralName}`]: { get: { parameters: { query: K8sApiGetQuery; }; responses: { 200: { schema: ListDef; }; 401: unknown; }; }; post: { parameters: { path: K8sApiPathNamespace; query: K8sApiPutOrPostQuery; body: { body: Def; }; }; responses: { 200: { schema: Def; }; 201: { schema: Def; }; 202: { schema: Def; }; 401: unknown; }; }; }
& [path in `/apis/${Version}/namespaces/{namespace}/${PluralName}`]: { get: { parameters: { path: K8sApiPathNamespace; query: K8sApiGetQuery; }; responses: { 200: { schema: ListDef; }; 401: unknown; }; }; post: { parameters: { path: K8sApiPathNamespace; query: { pretty?: string; dryRun?: string; fieldManager?: string; }; body: { body: Def; }; }; responses: { 200: { schema: Def; }; 201: { schema: Def; }; 202: { schema: Def; }; 401: unknown; }; }; }
& [path in `/apis/${Version}/namespaces/{namespace}/${PluralName}/{name}`]: { get: { parameters: { path: K8sApiPathNameAndNamespace; query: { pretty?: string; }; }; responses: { 200: { schema: Def; }; 401: unknown; }; }; put: { parameters: { path: K8sApiPathNameAndNamespace; query: K8sApiPutOrPostQuery; body: { body: Def; }; }; responses: { 200: { schema: Def; }; 201: { schema: Def; }; 401: unknown; }; }; patch: { parameters: { path: K8sApiPathNameAndNamespace; query: K8sApiPatchQuery; body: { body: K8s["io.k8s.apimachinery.pkg.apis.meta.v1.Patch"]; }; }; responses: { 200: { schema: Def; }; 201: { schema: Def; }; 401: unknown; }; }; delete: { parameters: { path: K8sApiPathNameAndNamespace; query: K8sApiDeleteQuery; body: { body: K8s["io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions"]; }; }; responses: { 200: { schema: K8s["io.k8s.apimachinery.pkg.apis.meta.v1.Status"]; }; 202: { schema: K8s["io.k8s.apimachinery.pkg.apis.meta.v1.Status"]; }; 401: unknown; }; }; }