diff options
| author | Tobias Henkel <tobias.henkel@bmw.de> | 2020-01-12 11:10:04 +0100 |
|---|---|---|
| committer | Tobias Henkel <tobias.henkel@bmw.de> | 2020-01-15 12:30:00 +0100 |
| commit | 44f793e1ce827d480fd06fc25b6c9b3e5b8ae2a8 (patch) | |
| tree | b77811ef7f9c2663ff6b2f27476f1f231902f4b3 /web | |
| parent | e6d8b210cc416ed494b0b0248404e3e6d7ce337c (diff) | |
| download | zuul-44f793e1ce827d480fd06fc25b6c9b3e5b8ae2a8.tar.gz | |
Document the buildsets endpoint
The buildsets endpoint was missing in the openapi documentation.
Change-Id: I2214ccb42f6ba4c34c57453030c214a232bda203
Diffstat (limited to 'web')
| -rw-r--r-- | web/public/openapi.yaml | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/web/public/openapi.yaml b/web/public/openapi.yaml index 10218f6db..4338e5a43 100644 --- a/web/public/openapi.yaml +++ b/web/public/openapi.yaml @@ -96,6 +96,86 @@ paths: summary: List the executed builds tags: - tenant + /api/tenant/{tenant}/buildsets: + get: + operationId: list-buildsets + parameters: + - description: The tenant name + in: path + name: tenant + required: true + schema: + type: string + - description: A project name + in: query + name: project + schema: + type: string + - description: A pipeline name + in: query + name: pipeline + schema: + type: string + - description: A branch name + in: query + name: branch + schema: + type: string + - description: A change number + in: query + name: change + schema: + type: string + - description: A patchset number + in: query + name: patchset + schema: + type: string + - description: A ref + in: query + name: ref + schema: + type: string + - description: A new revision hash + in: query + name: newrev + schema: + type: string + - description: A buildset uuid + in: query + name: uuid + schema: + type: string + - description: A buildset result + in: query + name: result + schema: + type: string + - description: The limit count (default 50) + in: query + name: limit + schema: + type: string + - description: Skip number of results + in: query + name: skip + schema: + type: string + responses: + '200': + content: + application/json: + schema: + description: The list of buildsets + items: + $ref: '#/components/schemas/buildset' + type: array + description: Returns the list of builds + '404': + description: Tenant not found + summary: List the executed builds + tags: + - tenant /api/tenant/{tenant}/jobs: get: operationId: list-jobs @@ -285,6 +365,45 @@ components: description: The build voting status type: boolean type: object + buildset: + description: A buildset + properties: + project: + description: The buildset project name + type: string + event_id: + description: The event id that triggered the buildset + type: string + uuid: + description: The buildset uuid + type: string + branch: + description: The buildset change branch + type: string + ref_url: + description: The buildset change reference url + type: string + newrev: + description: The buildset newrev + type: string + result: + description: The buildset result + type: string + change: + description: The buildset change number + type: integer + patchset: + description: The buildset patchset number + type: integer + ref: + description: The buildset change reference + type: string + pipeline: + description: The buildset pipeline + type: string + message: + description: The message that got reported by the buildset + type: object changeQueue: description: A change queue properties: |