From 2ea0997446c99d3b5735363c0ce37e8089f7d468 Mon Sep 17 00:00:00 2001 From: solimant Date: Fri, 18 Jul 2025 02:13:51 +0000 Subject: [PATCH] Capture 403 errors Signed-off-by: solimant --- .../scaffolder-backend/src/schema/openapi.yaml | 4 ++++ .../openapi/generated/apis/Api.server.ts | 4 ++-- .../generated/models/TaskEventType.model.ts | 10 ---------- .../generated/models/TaskStatus.model.ts | 12 ------------ .../src/schema/openapi/generated/router.ts | 8 +++++++- plugins/scaffolder-common/report.api.md | 18 ------------------ .../generated/models/TaskEventType.model.ts | 10 ---------- .../generated/models/TaskStatus.model.ts | 12 ------------ 8 files changed, 13 insertions(+), 65 deletions(-) diff --git a/plugins/scaffolder-backend/src/schema/openapi.yaml b/plugins/scaffolder-backend/src/schema/openapi.yaml index 18f45a4b35..284a478692 100644 --- a/plugins/scaffolder-backend/src/schema/openapi.yaml +++ b/plugins/scaffolder-backend/src/schema/openapi.yaml @@ -634,6 +634,8 @@ paths: application/json: schema: $ref: '#/components/schemas/SerializedTask' + '403': + $ref: '#/components/responses/ErrorResponse' security: - {} - JWT: [] @@ -706,6 +708,8 @@ paths: type: array items: $ref: '#/components/schemas/SerializedTaskEvent' + '403': + $ref: '#/components/responses/ErrorResponse' parameters: - $ref: '#/components/parameters/eventsAfter' - $ref: '#/components/parameters/taskId' diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/apis/Api.server.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/apis/Api.server.ts index febb63606f..6e23ed34c8 100644 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/apis/Api.server.ts +++ b/plugins/scaffolder-backend/src/schema/openapi/generated/apis/Api.server.ts @@ -70,7 +70,7 @@ export type GetTask = { path: { taskId: string; }; - response: SerializedTask; + response: SerializedTask | Error; }; /** * @public @@ -135,7 +135,7 @@ export type StreamLogsPolling = { query: { after?: number; }; - response: Array; + response: Array | Error; }; export type EndpointMap = { diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskEventType.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskEventType.model.ts index dd3d36d64e..cded96f252 100644 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskEventType.model.ts +++ b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskEventType.model.ts @@ -22,13 +22,3 @@ * @public */ export type TaskEventType = 'cancelled' | 'completion' | 'log' | 'recovered'; - -/** - * @public - */ -export const TaskEventType = { - Cancelled: 'cancelled' as TaskEventType, - Completion: 'completion' as TaskEventType, - Log: 'log' as TaskEventType, - Recovered: 'recovered' as TaskEventType, -}; diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStatus.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStatus.model.ts index 622aa758c0..ff3d59e0e0 100644 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStatus.model.ts +++ b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStatus.model.ts @@ -28,15 +28,3 @@ export type TaskStatus = | 'open' | 'processing' | 'skipped'; - -/** - * @public - */ -export const TaskStatus = { - Cancelled: 'cancelled' as TaskStatus, - Completed: 'completed' as TaskStatus, - Failed: 'failed' as TaskStatus, - Open: 'open' as TaskStatus, - Processing: 'processing' as TaskStatus, - Skipped: 'skipped' as TaskStatus, -}; diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/router.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/router.ts index 78802491b1..0e857d57b1 100644 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/router.ts +++ b/plugins/scaffolder-backend/src/schema/openapi/generated/router.ts @@ -18,7 +18,7 @@ // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. * // ****************************************************************** import { createValidatedOpenApiRouterFromGeneratedEndpointMap } from '@backstage/backend-openapi-utils'; -import { EndpointMap } from './'; +import { EndpointMap } from './apis'; export const spec = { openapi: '3.0.3', @@ -931,6 +931,9 @@ export const spec = { }, }, }, + '403': { + $ref: '#/components/responses/ErrorResponse', + }, }, security: [ {}, @@ -1051,6 +1054,9 @@ export const spec = { }, }, }, + '403': { + $ref: '#/components/responses/ErrorResponse', + }, }, parameters: [ { diff --git a/plugins/scaffolder-common/report.api.md b/plugins/scaffolder-common/report.api.md index 03dc3d05ea..2079bb84d9 100644 --- a/plugins/scaffolder-common/report.api.md +++ b/plugins/scaffolder-common/report.api.md @@ -356,16 +356,6 @@ export type ScaffolderTaskStatus = | 'processing' | 'skipped'; -// @public (undocumented) -export const ScaffolderTaskStatus: { - Cancelled: ScaffolderTaskStatus; - Completed: ScaffolderTaskStatus; - Failed: ScaffolderTaskStatus; - Open: ScaffolderTaskStatus; - Processing: ScaffolderTaskStatus; - Skipped: ScaffolderTaskStatus; -}; - // @public export type ScaffolderUsageExample = { description?: string; @@ -376,14 +366,6 @@ export type ScaffolderUsageExample = { // @public (undocumented) export type TaskEventType = 'cancelled' | 'completion' | 'log' | 'recovered'; -// @public (undocumented) -export const TaskEventType: { - Cancelled: TaskEventType; - Completion: TaskEventType; - Log: TaskEventType; - Recovered: TaskEventType; -}; - // @public export type TaskRecoverStrategy = 'none' | 'startOver'; diff --git a/plugins/scaffolder-common/src/schema/openapi/generated/models/TaskEventType.model.ts b/plugins/scaffolder-common/src/schema/openapi/generated/models/TaskEventType.model.ts index dd3d36d64e..cded96f252 100644 --- a/plugins/scaffolder-common/src/schema/openapi/generated/models/TaskEventType.model.ts +++ b/plugins/scaffolder-common/src/schema/openapi/generated/models/TaskEventType.model.ts @@ -22,13 +22,3 @@ * @public */ export type TaskEventType = 'cancelled' | 'completion' | 'log' | 'recovered'; - -/** - * @public - */ -export const TaskEventType = { - Cancelled: 'cancelled' as TaskEventType, - Completion: 'completion' as TaskEventType, - Log: 'log' as TaskEventType, - Recovered: 'recovered' as TaskEventType, -}; diff --git a/plugins/scaffolder-common/src/schema/openapi/generated/models/TaskStatus.model.ts b/plugins/scaffolder-common/src/schema/openapi/generated/models/TaskStatus.model.ts index 622aa758c0..ff3d59e0e0 100644 --- a/plugins/scaffolder-common/src/schema/openapi/generated/models/TaskStatus.model.ts +++ b/plugins/scaffolder-common/src/schema/openapi/generated/models/TaskStatus.model.ts @@ -28,15 +28,3 @@ export type TaskStatus = | 'open' | 'processing' | 'skipped'; - -/** - * @public - */ -export const TaskStatus = { - Cancelled: 'cancelled' as TaskStatus, - Completed: 'completed' as TaskStatus, - Failed: 'failed' as TaskStatus, - Open: 'open' as TaskStatus, - Processing: 'processing' as TaskStatus, - Skipped: 'skipped' as TaskStatus, -};