From 3d27d1fb72966fa39f5d5adf1766bb180db13123 Mon Sep 17 00:00:00 2001 From: Bryan Helmkamp Date: Mon, 2 Mar 2026 16:40:12 -0500 Subject: [PATCH] Move preview URL endpoint to new Sandbox tag and shorten summary Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/api-reference/arc-api.yaml | 4 +- openapi/arc-api.yaml | 4 +- .../src/.openapi-generator/FILES | 1 + packages/arc-api-client/src/api.ts | 1 + packages/arc-api-client/src/api/runs-api.ts | 80 ----------- .../arc-api-client/src/api/sandbox-api.ts | 134 ++++++++++++++++++ 6 files changed, 140 insertions(+), 84 deletions(-) create mode 100644 packages/arc-api-client/src/api/sandbox-api.ts diff --git a/docs/api-reference/arc-api.yaml b/docs/api-reference/arc-api.yaml index 120063918..4aed6f950 100644 --- a/docs/api-reference/arc-api.yaml +++ b/docs/api-reference/arc-api.yaml @@ -407,8 +407,8 @@ paths: /runs/{id}/preview: post: operationId: generatePreviewUrl - tags: [Runs] - summary: Generate a sandbox preview URL + tags: [Sandbox] + summary: Preview URL parameters: - $ref: "#/components/parameters/RunId" requestBody: diff --git a/openapi/arc-api.yaml b/openapi/arc-api.yaml index 120063918..4aed6f950 100644 --- a/openapi/arc-api.yaml +++ b/openapi/arc-api.yaml @@ -407,8 +407,8 @@ paths: /runs/{id}/preview: post: operationId: generatePreviewUrl - tags: [Runs] - summary: Generate a sandbox preview URL + tags: [Sandbox] + summary: Preview URL parameters: - $ref: "#/components/parameters/RunId" requestBody: diff --git a/packages/arc-api-client/src/.openapi-generator/FILES b/packages/arc-api-client/src/.openapi-generator/FILES index 28fcd5abd..d4b401749 100644 --- a/packages/arc-api-client/src/.openapi-generator/FILES +++ b/packages/arc-api-client/src/.openapi-generator/FILES @@ -5,6 +5,7 @@ api/projects-api.ts api/retros-api.ts api/run-internals-api.ts api/runs-api.ts +api/sandbox-api.ts api/sessions-api.ts api/settings-api.ts api/usage-api.ts diff --git a/packages/arc-api-client/src/api.ts b/packages/arc-api-client/src/api.ts index 487353986..bf713788d 100644 --- a/packages/arc-api-client/src/api.ts +++ b/packages/arc-api-client/src/api.ts @@ -20,6 +20,7 @@ export * from './api/projects-api'; export * from './api/retros-api'; export * from './api/run-internals-api'; export * from './api/runs-api'; +export * from './api/sandbox-api'; export * from './api/sessions-api'; export * from './api/settings-api'; export * from './api/usage-api'; diff --git a/packages/arc-api-client/src/api/runs-api.ts b/packages/arc-api-client/src/api/runs-api.ts index 05641a03a..997b31423 100644 --- a/packages/arc-api-client/src/api/runs-api.ts +++ b/packages/arc-api-client/src/api/runs-api.ts @@ -26,10 +26,6 @@ import type { CancelRun200Response } from '../models'; // @ts-ignore import type { ErrorResponse } from '../models'; // @ts-ignore -import type { PreviewUrlRequest } from '../models'; -// @ts-ignore -import type { PreviewUrlResponse } from '../models'; -// @ts-ignore import type { RunFiles } from '../models'; // @ts-ignore import type { RunListItem } from '../models'; @@ -80,45 +76,6 @@ export const RunsApiAxiosParamCreator = function (configuration?: Configuration) options: localVarRequestOptions, }; }, - /** - * - * @summary Generate a sandbox preview URL - * @param {string} id - * @param {PreviewUrlRequest} previewUrlRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - generatePreviewUrl: async (id: string, previewUrlRequest: PreviewUrlRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('generatePreviewUrl', 'id', id) - // verify required parameter 'previewUrlRequest' is not null or undefined - assertParamExists('generatePreviewUrl', 'previewUrlRequest', previewUrlRequest) - const localVarPath = `/runs/{id}/preview` - .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; - - 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(previewUrlRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * * @summary List Run Files @@ -381,20 +338,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 Generate a sandbox preview URL - * @param {string} id - * @param {PreviewUrlRequest} previewUrlRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async generatePreviewUrl(id: string, previewUrlRequest: PreviewUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.generatePreviewUrl(id, previewUrlRequest, options); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RunsApi.generatePreviewUrl']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, /** * * @summary List Run Files @@ -505,17 +448,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 Generate a sandbox preview URL - * @param {string} id - * @param {PreviewUrlRequest} previewUrlRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - generatePreviewUrl(id: string, previewUrlRequest: PreviewUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.generatePreviewUrl(id, previewUrlRequest, options).then((request) => request(axios, basePath)); - }, /** * * @summary List Run Files @@ -604,18 +536,6 @@ export class RunsApi extends BaseAPI { return RunsApiFp(this.configuration).cancelRun(id, options).then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary Generate a sandbox preview URL - * @param {string} id - * @param {PreviewUrlRequest} previewUrlRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - public generatePreviewUrl(id: string, previewUrlRequest: PreviewUrlRequest, options?: RawAxiosRequestConfig) { - return RunsApiFp(this.configuration).generatePreviewUrl(id, previewUrlRequest, options).then((request) => request(this.axios, this.basePath)); - } - /** * * @summary List Run Files diff --git a/packages/arc-api-client/src/api/sandbox-api.ts b/packages/arc-api-client/src/api/sandbox-api.ts new file mode 100644 index 000000000..171b0d986 --- /dev/null +++ b/packages/arc-api-client/src/api/sandbox-api.ts @@ -0,0 +1,134 @@ +/* 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 { PreviewUrlRequest } from '../models'; +// @ts-ignore +import type { PreviewUrlResponse } from '../models'; +/** + * SandboxApi - axios parameter creator + */ +export const SandboxApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Preview URL + * @param {string} id + * @param {PreviewUrlRequest} previewUrlRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + generatePreviewUrl: async (id: string, previewUrlRequest: PreviewUrlRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('generatePreviewUrl', 'id', id) + // verify required parameter 'previewUrlRequest' is not null or undefined + assertParamExists('generatePreviewUrl', 'previewUrlRequest', previewUrlRequest) + const localVarPath = `/runs/{id}/preview` + .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; + + 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(previewUrlRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * SandboxApi - functional programming interface + */ +export const SandboxApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SandboxApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Preview URL + * @param {string} id + * @param {PreviewUrlRequest} previewUrlRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async generatePreviewUrl(id: string, previewUrlRequest: PreviewUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.generatePreviewUrl(id, previewUrlRequest, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SandboxApi.generatePreviewUrl']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SandboxApi - factory interface + */ +export const SandboxApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SandboxApiFp(configuration) + return { + /** + * + * @summary Preview URL + * @param {string} id + * @param {PreviewUrlRequest} previewUrlRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + generatePreviewUrl(id: string, previewUrlRequest: PreviewUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.generatePreviewUrl(id, previewUrlRequest, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * SandboxApi - object-oriented interface + */ +export class SandboxApi extends BaseAPI { + /** + * + * @summary Preview URL + * @param {string} id + * @param {PreviewUrlRequest} previewUrlRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + public generatePreviewUrl(id: string, previewUrlRequest: PreviewUrlRequest, options?: RawAxiosRequestConfig) { + return SandboxApiFp(this.configuration).generatePreviewUrl(id, previewUrlRequest, options).then((request) => request(this.axios, this.basePath)); + } +} +