Merge pull request #977 from headlamp-k8s/cron-doc

frontend KubeCronJob: Created documentation comments
headlamp-k8s · Feb 22, 2023 · bb02e63 · bb02e63
2 parents 9bd28ca + f9fe584
commit bb02e63
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/frontend/src/lib/k8s/cronJob.ts b/frontend/src/lib/k8s/cronJob.ts
@@ -1,6 +1,13 @@
 import { apiFactoryWithNamespace } from './apiProxy';
 import { KubeObjectInterface, makeKubeObject } from './cluster';
 
+/**
+ * CronJob structure returned by the k8s API.
+ *
+ * @see {@link https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/cron-job-v1/} Kubernetes API reference for CronJob
+ *
+ * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/} Kubernetes definition for CronJob
+ */
 export interface KubeCronJob extends KubeObjectInterface {
   spec: {
     suspend: boolean;