@canyoncode/canyonos-sdk 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/schema.d.ts +8 -8
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -672,7 +672,7 @@ export interface paths {
672
672
  };
673
673
  /**
674
674
  * List the workflow groups
675
- * @description Every workflow group with an upload here or a Global Controller container, with the name its last PUT gave it, empty before one.
675
+ * @description Every workflow group with an upload here or a deploy (a Global Controller container on Docker, a CanyonProject on Kubernetes), with the name its last PUT gave it, empty before one.
676
676
  */
677
677
  get: operations['listWorkflowGroups'];
678
678
  put?: never;
@@ -697,13 +697,13 @@ export interface paths {
697
697
  get: operations['getWorkflowGroupStatus'];
698
698
  /**
699
699
  * Upload workflow_group.yaml and its .env
700
- * @description Writes `workflow_group.yaml` and the `.env` beside it into the Global Controller's /workspace, removing that `.env` when `env` is null, and keeps `name` as the workflow group's name. With `workflows`, removes the uploaded workflows it leaves out; with `api_key_hash`, keeps it as the API key its endpoint checks, none when it is empty. 409 when the CLI has not created the Global Controller container.
700
+ * @description Writes `workflow_group.yaml` and the `.env` beside it into the workflow group's workspace, removing that `.env` when `env` is null, and keeps `name` as the workflow group's name. With `workflows`, removes the uploaded workflows it leaves out; with `api_key_hash`, keeps it as the API key its endpoint checks, none when it is empty. On Docker, 409 `controller_missing` when the CLI has not created the Global Controller container. On Kubernetes, 403 unless the caller may update CanyonProjects in the namespace `config` names, and 409 `reupload_needed` for a PUT without `workflows` while the API holds none of the workflows, as after it restarted.
701
701
  */
702
702
  put: operations['putWorkflowGroup'];
703
703
  post?: never;
704
704
  /**
705
705
  * Stop the deploy and forget the upload
706
- * @description Waits for the apply loop to stop the deploy, then forgets the upload; 504 when it did not stop in time and 500 when stopping it failed, keeping the upload. A Global Controller this API holds no upload for is stopped all the same.
706
+ * @description Waits for the apply loop to stop the deploy, then forgets the upload; 504 when it did not stop in time and 500 when stopping it failed, keeping the upload. A deploy this API holds no upload for is stopped all the same.
707
707
  */
708
708
  delete: operations['deleteWorkflowGroup'];
709
709
  options?: never;
@@ -725,13 +725,13 @@ export interface paths {
725
725
  get: operations['getWorkflow'];
726
726
  /**
727
727
  * Upload a workflow
728
- * @description Checks the gzip tar of workflow `name` as `canyonos validate` does, then unpacks it into /workspace/<name>, removing what its last upload had and this one lacks; on a 400 (bad archive, unsafe path or findings) the old files stay.
728
+ * @description Checks the gzip tar of workflow `name` as `canyonos validate` does, then unpacks it into the workflow group's workspace, removing what its last upload had and this one lacks; on a 400 (bad archive, unsafe path or findings) the old files stay.
729
729
  */
730
730
  put: operations['putWorkflow'];
731
731
  post?: never;
732
732
  /**
733
733
  * Remove a workflow
734
- * @description Removes from /workspace what workflow `name`'s last upload put there; 404 if it was never uploaded.
734
+ * @description Removes from the workflow group's workspace what workflow `name`'s last upload put there; 404 if it was never uploaded.
735
735
  */
736
736
  delete: operations['deleteWorkflow'];
737
737
  options?: never;
@@ -768,7 +768,7 @@ export interface paths {
768
768
  };
769
769
  /**
770
770
  * Read the controller log
771
- * @description The Global Controller container's log since it last started, the last `tail` lines of it, as text; with `follow=true`, keeps streaming new lines until the container stops. Empty before it first starts.
771
+ * @description The deploy's log, the last `tail` lines of it, as text; with `follow=true`, keeps streaming new lines until the deploy stops. On Docker, the Global Controller container's log since it last started; on Kubernetes, the build pod's while it builds, then the Global Controller pod's. Empty before there is one.
772
772
  */
773
773
  get: operations['getControllerLog'];
774
774
  put?: never;
@@ -829,7 +829,7 @@ export interface paths {
829
829
  get?: never;
830
830
  /**
831
831
  * Register the workflow group's workflows with this dashboard
832
- * @description Registers the running deploy's Redis, and a client certificate its CA signs when its Redis takes only TLS, so the dashboard reads its workflows; returns them. Failures that may pass are retried for a minute; 502 when it is refused or never answers.
832
+ * @description Registers the running deploy's Redis, and a client certificate its CA signs when its Redis takes only TLS, so the dashboard reads its workflows; returns them. Failures that may pass are retried for a minute; 502 when it is refused or never answers. On Kubernetes the operator's registry already lists the workflow group: returns the workflows the dashboard knows of it.
833
833
  */
834
834
  put: operations['putWorkflowGroupDashboard'];
835
835
  post?: never;
@@ -960,7 +960,7 @@ export interface components {
960
960
  };
961
961
  WorkflowGroupError: {
962
962
  /** @enum {string} */
963
- error: 'auth.control_key_unset' | 'auth.missing_key' | 'auth.invalid_key' | 'workflow_groups.bad_archive' | 'workflow_groups.workflow_invalid' | 'workflow_groups.upload_too_large' | 'workflow_groups.unknown_workflow_group' | 'workflow_groups.unknown_workflow' | 'workflow_groups.unknown_agent' | 'workflow_groups.not_running' | 'workflow_groups.replicas_unreadable' | 'workflow_groups.stop_timeout' | 'workflow_groups.stop_failed' | 'workflow_groups.controller_missing' | 'workflow_groups.controller_failed' | 'workflow_groups.dashboard_unreachable' | 'workflow_groups.dashboard_refused' | 'docker.disabled' | 'docker.unavailable' | 'docker.timeout' | 'docker.error' | 'docker.not_found' | 'docker.conflict' | 'validation_error' | 'internal_error' | 'not_found';
963
+ error: 'auth.control_key_unset' | 'auth.missing_key' | 'auth.invalid_key' | 'auth.unauthenticated' | 'auth.forbidden' | 'workflow_groups.bad_archive' | 'workflow_groups.workflow_invalid' | 'workflow_groups.upload_too_large' | 'workflow_groups.unknown_workflow_group' | 'workflow_groups.unknown_workflow' | 'workflow_groups.unknown_agent' | 'workflow_groups.not_running' | 'workflow_groups.replicas_unreadable' | 'workflow_groups.stop_timeout' | 'workflow_groups.stop_failed' | 'workflow_groups.controller_missing' | 'workflow_groups.controller_failed' | 'workflow_groups.dashboard_unreachable' | 'workflow_groups.dashboard_refused' | 'workflow_groups.reupload_needed' | 'kubernetes.error' | 'docker.disabled' | 'docker.unavailable' | 'docker.timeout' | 'docker.error' | 'docker.not_found' | 'docker.conflict' | 'validation_error' | 'internal_error' | 'not_found';
964
964
  message: string;
965
965
  request_id?: string;
966
966
  findings?: string[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@canyoncode/canyonos-sdk",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Typed client for the CanyonOS REST API",
5
5
  "license": "AGPL-3.0-only",
6
6
  "type": "module",