@zlayer/api-client 0.10.86

package/docs/WorkflowsApi.md

@@ -0,0 +1,441 @@
+# WorkflowsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createWorkflow**](WorkflowsApi.md#createworkflowoperation) | **POST** /api/v1/workflows | Create a new workflow. Admin only. |
+| [**deleteWorkflow**](WorkflowsApi.md#deleteworkflow) | **DELETE** /api/v1/workflows/{id} | Delete a workflow. Admin only. |
+| [**getWorkflow**](WorkflowsApi.md#getworkflow) | **GET** /api/v1/workflows/{id} | Fetch a single workflow by id. |
+| [**listWorkflowRuns**](WorkflowsApi.md#listworkflowruns) | **GET** /api/v1/workflows/{id}/runs | List past runs for a workflow, most recent first. |
+| [**listWorkflows**](WorkflowsApi.md#listworkflows) | **GET** /api/v1/workflows | List workflows. |
+| [**runWorkflow**](WorkflowsApi.md#runworkflow) | **POST** /api/v1/workflows/{id}/run | Execute a workflow synchronously. Admin only. |
+
+
+
+## createWorkflow
+
+> StoredWorkflow createWorkflow(createWorkflowRequest)
+
+Create a new workflow. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, [`ApiError::BadRequest`] for an empty name or empty steps list, or [`ApiError::Internal`] when the workflow store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@zlayer/client';
+import type { CreateWorkflowOperationRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WorkflowsApi(config);
+
+  const body = {
+    // CreateWorkflowRequest
+    createWorkflowRequest: ...,
+  } satisfies CreateWorkflowOperationRequest;
+
+  try {
+    const data = await api.createWorkflow(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createWorkflowRequest** | [CreateWorkflowRequest](CreateWorkflowRequest.md) |  | |
+
+### Return type
+
+[**StoredWorkflow**](StoredWorkflow.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Workflow created |  -  |
+| **400** | Invalid request |  -  |
+| **403** | Admin role required |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteWorkflow
+
+> deleteWorkflow(id)
+
+Delete a workflow. Admin only.
+
+# Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the workflow does not exist, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@zlayer/client';
+import type { DeleteWorkflowRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WorkflowsApi(config);
+
+  const body = {
+    // string | Workflow id
+    id: id_example,
+  } satisfies DeleteWorkflowRequest;
+
+  try {
+    const data = await api.deleteWorkflow(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Workflow id | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Workflow deleted |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getWorkflow
+
+> StoredWorkflow getWorkflow(id)
+
+Fetch a single workflow by id.
+
+# Errors  Returns [`ApiError::NotFound`] if no workflow with the given id exists, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@zlayer/client';
+import type { GetWorkflowRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WorkflowsApi(config);
+
+  const body = {
+    // string | Workflow id
+    id: id_example,
+  } satisfies GetWorkflowRequest;
+
+  try {
+    const data = await api.getWorkflow(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Workflow id | [Defaults to `undefined`] |
+
+### Return type
+
+[**StoredWorkflow**](StoredWorkflow.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Workflow |  -  |
+| **404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listWorkflowRuns
+
+> Array<WorkflowRun> listWorkflowRuns(id)
+
+List past runs for a workflow, most recent first.
+
+# Errors  Returns [`ApiError::NotFound`] if the workflow does not exist, or [`ApiError::Internal`] when the store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@zlayer/client';
+import type { ListWorkflowRunsRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WorkflowsApi(config);
+
+  const body = {
+    // string | Workflow id
+    id: id_example,
+  } satisfies ListWorkflowRunsRequest;
+
+  try {
+    const data = await api.listWorkflowRuns(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Workflow id | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<WorkflowRun>**](WorkflowRun.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of workflow runs |  -  |
+| **404** | Workflow not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listWorkflows
+
+> Array<StoredWorkflow> listWorkflows()
+
+List workflows.
+
+# Errors  Returns [`ApiError::Internal`] if the workflow store fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@zlayer/client';
+import type { ListWorkflowsRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WorkflowsApi(config);
+
+  try {
+    const data = await api.listWorkflows();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<StoredWorkflow>**](StoredWorkflow.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of workflows |  -  |
+| **401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## runWorkflow
+
+> WorkflowRun runWorkflow(id)
+
+Execute a workflow synchronously. Admin only.
+
+Iterates steps sequentially: - `RunTask` — looks up the task and executes its `body` via `sh -c`. - `BuildProject` — clones / fast-forwards the project\'s git repo, then   registers and awaits a real buildah build. - `DeployProject` — reads the project\'s `deploy_spec_path` from its   checked-out working copy, parses it as a `DeploymentSpec`, and upserts   it into the deployment store. - `ApplySync` — delegates to [`apply_sync_inner`] for the real reconcile.  If a step fails and has an `on_failure` handler, that handler runs before the workflow aborts. Subsequent steps are marked `\"skipped\"`.  # Errors  Returns [`ApiError::Forbidden`] for non-admins, [`ApiError::NotFound`] when the workflow does not exist, or [`ApiError::Internal`] when execution or recording fails.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WorkflowsApi,
+} from '@zlayer/client';
+import type { RunWorkflowRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new WorkflowsApi(config);
+
+  const body = {
+    // string | Workflow id
+    id: id_example,
+  } satisfies RunWorkflowRequest;
+
+  try {
+    const data = await api.runWorkflow(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | Workflow id | [Defaults to `undefined`] |
+
+### Return type
+
+[**WorkflowRun**](WorkflowRun.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Workflow run result |  -  |
+| **403** | Admin role required |  -  |
+| **404** | Workflow not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@zlayer/api-client",
+  "version": "0.10.86",
+  "description": "Raw ZLayer REST API client (auto-generated from OpenAPI). For an ergonomic wrapper, use @zlayer/client.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BlackLeafDigital/ZLayer.git"
+  },
+  "license": "Apache-2.0"
+}

package/src/apis/AuditApi.ts

@@ -0,0 +1,97 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ZLayer API
+ * Container orchestration API for ZLayer
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  AuditEntry,
+} from '../models/index';
+import {
+    AuditEntryFromJSON,
+    AuditEntryToJSON,
+} from '../models/index';
+
+export interface ListAuditRequest {
+    user?: string | null;
+    resourceKind?: string | null;
+    since?: string | null;
+    until?: string | null;
+    limit?: number | null;
+}
+
+/**
+ * 
+ */
+export class AuditApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for listAudit without sending the request
+     */
+    async listAuditRequestOpts(requestParameters: ListAuditRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['user'] != null) {
+            queryParameters['user'] = requestParameters['user'];
+        }
+
+        if (requestParameters['resourceKind'] != null) {
+            queryParameters['resource_kind'] = requestParameters['resourceKind'];
+        }
+
+        if (requestParameters['since'] != null) {
+            queryParameters['since'] = requestParameters['since'];
+        }
+
+        if (requestParameters['until'] != null) {
+            queryParameters['until'] = requestParameters['until'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/api/v1/audit`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, or [`ApiError::Internal`] if the store fails.
+     * List audit log entries. Admin only.
+     */
+    async listAuditRaw(requestParameters: ListAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AuditEntry>>> {
+        const requestOptions = await this.listAuditRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AuditEntryFromJSON));
+    }
+
+    /**
+     * # Errors  Returns [`ApiError::Forbidden`] when the caller is not an admin, or [`ApiError::Internal`] if the store fails.
+     * List audit log entries. Admin only.
+     */
+    async listAudit(requestParameters: ListAuditRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AuditEntry>> {
+        const response = await this.listAuditRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}