Skip to content

Commit a46e7c8

Browse files
mtojekmtojek
committed
docs: update swaggo/swag v1.8.9
1 parent 66fa2a1 commit a46e7c8

File tree

11 files changed

+1691
-560
lines changed

11 files changed

+1691
-560
lines changed

‎coderd/apidoc/docs.go

Lines changed: 436 additions & 31 deletions
Large diffs are not rendered by default.

‎coderd/apidoc/swagger.json

Lines changed: 358 additions & 44 deletions
Large diffs are not rendered by default.

‎docs/api/agents.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/app-health \
160160
```json
161161
{
162162
"healths": {
163-
"property1": "string",
164-
"property2": "string"
163+
"property1": "disabled",
164+
"property2": "disabled"
165165
}
166166
}
167167
```
@@ -299,7 +299,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/metadata \
299299
"command": "string",
300300
"display_name": "string",
301301
"external": true,
302-
"health": "string",
302+
"health": "disabled",
303303
"healthcheck": {
304304
"interval": 0,
305305
"threshold": 0,
@@ -426,7 +426,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/report-stats \
426426
427427
```json
428428
{
429-
"report_interval": 0
429+
"report_interval": -9223372036854776000
430430
}
431431
```
432432

‎docs/api/audit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?q=string \
3232
{
3333
"audit_logs": [
3434
{
35-
"action": "string",
35+
"action": "create",
3636
"additional_fields": [0],
3737
"description": "string",
3838
"diff": {
@@ -56,7 +56,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?q=string \
5656
"resource_id": "string",
5757
"resource_link": "string",
5858
"resource_target": "string",
59-
"resource_type": "string",
59+
"resource_type": "organization",
6060
"status_code": 0,
6161
"time": "string",
6262
"user": {
@@ -72,7 +72,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?q=string \
7272
"name": "string"
7373
}
7474
],
75-
"status": "string",
75+
"status": "active",
7676
"username": "string"
7777
},
7878
"user_agent": "string"

‎docs/api/builds.md

Lines changed: 172 additions & 162 deletions
Large diffs are not rendered by default.

‎docs/api/general.md

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,15 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
119119
"value": "string"
120120
},
121121
"agent_stat_refresh_interval": {
122-
"default": 0,
122+
"default": -9223372036854776000,
123123
"enterprise": true,
124124
"flag": "string",
125125
"hidden": true,
126126
"name": "string",
127127
"secret": true,
128128
"shorthand": "string",
129129
"usage": "string",
130-
"value": 0
130+
"value": -9223372036854776000
131131
},
132132
"api_rate_limit": {
133133
"default": 0,
@@ -152,15 +152,15 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
152152
"value": true
153153
},
154154
"autobuild_poll_interval": {
155-
"default": 0,
155+
"default": -9223372036854776000,
156156
"enterprise": true,
157157
"flag": "string",
158158
"hidden": true,
159159
"name": "string",
160160
"secret": true,
161161
"shorthand": "string",
162162
"usage": "string",
163-
"value": 0
163+
"value": -9223372036854776000
164164
},
165165
"browser_only": {
166166
"default": true,
@@ -274,7 +274,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
274274
"secret": true,
275275
"shorthand": "string",
276276
"usage": "string",
277-
"value": "string"
277+
"value": ["string"]
278278
}
279279
}
280280
},
@@ -310,17 +310,19 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
310310
"secret": true,
311311
"shorthand": "string",
312312
"usage": "string",
313-
"value": {
314-
"auth_url": "string",
315-
"client_id": "string",
316-
"id": "string",
317-
"no_refresh": true,
318-
"regex": "string",
319-
"scopes": ["string"],
320-
"token_url": "string",
321-
"type": "string",
322-
"validate_url": "string"
323-
}
313+
"value": [
314+
{
315+
"auth_url": "string",
316+
"client_id": "string",
317+
"id": "string",
318+
"no_refresh": true,
319+
"regex": "string",
320+
"scopes": ["string"],
321+
"token_url": "string",
322+
"type": "string",
323+
"validate_url": "string"
324+
}
325+
]
324326
},
325327
"http_address": {
326328
"default": "string",
@@ -345,26 +347,26 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
345347
"value": true
346348
},
347349
"max_token_lifetime": {
348-
"default": 0,
350+
"default": -9223372036854776000,
349351
"enterprise": true,
350352
"flag": "string",
351353
"hidden": true,
352354
"name": "string",
353355
"secret": true,
354356
"shorthand": "string",
355357
"usage": "string",
356-
"value": 0
358+
"value": -9223372036854776000
357359
},
358360
"metrics_cache_refresh_interval": {
359-
"default": 0,
361+
"default": -9223372036854776000,
360362
"enterprise": true,
361363
"flag": "string",
362364
"hidden": true,
363365
"name": "string",
364366
"secret": true,
365367
"shorthand": "string",
366368
"usage": "string",
367-
"value": 0
369+
"value": -9223372036854776000
368370
},
369371
"oauth2": {
370372
"github": {
@@ -399,7 +401,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
399401
"secret": true,
400402
"shorthand": "string",
401403
"usage": "string",
402-
"value": "string"
404+
"value": ["string"]
403405
},
404406
"allowed_teams": {
405407
"default": ["string"],
@@ -410,7 +412,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
410412
"secret": true,
411413
"shorthand": "string",
412414
"usage": "string",
413-
"value": "string"
415+
"value": ["string"]
414416
},
415417
"client_id": {
416418
"default": "string",
@@ -490,7 +492,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
490492
"secret": true,
491493
"shorthand": "string",
492494
"usage": "string",
493-
"value": "string"
495+
"value": ["string"]
494496
},
495497
"ignore_email_verified": {
496498
"default": true,
@@ -523,7 +525,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
523525
"secret": true,
524526
"shorthand": "string",
525527
"usage": "string",
526-
"value": "string"
528+
"value": ["string"]
527529
},
528530
"username_field": {
529531
"default": "string",
@@ -598,26 +600,26 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
598600
},
599601
"provisioner": {
600602
"daemon_poll_interval": {
601-
"default": 0,
603+
"default": -9223372036854776000,
602604
"enterprise": true,
603605
"flag": "string",
604606
"hidden": true,
605607
"name": "string",
606608
"secret": true,
607609
"shorthand": "string",
608610
"usage": "string",
609-
"value": 0
611+
"value": -9223372036854776000
610612
},
611613
"daemon_poll_jitter": {
612-
"default": 0,
614+
"default": -9223372036854776000,
613615
"enterprise": true,
614616
"flag": "string",
615617
"hidden": true,
616618
"name": "string",
617619
"secret": true,
618620
"shorthand": "string",
619621
"usage": "string",
620-
"value": 0
622+
"value": -9223372036854776000
621623
},
622624
"daemons": {
623625
"default": 0,
@@ -631,15 +633,15 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
631633
"value": 0
632634
},
633635
"force_cancel_interval": {
634-
"default": 0,
636+
"default": -9223372036854776000,
635637
"enterprise": true,
636638
"flag": "string",
637639
"hidden": true,
638640
"name": "string",
639641
"secret": true,
640642
"shorthand": "string",
641643
"usage": "string",
642-
"value": 0
644+
"value": -9223372036854776000
643645
}
644646
},
645647
"proxy_trusted_headers": {
@@ -651,7 +653,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
651653
"secret": true,
652654
"shorthand": "string",
653655
"usage": "string",
654-
"value": "string"
656+
"value": ["string"]
655657
},
656658
"proxy_trusted_origins": {
657659
"default": ["string"],
@@ -662,7 +664,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
662664
"secret": true,
663665
"shorthand": "string",
664666
"usage": "string",
665-
"value": "string"
667+
"value": ["string"]
666668
},
667669
"scim_api_key": {
668670
"default": "string",
@@ -766,7 +768,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
766768
"secret": true,
767769
"shorthand": "string",
768770
"usage": "string",
769-
"value": "string"
771+
"value": ["string"]
770772
},
771773
"client_auth": {
772774
"default": "string",
@@ -832,7 +834,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
832834
"secret": true,
833835
"shorthand": "string",
834836
"usage": "string",
835-
"value": "string"
837+
"value": ["string"]
836838
},
837839
"min_version": {
838840
"default": "string",

‎docs/api/parameters.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,17 @@ curl -X GET http://coder-server:8080/api/v2/parameters/{scope}/{id} \
5959

6060
Status Code **200**
6161

62-
| Name | Type | Required | Restrictions | Description |
63-
| ---------------------- | ----------------- | -------- | ------------ | ------------------------------------------------- |
64-
| `[array item]` | array | false | | [Parameter represents a set value for the scope.] |
65-
| `» created_at` | string(date-time) | false | | |
66-
| `» destination_scheme` | string | false | | |
67-
| `» id` | string(uuid) | false | | |
68-
| `» name` | string | false | | |
69-
| `» scope` | string | false | | |
70-
| `» scope_id` | string(uuid) | false | | |
71-
| `» source_scheme` | string | false | | |
72-
| `» updated_at` | string(date-time) | false | | |
62+
| Name | Type | Required | Restrictions | Description |
63+
| ---------------------- | ------------------------------------- | -------- | ------------ | ------------------------------------------------- |
64+
| `[array item]` | array | false | | [Parameter represents a set value for the scope.] |
65+
| `» created_at` | string(date-time) | false | | |
66+
| `» destination_scheme` | `codersdk.ParameterDestinationScheme` | false | | |
67+
| `» id` | string(uuid) | false | | |
68+
| `» name` | string | false | | |
69+
| `» scope` | `codersdk.ParameterScope` | false | | |
70+
| `» scope_id` | string(uuid) | false | | |
71+
| `» source_scheme` | `codersdk.ParameterSourceScheme` | false | | |
72+
| `» updated_at` | string(date-time) | false | | |
7373

7474
#### Enumerated Values
7575

0 commit comments

Comments
 (0)