diff --git a/docs/api-reference/arc-api.yaml b/docs/api-reference/arc-api.yaml index 4aed6f950..55b2f95a6 100644 --- a/docs/api-reference/arc-api.yaml +++ b/docs/api-reference/arc-api.yaml @@ -118,7 +118,7 @@ paths: get: operationId: retrieveRunSvg tags: [Runs] - summary: Retrieve Run SVG + summary: Render SVG parameters: - $ref: "#/components/parameters/RunId" responses: @@ -304,7 +304,7 @@ paths: /runs/{id}/files: get: operationId: listRunFiles - tags: [Runs] + tags: [Run Outputs] summary: List Run Files parameters: - $ref: "#/components/parameters/RunId" @@ -343,7 +343,7 @@ paths: /runs/{id}/verifications: get: operationId: listRunVerifications - tags: [Runs] + tags: [Run Outputs] summary: List Run Verifications parameters: - $ref: "#/components/parameters/RunId" diff --git a/openapi/arc-api.yaml b/openapi/arc-api.yaml index 4aed6f950..55b2f95a6 100644 --- a/openapi/arc-api.yaml +++ b/openapi/arc-api.yaml @@ -118,7 +118,7 @@ paths: get: operationId: retrieveRunSvg tags: [Runs] - summary: Retrieve Run SVG + summary: Render SVG parameters: - $ref: "#/components/parameters/RunId" responses: @@ -304,7 +304,7 @@ paths: /runs/{id}/files: get: operationId: listRunFiles - tags: [Runs] + tags: [Run Outputs] summary: List Run Files parameters: - $ref: "#/components/parameters/RunId" @@ -343,7 +343,7 @@ paths: /runs/{id}/verifications: get: operationId: listRunVerifications - tags: [Runs] + tags: [Run Outputs] summary: List Run Verifications parameters: - $ref: "#/components/parameters/RunId" diff --git a/packages/arc-api-client/src/.openapi-generator/FILES b/packages/arc-api-client/src/.openapi-generator/FILES index d4b401749..e7ed17539 100644 --- a/packages/arc-api-client/src/.openapi-generator/FILES +++ b/packages/arc-api-client/src/.openapi-generator/FILES @@ -4,6 +4,7 @@ api/insights-api.ts api/projects-api.ts api/retros-api.ts api/run-internals-api.ts +api/run-outputs-api.ts api/runs-api.ts api/sandbox-api.ts api/sessions-api.ts diff --git a/packages/arc-api-client/src/api.ts b/packages/arc-api-client/src/api.ts index bf713788d..26df0ad42 100644 --- a/packages/arc-api-client/src/api.ts +++ b/packages/arc-api-client/src/api.ts @@ -19,6 +19,7 @@ export * from './api/insights-api'; export * from './api/projects-api'; export * from './api/retros-api'; export * from './api/run-internals-api'; +export * from './api/run-outputs-api'; export * from './api/runs-api'; export * from './api/sandbox-api'; export * from './api/sessions-api'; diff --git a/packages/arc-api-client/src/api/run-outputs-api.ts b/packages/arc-api-client/src/api/run-outputs-api.ts new file mode 100644 index 000000000..ece37adf9 --- /dev/null +++ b/packages/arc-api-client/src/api/run-outputs-api.ts @@ -0,0 +1,202 @@ +/* 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 { RunFiles } from '../models'; +// @ts-ignore +import type { RunVerification } from '../models'; +/** + * RunOutputsApi - axios parameter creator + */ +export const RunOutputsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary List Run Files + * @param {string} id + * @param {string} [checkpoint] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listRunFiles: async (id: string, checkpoint?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listRunFiles', 'id', id) + const localVarPath = `/runs/{id}/files` + .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; + + if (checkpoint !== undefined) { + localVarQueryParameter['checkpoint'] = checkpoint; + } + + 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, + }; + }, + /** + * + * @summary List Run Verifications + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listRunVerifications: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listRunVerifications', 'id', id) + const localVarPath = `/runs/{id}/verifications` + .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; + + 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, + }; + }, + } +}; + +/** + * RunOutputsApi - functional programming interface + */ +export const RunOutputsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = RunOutputsApiAxiosParamCreator(configuration) + return { + /** + * + * @summary List Run Files + * @param {string} id + * @param {string} [checkpoint] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listRunFiles(id: string, checkpoint?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listRunFiles(id, checkpoint, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RunOutputsApi.listRunFiles']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary List Run Verifications + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listRunVerifications(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listRunVerifications(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RunOutputsApi.listRunVerifications']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * RunOutputsApi - factory interface + */ +export const RunOutputsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = RunOutputsApiFp(configuration) + return { + /** + * + * @summary List Run Files + * @param {string} id + * @param {string} [checkpoint] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listRunFiles(id: string, checkpoint?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listRunFiles(id, checkpoint, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary List Run Verifications + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listRunVerifications(id: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listRunVerifications(id, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * RunOutputsApi - object-oriented interface + */ +export class RunOutputsApi extends BaseAPI { + /** + * + * @summary List Run Files + * @param {string} id + * @param {string} [checkpoint] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + public listRunFiles(id: string, checkpoint?: string, options?: RawAxiosRequestConfig) { + return RunOutputsApiFp(this.configuration).listRunFiles(id, checkpoint, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary List Run Verifications + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + public listRunVerifications(id: string, options?: RawAxiosRequestConfig) { + return RunOutputsApiFp(this.configuration).listRunVerifications(id, options).then((request) => request(this.axios, this.basePath)); + } +} + diff --git a/packages/arc-api-client/src/api/runs-api.ts b/packages/arc-api-client/src/api/runs-api.ts index 997b31423..ff49aa173 100644 --- a/packages/arc-api-client/src/api/runs-api.ts +++ b/packages/arc-api-client/src/api/runs-api.ts @@ -26,14 +26,10 @@ import type { CancelRun200Response } from '../models'; // @ts-ignore import type { ErrorResponse } from '../models'; // @ts-ignore -import type { RunFiles } from '../models'; -// @ts-ignore import type { RunListItem } from '../models'; // @ts-ignore import type { RunStatusResponse } from '../models'; // @ts-ignore -import type { RunVerification } from '../models'; -// @ts-ignore import type { StartRunRequest } from '../models'; // @ts-ignore import type { StartRunResponse } from '../models'; @@ -76,79 +72,6 @@ export const RunsApiAxiosParamCreator = function (configuration?: Configuration) options: localVarRequestOptions, }; }, - /** - * - * @summary List Run Files - * @param {string} id - * @param {string} [checkpoint] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listRunFiles: async (id: string, checkpoint?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listRunFiles', 'id', id) - const localVarPath = `/runs/{id}/files` - .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; - - if (checkpoint !== undefined) { - localVarQueryParameter['checkpoint'] = checkpoint; - } - - 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, - }; - }, - /** - * - * @summary List Run Verifications - * @param {string} id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listRunVerifications: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listRunVerifications', 'id', id) - const localVarPath = `/runs/{id}/verifications` - .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; - - 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, - }; - }, /** * * @summary List Runs @@ -215,7 +138,7 @@ export const RunsApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @summary Retrieve Run SVG + * @summary Render SVG * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -338,33 +261,6 @@ export const RunsApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['RunsApi.cancelRun']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, - /** - * - * @summary List Run Files - * @param {string} id - * @param {string} [checkpoint] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listRunFiles(id: string, checkpoint?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRunFiles(id, checkpoint, options); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RunsApi.listRunFiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List Run Verifications - * @param {string} id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listRunVerifications(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRunVerifications(id, options); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RunsApi.listRunVerifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, /** * * @summary List Runs @@ -392,7 +288,7 @@ export const RunsApiFp = function(configuration?: Configuration) { }, /** * - * @summary Retrieve Run SVG + * @summary Render SVG * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -448,27 +344,6 @@ export const RunsApiFactory = function (configuration?: Configuration, basePath? cancelRun(id: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.cancelRun(id, options).then((request) => request(axios, basePath)); }, - /** - * - * @summary List Run Files - * @param {string} id - * @param {string} [checkpoint] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listRunFiles(id: string, checkpoint?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listRunFiles(id, checkpoint, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List Run Verifications - * @param {string} id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listRunVerifications(id: string, options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRunVerifications(id, options).then((request) => request(axios, basePath)); - }, /** * * @summary List Runs @@ -490,7 +365,7 @@ export const RunsApiFactory = function (configuration?: Configuration, basePath? }, /** * - * @summary Retrieve Run SVG + * @summary Render SVG * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -536,29 +411,6 @@ export class RunsApi extends BaseAPI { return RunsApiFp(this.configuration).cancelRun(id, options).then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary List Run Files - * @param {string} id - * @param {string} [checkpoint] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - public listRunFiles(id: string, checkpoint?: string, options?: RawAxiosRequestConfig) { - return RunsApiFp(this.configuration).listRunFiles(id, checkpoint, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List Run Verifications - * @param {string} id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - public listRunVerifications(id: string, options?: RawAxiosRequestConfig) { - return RunsApiFp(this.configuration).listRunVerifications(id, options).then((request) => request(this.axios, this.basePath)); - } - /** * * @summary List Runs @@ -582,7 +434,7 @@ export class RunsApi extends BaseAPI { /** * - * @summary Retrieve Run SVG + * @summary Render SVG * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError}