diff --git a/docs/reference/api/openapi-v2.yaml b/docs/reference/api/openapi-v2.yaml index becc9a1..0325ab5 100644 --- a/docs/reference/api/openapi-v2.yaml +++ b/docs/reference/api/openapi-v2.yaml @@ -684,96 +684,6 @@ paths: $ref: "#/components/responses/generic-not-found-error" default: $ref: "#/components/responses/generic-error" - /task-queues/{type}: - get: - tags: - - Task Queues - summary: List task queues - description: |- - Returns a paginated list of task queues of the given type. - - **Note:** This is an internal API endpoint and may change without notice. - - Requires the `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_READ` permission. - operationId: listTaskQueues - parameters: - - name: type - in: path - description: Type of task queues to list - required: true - schema: - $ref: "#/components/schemas/task-queue-type" - - name: limit - in: query - description: Maximum number of items to retrieve from the collection - schema: - maximum: 1000 - minimum: 1 - type: integer - format: int32 - default: 100 - - name: page_token - in: query - description: Opaque token pointing to a specific position in a collection - schema: - type: string - responses: - "200": - description: Paginated list of task queues - content: - application/json: - schema: - $ref: "#/components/schemas/list-task-queues-response" - "400": - $ref: "#/components/responses/invalid-request-error" - "401": - $ref: "#/components/responses/generic-unauthorized-error" - "403": - $ref: "#/components/responses/generic-forbidden-error" - default: - $ref: "#/components/responses/generic-error" - /task-queues/{type}/{name}: - patch: - tags: - - Task Queues - summary: Update a task queue - description: |- - Updates the status and/or capacity of a task queue. - - **Note:** This is an internal API endpoint and may change without notice. - - Requires the `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_UPDATE` permission. - operationId: updateTaskQueue - parameters: - - name: type - in: path - description: Type of the task queue - required: true - schema: - $ref: "#/components/schemas/task-queue-type" - - name: name - in: path - description: Name of the task queue - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/update-task-queue-request" - required: true - responses: - "204": - description: Task queue updated - "401": - $ref: "#/components/responses/generic-unauthorized-error" - "403": - $ref: "#/components/responses/generic-forbidden-error" - "404": - $ref: "#/components/responses/generic-not-found-error" - default: - $ref: "#/components/responses/generic-error" /secrets: get: tags: @@ -977,6 +887,96 @@ paths: $ref: "#/components/responses/generic-not-found-error" default: $ref: "#/components/responses/generic-error" + /task-queues/{type}: + get: + tags: + - Task Queues + summary: List task queues + description: |- + Returns a paginated list of task queues of the given type. + + **Note:** This is an internal API endpoint and may change without notice. + + Requires the `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_READ` permission. + operationId: listTaskQueues + parameters: + - name: type + in: path + description: Type of task queues to list + required: true + schema: + $ref: "#/components/schemas/task-queue-type" + - name: limit + in: query + description: Maximum number of items to retrieve from the collection + schema: + maximum: 1000 + minimum: 1 + type: integer + format: int32 + default: 100 + - name: page_token + in: query + description: Opaque token pointing to a specific position in a collection + schema: + type: string + responses: + "200": + description: Paginated list of task queues + content: + application/json: + schema: + $ref: "#/components/schemas/list-task-queues-response" + "400": + $ref: "#/components/responses/invalid-request-error" + "401": + $ref: "#/components/responses/generic-unauthorized-error" + "403": + $ref: "#/components/responses/generic-forbidden-error" + default: + $ref: "#/components/responses/generic-error" + /task-queues/{type}/{name}: + patch: + tags: + - Task Queues + summary: Update a task queue + description: |- + Updates the status and/or capacity of a task queue. + + **Note:** This is an internal API endpoint and may change without notice. + + Requires the `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_UPDATE` permission. + operationId: updateTaskQueue + parameters: + - name: type + in: path + description: Type of the task queue + required: true + schema: + $ref: "#/components/schemas/task-queue-type" + - name: name + in: path + description: Name of the task queue + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/update-task-queue-request" + required: true + responses: + "204": + description: Task queue updated + "401": + $ref: "#/components/responses/generic-unauthorized-error" + "403": + $ref: "#/components/responses/generic-forbidden-error" + "404": + $ref: "#/components/responses/generic-not-found-error" + default: + $ref: "#/components/responses/generic-error" /vuln-policies: get: tags: @@ -1838,31 +1838,6 @@ components: $ref: "#/components/schemas/list-project-components-response-item" allOf: - $ref: "#/components/schemas/paginated-response" - task-queue-type: - type: string - enum: - - ACTIVITY - - WORKFLOW - list-task-queues-response: - required: - - items - type: object - properties: - items: - type: array - items: - $ref: "#/components/schemas/task-queue" - allOf: - - $ref: "#/components/schemas/paginated-response" - update-task-queue-request: - type: object - properties: - status: - $ref: "#/components/schemas/task-queue-status" - capacity: - minimum: 1 - type: integer - format: int32 list-secrets-response: required: - items @@ -1919,6 +1894,31 @@ components: minLength: 1 type: string description: The new value. Omit this field to retain the current value. + task-queue-type: + type: string + enum: + - ACTIVITY + - WORKFLOW + list-task-queues-response: + required: + - items + type: object + properties: + items: + type: array + items: + $ref: "#/components/schemas/task-queue" + allOf: + - $ref: "#/components/schemas/paginated-response" + update-task-queue-request: + type: object + properties: + status: + $ref: "#/components/schemas/task-queue-status" + capacity: + minimum: 1 + type: integer + format: int32 list-vuln-policies-response: required: - items