mirror of
https://github.com/coder/coder.git
synced 2026-10-16 14:48:56 +08:00
Stefan Naglee
589e313e83
## Summary
The `tags` query parameter on the "Get provisioner daemons" and "Get
provisioner jobs" endpoints was annotated as `@Param tags query object`,
which caused Swagger to emit `"type": "object"` for a query parameter.
Query parameters cannot be of type `object` in the OpenAPI 2.0 spec, so
this produced an invalid schema that breaks spec validators and client
generators.
As noted in the doc, the value is actually a single JSON-encoded string
(parsed via `QueryParamParser.JSONStringMap`), so the correct type is
`string`. This is a doc only concern as generators do not use this file.
## Changes
- Change the `tags` query param annotation from `object` to `string` in:
- `coderd/provisionerdaemons.go` (`GET
/api/v2/organizations/{organization}/provisionerdaemons`)
- `coderd/provisionerjobs.go` (`GET
/api/v2/organizations/{organization}/provisionerjobs`)
- Regenerate API docs (`make coderd/apidoc/.gen`):
`coderd/apidoc/swagger.json`, `coderd/apidoc/docs.go`, and the reference
markdown.
The description still documents the expected JSON form
(`{'tag1':'value1','tag2':'value2'}`), so no behavior changes for
callers.
> [!NOTE]
> This PR was generated by Coder Agents on behalf of @snagles.
7.2 KiB
Generated
7.2 KiB
Generated
title
| title |
|---|
| Provisioning |
Get provisioner daemons
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisionerdaemons \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/organizations/{organization}/provisionerdaemons
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
organization |
path | string(uuid) | true | Organization ID |
limit |
query | integer | false | Page limit |
ids |
query | array(uuid) | false | Filter results by job IDs |
status |
query | string | false | Filter results by status |
tags |
query | string | false | Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'}) |
Enumerated Values
| Parameter | Value(s) |
|---|---|
status |
canceled, canceling, failed, pending, running, succeeded, unknown |
Example responses
200 Response
[
{
"api_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"current_job": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "pending",
"template_display_name": "string",
"template_icon": "string",
"template_name": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key_id": "1e779c8a-6786-4c89-b7c3-a6666f5fd6b5",
"key_name": "string",
"last_seen_at": "2019-08-24T14:15:22Z",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"previous_job": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "pending",
"template_display_name": "string",
"template_icon": "string",
"template_name": "string"
},
"provisioners": [
"string"
],
"status": "offline",
"tags": {
"property1": "string",
"property2": "string"
},
"version": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | array of codersdk.ProvisionerDaemon |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
[array item] |
array | false | ||
» api_version |
string | false | ||
» created_at |
string(date-time) | false | ||
» current_job |
codersdk.ProvisionerDaemonJob | false | ||
»» id |
string(uuid) | false | ||
»» status |
codersdk.ProvisionerJobStatus | false | ||
»» template_display_name |
string | false | ||
»» template_icon |
string | false | ||
»» template_name |
string | false | ||
» id |
string(uuid) | false | ||
» key_id |
string(uuid) | false | ||
» key_name |
string | false | Optional fields. | |
» last_seen_at |
string(date-time) | false | ||
» name |
string | false | ||
» organization_id |
string(uuid) | false | ||
» previous_job |
codersdk.ProvisionerDaemonJob | false | ||
» provisioners |
array | false | ||
» status |
codersdk.ProvisionerDaemonStatus | false | ||
» tags |
object | false | ||
»» [any property] |
string | false | ||
» version |
string | false |
Enumerated Values
| Property | Value(s) |
|---|---|
status |
busy, canceled, canceling, failed, idle, offline, pending, running, succeeded |
To perform this operation, you must be authenticated. Learn more.