mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-10-22 05:26:23 +00:00
566bef0220
- Delete StartRunResponse, CancelRunResponse, SteerRunResponse, SubmitAnswerResponse; reuse RunStatusResponse for startRun/cancelRun, empty 202 for steerRun, 204/409 for submitRunAnswer - Make SubmitAnswerRequest.value and SteerRequest file/line optional - Type untyped schemas (checkpoint, retro, context) with oneOf/additionalProperties - Add pagination params to listRunQuestions, listRunStages, listRunVerifications - Rename retrieveRunSvg→retrieveRunGraph, listRunCompare→retrieveRunDiff, RunListItemStatus→BoardColumn - Preview URL response: 200→201 - Regenerate Rust types and TypeScript client Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
522 lines
26 KiB
TypeScript
522 lines
26 KiB
TypeScript
/* tslint:disable */
|
|
/* eslint-disable */
|
|
/**
|
|
* Arc Run API
|
|
* HTTP API for managing Arc workflow run executions.
|
|
*
|
|
* 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 type { Configuration } from '../configuration';
|
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
import globalAxios from 'axios';
|
|
// Some imports not used depending on template conditions
|
|
// @ts-ignore
|
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
// @ts-ignore
|
|
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
// @ts-ignore
|
|
import type { ErrorResponse } from '../models';
|
|
// @ts-ignore
|
|
import type { PaginatedRunList } from '../models';
|
|
// @ts-ignore
|
|
import type { RunStatusResponse } from '../models';
|
|
// @ts-ignore
|
|
import type { StartRunRequest } from '../models';
|
|
/**
|
|
* RunsApi - axios parameter creator
|
|
*/
|
|
export const RunsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
return {
|
|
/**
|
|
* Cancels a running or queued run. Returns 409 if the run has already completed or been cancelled.
|
|
* @summary Cancel Run
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
cancelRun: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('cancelRun', 'id', id)
|
|
const localVarPath = `/runs/{id}/cancel`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Returns a paginated list of runs for the board view, ordered by recency.
|
|
* @summary List Runs
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listRuns: async (pageLimit?: number, pageOffset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
const localVarPath = `/runs`;
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
if (pageLimit !== undefined) {
|
|
localVarQueryParameter['page[limit]'] = pageLimit;
|
|
}
|
|
|
|
if (pageOffset !== undefined) {
|
|
localVarQueryParameter['page[offset]'] = pageOffset;
|
|
}
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Returns the current status of a run, including error details and queue position if applicable.
|
|
* @summary Retrieve Run
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
retrieveRun: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('retrieveRun', 'id', id)
|
|
const localVarPath = `/runs/{id}`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Renders the workflow graph as an SVG image using Graphviz.
|
|
* @summary Render SVG
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
retrieveRunGraph: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('retrieveRunGraph', 'id', id)
|
|
const localVarPath = `/runs/{id}/graph`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'image/svg+xml,application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Queues a new workflow run from a DOT graph source. The run is created in `queued` status and will be picked up by the scheduler.
|
|
* @summary Start Run
|
|
* @param {StartRunRequest} startRunRequest
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
startRun: async (startRunRequest: StartRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'startRunRequest' is not null or undefined
|
|
assertParamExists('startRun', 'startRunRequest', startRunRequest)
|
|
const localVarPath = `/runs`;
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
localVarRequestOptions.data = serializeDataIfNeeded(startRunRequest, localVarRequestOptions, configuration)
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
/**
|
|
* Opens a server-sent event (SSE) stream for real-time run updates. Returns 410 if the stream has been closed.
|
|
* @summary Stream Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
streamRunEvents: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
// verify required parameter 'id' is not null or undefined
|
|
assertParamExists('streamRunEvents', 'id', id)
|
|
const localVarPath = `/runs/{id}/events`
|
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
let baseOptions;
|
|
if (configuration) {
|
|
baseOptions = configuration.baseOptions;
|
|
}
|
|
|
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
const localVarHeaderParameter = {} as any;
|
|
const localVarQueryParameter = {} as any;
|
|
|
|
// authentication mTLS required
|
|
await setApiKeyToObject(localVarHeaderParameter, "X-mTLS-Client-CN", configuration)
|
|
|
|
// authentication BearerAuth required
|
|
// http bearer authentication required
|
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
|
|
localVarHeaderParameter['Accept'] = 'text/event-stream,application/json';
|
|
|
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
|
|
return {
|
|
url: toPathString(localVarUrlObj),
|
|
options: localVarRequestOptions,
|
|
};
|
|
},
|
|
}
|
|
};
|
|
|
|
/**
|
|
* RunsApi - functional programming interface
|
|
*/
|
|
export const RunsApiFp = function(configuration?: Configuration) {
|
|
const localVarAxiosParamCreator = RunsApiAxiosParamCreator(configuration)
|
|
return {
|
|
/**
|
|
* Cancels a running or queued run. Returns 409 if the run has already completed or been cancelled.
|
|
* @summary Cancel Run
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async cancelRun(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunStatusResponse>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelRun(id, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunsApi.cancelRun']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Returns a paginated list of runs for the board view, ordered by recency.
|
|
* @summary List Runs
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async listRuns(pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedRunList>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRuns(pageLimit, pageOffset, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunsApi.listRuns']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Returns the current status of a run, including error details and queue position if applicable.
|
|
* @summary Retrieve Run
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async retrieveRun(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunStatusResponse>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveRun(id, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunsApi.retrieveRun']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Renders the workflow graph as an SVG image using Graphviz.
|
|
* @summary Render SVG
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async retrieveRunGraph(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveRunGraph(id, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunsApi.retrieveRunGraph']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Queues a new workflow run from a DOT graph source. The run is created in `queued` status and will be picked up by the scheduler.
|
|
* @summary Start Run
|
|
* @param {StartRunRequest} startRunRequest
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async startRun(startRunRequest: StartRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunStatusResponse>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.startRun(startRunRequest, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunsApi.startRun']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
/**
|
|
* Opens a server-sent event (SSE) stream for real-time run updates. Returns 410 if the stream has been closed.
|
|
* @summary Stream Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
async streamRunEvents(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
const localVarAxiosArgs = await localVarAxiosParamCreator.streamRunEvents(id, options);
|
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
const localVarOperationServerBasePath = operationServerMap['RunsApi.streamRunEvents']?.[localVarOperationServerIndex]?.url;
|
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
},
|
|
}
|
|
};
|
|
|
|
/**
|
|
* RunsApi - factory interface
|
|
*/
|
|
export const RunsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
const localVarFp = RunsApiFp(configuration)
|
|
return {
|
|
/**
|
|
* Cancels a running or queued run. Returns 409 if the run has already completed or been cancelled.
|
|
* @summary Cancel Run
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
cancelRun(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RunStatusResponse> {
|
|
return localVarFp.cancelRun(id, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Returns a paginated list of runs for the board view, ordered by recency.
|
|
* @summary List Runs
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
listRuns(pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedRunList> {
|
|
return localVarFp.listRuns(pageLimit, pageOffset, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Returns the current status of a run, including error details and queue position if applicable.
|
|
* @summary Retrieve Run
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
retrieveRun(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RunStatusResponse> {
|
|
return localVarFp.retrieveRun(id, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Renders the workflow graph as an SVG image using Graphviz.
|
|
* @summary Render SVG
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
retrieveRunGraph(id: string, options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
return localVarFp.retrieveRunGraph(id, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Queues a new workflow run from a DOT graph source. The run is created in `queued` status and will be picked up by the scheduler.
|
|
* @summary Start Run
|
|
* @param {StartRunRequest} startRunRequest
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
startRun(startRunRequest: StartRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<RunStatusResponse> {
|
|
return localVarFp.startRun(startRunRequest, options).then((request) => request(axios, basePath));
|
|
},
|
|
/**
|
|
* Opens a server-sent event (SSE) stream for real-time run updates. Returns 410 if the stream has been closed.
|
|
* @summary Stream Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
streamRunEvents(id: string, options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
return localVarFp.streamRunEvents(id, options).then((request) => request(axios, basePath));
|
|
},
|
|
};
|
|
};
|
|
|
|
/**
|
|
* RunsApi - object-oriented interface
|
|
*/
|
|
export class RunsApi extends BaseAPI {
|
|
/**
|
|
* Cancels a running or queued run. Returns 409 if the run has already completed or been cancelled.
|
|
* @summary Cancel Run
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public cancelRun(id: string, options?: RawAxiosRequestConfig) {
|
|
return RunsApiFp(this.configuration).cancelRun(id, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Returns a paginated list of runs for the board view, ordered by recency.
|
|
* @summary List Runs
|
|
* @param {number} [pageLimit] Maximum number of items to return per page.
|
|
* @param {number} [pageOffset] Number of items to skip before returning results.
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public listRuns(pageLimit?: number, pageOffset?: number, options?: RawAxiosRequestConfig) {
|
|
return RunsApiFp(this.configuration).listRuns(pageLimit, pageOffset, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Returns the current status of a run, including error details and queue position if applicable.
|
|
* @summary Retrieve Run
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public retrieveRun(id: string, options?: RawAxiosRequestConfig) {
|
|
return RunsApiFp(this.configuration).retrieveRun(id, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Renders the workflow graph as an SVG image using Graphviz.
|
|
* @summary Render SVG
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public retrieveRunGraph(id: string, options?: RawAxiosRequestConfig) {
|
|
return RunsApiFp(this.configuration).retrieveRunGraph(id, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Queues a new workflow run from a DOT graph source. The run is created in `queued` status and will be picked up by the scheduler.
|
|
* @summary Start Run
|
|
* @param {StartRunRequest} startRunRequest
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public startRun(startRunRequest: StartRunRequest, options?: RawAxiosRequestConfig) {
|
|
return RunsApiFp(this.configuration).startRun(startRunRequest, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
|
|
/**
|
|
* Opens a server-sent event (SSE) stream for real-time run updates. Returns 410 if the stream has been closed.
|
|
* @summary Stream Run Events
|
|
* @param {string} id Unique run identifier (ULID).
|
|
* @param {*} [options] Override http request option.
|
|
* @throws {RequiredError}
|
|
*/
|
|
public streamRunEvents(id: string, options?: RawAxiosRequestConfig) {
|
|
return RunsApiFp(this.configuration).streamRunEvents(id, options).then((request) => request(this.axios, this.basePath));
|
|
}
|
|
}
|
|
|