Skip to content

Commit a2ea71d

Browse files
Update OpenAPI docs (#31)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: dependencytrack-bot <106437498+dependencytrack-bot@users.noreply.github.com>
1 parent 95db07f commit a2ea71d

1 file changed

Lines changed: 115 additions & 115 deletions

File tree

docs/reference/api/openapi-v2.yaml

Lines changed: 115 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -684,96 +684,6 @@ paths:
684684
$ref: "#/components/responses/generic-not-found-error"
685685
default:
686686
$ref: "#/components/responses/generic-error"
687-
/task-queues/{type}:
688-
get:
689-
tags:
690-
- Task Queues
691-
summary: List task queues
692-
description: |-
693-
Returns a paginated list of task queues of the given type.
694-
695-
**Note:** This is an internal API endpoint and may change without notice.
696-
697-
Requires the `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_READ` permission.
698-
operationId: listTaskQueues
699-
parameters:
700-
- name: type
701-
in: path
702-
description: Type of task queues to list
703-
required: true
704-
schema:
705-
$ref: "#/components/schemas/task-queue-type"
706-
- name: limit
707-
in: query
708-
description: Maximum number of items to retrieve from the collection
709-
schema:
710-
maximum: 1000
711-
minimum: 1
712-
type: integer
713-
format: int32
714-
default: 100
715-
- name: page_token
716-
in: query
717-
description: Opaque token pointing to a specific position in a collection
718-
schema:
719-
type: string
720-
responses:
721-
"200":
722-
description: Paginated list of task queues
723-
content:
724-
application/json:
725-
schema:
726-
$ref: "#/components/schemas/list-task-queues-response"
727-
"400":
728-
$ref: "#/components/responses/invalid-request-error"
729-
"401":
730-
$ref: "#/components/responses/generic-unauthorized-error"
731-
"403":
732-
$ref: "#/components/responses/generic-forbidden-error"
733-
default:
734-
$ref: "#/components/responses/generic-error"
735-
/task-queues/{type}/{name}:
736-
patch:
737-
tags:
738-
- Task Queues
739-
summary: Update a task queue
740-
description: |-
741-
Updates the status and/or capacity of a task queue.
742-
743-
**Note:** This is an internal API endpoint and may change without notice.
744-
745-
Requires the `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_UPDATE` permission.
746-
operationId: updateTaskQueue
747-
parameters:
748-
- name: type
749-
in: path
750-
description: Type of the task queue
751-
required: true
752-
schema:
753-
$ref: "#/components/schemas/task-queue-type"
754-
- name: name
755-
in: path
756-
description: Name of the task queue
757-
required: true
758-
schema:
759-
type: string
760-
requestBody:
761-
content:
762-
application/json:
763-
schema:
764-
$ref: "#/components/schemas/update-task-queue-request"
765-
required: true
766-
responses:
767-
"204":
768-
description: Task queue updated
769-
"401":
770-
$ref: "#/components/responses/generic-unauthorized-error"
771-
"403":
772-
$ref: "#/components/responses/generic-forbidden-error"
773-
"404":
774-
$ref: "#/components/responses/generic-not-found-error"
775-
default:
776-
$ref: "#/components/responses/generic-error"
777687
/secrets:
778688
get:
779689
tags:
@@ -977,6 +887,96 @@ paths:
977887
$ref: "#/components/responses/generic-not-found-error"
978888
default:
979889
$ref: "#/components/responses/generic-error"
890+
/task-queues/{type}:
891+
get:
892+
tags:
893+
- Task Queues
894+
summary: List task queues
895+
description: |-
896+
Returns a paginated list of task queues of the given type.
897+
898+
**Note:** This is an internal API endpoint and may change without notice.
899+
900+
Requires the `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_READ` permission.
901+
operationId: listTaskQueues
902+
parameters:
903+
- name: type
904+
in: path
905+
description: Type of task queues to list
906+
required: true
907+
schema:
908+
$ref: "#/components/schemas/task-queue-type"
909+
- name: limit
910+
in: query
911+
description: Maximum number of items to retrieve from the collection
912+
schema:
913+
maximum: 1000
914+
minimum: 1
915+
type: integer
916+
format: int32
917+
default: 100
918+
- name: page_token
919+
in: query
920+
description: Opaque token pointing to a specific position in a collection
921+
schema:
922+
type: string
923+
responses:
924+
"200":
925+
description: Paginated list of task queues
926+
content:
927+
application/json:
928+
schema:
929+
$ref: "#/components/schemas/list-task-queues-response"
930+
"400":
931+
$ref: "#/components/responses/invalid-request-error"
932+
"401":
933+
$ref: "#/components/responses/generic-unauthorized-error"
934+
"403":
935+
$ref: "#/components/responses/generic-forbidden-error"
936+
default:
937+
$ref: "#/components/responses/generic-error"
938+
/task-queues/{type}/{name}:
939+
patch:
940+
tags:
941+
- Task Queues
942+
summary: Update a task queue
943+
description: |-
944+
Updates the status and/or capacity of a task queue.
945+
946+
**Note:** This is an internal API endpoint and may change without notice.
947+
948+
Requires the `SYSTEM_CONFIGURATION` or `SYSTEM_CONFIGURATION_UPDATE` permission.
949+
operationId: updateTaskQueue
950+
parameters:
951+
- name: type
952+
in: path
953+
description: Type of the task queue
954+
required: true
955+
schema:
956+
$ref: "#/components/schemas/task-queue-type"
957+
- name: name
958+
in: path
959+
description: Name of the task queue
960+
required: true
961+
schema:
962+
type: string
963+
requestBody:
964+
content:
965+
application/json:
966+
schema:
967+
$ref: "#/components/schemas/update-task-queue-request"
968+
required: true
969+
responses:
970+
"204":
971+
description: Task queue updated
972+
"401":
973+
$ref: "#/components/responses/generic-unauthorized-error"
974+
"403":
975+
$ref: "#/components/responses/generic-forbidden-error"
976+
"404":
977+
$ref: "#/components/responses/generic-not-found-error"
978+
default:
979+
$ref: "#/components/responses/generic-error"
980980
/vuln-policies:
981981
get:
982982
tags:
@@ -1838,31 +1838,6 @@ components:
18381838
$ref: "#/components/schemas/list-project-components-response-item"
18391839
allOf:
18401840
- $ref: "#/components/schemas/paginated-response"
1841-
task-queue-type:
1842-
type: string
1843-
enum:
1844-
- ACTIVITY
1845-
- WORKFLOW
1846-
list-task-queues-response:
1847-
required:
1848-
- items
1849-
type: object
1850-
properties:
1851-
items:
1852-
type: array
1853-
items:
1854-
$ref: "#/components/schemas/task-queue"
1855-
allOf:
1856-
- $ref: "#/components/schemas/paginated-response"
1857-
update-task-queue-request:
1858-
type: object
1859-
properties:
1860-
status:
1861-
$ref: "#/components/schemas/task-queue-status"
1862-
capacity:
1863-
minimum: 1
1864-
type: integer
1865-
format: int32
18661841
list-secrets-response:
18671842
required:
18681843
- items
@@ -1919,6 +1894,31 @@ components:
19191894
minLength: 1
19201895
type: string
19211896
description: The new value. Omit this field to retain the current value.
1897+
task-queue-type:
1898+
type: string
1899+
enum:
1900+
- ACTIVITY
1901+
- WORKFLOW
1902+
list-task-queues-response:
1903+
required:
1904+
- items
1905+
type: object
1906+
properties:
1907+
items:
1908+
type: array
1909+
items:
1910+
$ref: "#/components/schemas/task-queue"
1911+
allOf:
1912+
- $ref: "#/components/schemas/paginated-response"
1913+
update-task-queue-request:
1914+
type: object
1915+
properties:
1916+
status:
1917+
$ref: "#/components/schemas/task-queue-status"
1918+
capacity:
1919+
minimum: 1
1920+
type: integer
1921+
format: int32
19221922
list-vuln-policies-response:
19231923
required:
19241924
- items

0 commit comments

Comments
 (0)