From 8f997e4bb4dcc605a7ec7cb1ff25b8da8c11e962 Mon Sep 17 00:00:00 2001 From: Jin Yi Date: Wed, 30 Jul 2025 09:35:24 +0900 Subject: [PATCH] chore(api): Update OpenAPI spec for new bulk endpoint Adds the `import_fail_info_bulk` route and its corresponding request/response schemas to `openapi.yaml`. --- openapi.yaml | 58 ++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 43 insertions(+), 15 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 51611f5f..0446259e 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -104,6 +104,38 @@ components: type: boolean description: Whether the queue is currently processing + ImportFailInfoBulkRequest: + type: object + properties: + cnr_ids: + type: array + items: + type: string + description: A list of CNR IDs to check. + urls: + type: array + items: + type: string + description: A list of repository URLs to check. + + ImportFailInfoBulkResponse: + type: object + additionalProperties: + $ref: '#/components/schemas/ImportFailInfoItem' + description: >- + A dictionary where each key is a cnr_id or url from the request, + and the value is the corresponding error info. + + ImportFailInfoItem: + oneOf: + - type: object + properties: + error: + type: string + traceback: + type: string + - type: "null" + securitySchemes: securityLevel: type: apiKey @@ -308,32 +340,28 @@ paths: /v2/customnode/import_fail_info_bulk: post: - summary: Get import failure information for multiple nodes - description: Returns information about why a list of nodes failed to import + summary: Get import failure info for multiple nodes + description: Retrieves recorded import failure information for a list of custom nodes. tags: - customnode requestBody: + description: A list of CNR IDs or repository URLs to check. required: true content: application/json: schema: - type: object - properties: - cnr_ids: - type: array - items: - type: string - urls: - type: array - items: - type: string + $ref: '#/components/schemas/ImportFailInfoBulkRequest' responses: '200': - description: Successful operation + description: A dictionary containing the import failure information. + content: + application/json: + schema: + $ref: '#/components/schemas/ImportFailInfoBulkResponse' '400': - description: Bad Request or invalid input + description: Bad Request. The request body is invalid. '500': - description: Internal Server Error + description: Internal Server Error. /customnode/install/git_url: post: