Skip to content

docs: update swaggo/swag v1.8.9 #5590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 10, 2023
Merged

docs: update swaggo/swag v1.8.9 #5590

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a46e7c8
docs: update swaggo/swag v1.8.9
mtojek Jan 5, 2023
4a38d40
Fix: format
mtojek Jan 5, 2023
12fbfb5
Merge branch 'main' into try-bump-swaggo
mtojek Jan 10, 2023
25af4d0
swaggo: time.Duration
mtojek Jan 10, 2023
7a9b226
swaggo: provisionertype
mtojek Jan 10, 2023
4cf0669
Fix: AuthorizationObject
mtojek Jan 10, 2023
b0813dd
Fix: enums
mtojek Jan 10, 2023
1fe5795
Fix: netip.Addr
mtojek Jan 10, 2023
c6e3b6d
Fix: clickable response properties
mtojek Jan 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
479 changes: 448 additions & 31 deletions coderd/apidoc/docs.go
View file
Open in desktop

Large diffs are not rendered by default.

410 changes: 366 additions & 44 deletions coderd/apidoc/swagger.json
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/api/agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,8 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/app-health \
```json
{
"healths": {
"property1": "string",
"property2": "string"
"property1": "disabled",
"property2": "disabled"
}
}
```
Expand Down Expand Up @@ -299,7 +299,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/metadata \
"command": "string",
"display_name": "string",
"external": true,
"health": "string",
"health": "disabled",
"healthcheck": {
"interval": 0,
"threshold": 0,
Expand Down Expand Up @@ -426,7 +426,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/report-stats \

```json
{
"report_interval": 0
"report_interval": -9223372036854776000
}
```

Expand Down
6 changes: 3 additions & 3 deletions docs/api/audit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?q=string \
{
"audit_logs": [
{
"action": "string",
"action": "create",
"additional_fields": [0],
"description": "string",
"diff": {
Expand All @@ -56,7 +56,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?q=string \
"resource_id": "string",
"resource_link": "string",
"resource_target": "string",
"resource_type": "string",
"resource_type": "organization",
"status_code": 0,
"time": "string",
"user": {
Expand All @@ -72,7 +72,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?q=string \
"name": "string"
}
],
"status": "string",
"status": "active",
"username": "string"
},
"user_agent": "string"
Expand Down
334 changes: 172 additions & 162 deletions docs/api/builds.md
View file
Open in desktop

Large diffs are not rendered by default.

70 changes: 36 additions & 34 deletions docs/api/general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,15 +119,15 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"value": "string"
},
"agent_stat_refresh_interval": {
"default": 0,
"default": -9223372036854776000,
"enterprise": true,
"flag": "string",
"hidden": true,
"name": "string",
"secret": true,
"shorthand": "string",
"usage": "string",
"value": 0
"value": -9223372036854776000
},
"api_rate_limit": {
"default": 0,
Expand All @@ -152,15 +152,15 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"value": true
},
"autobuild_poll_interval": {
"default": 0,
"default": -9223372036854776000,
"enterprise": true,
"flag": "string",
"hidden": true,
"name": "string",
"secret": true,
"shorthand": "string",
"usage": "string",
"value": 0
"value": -9223372036854776000
},
"browser_only": {
"default": true,
Expand Down Expand Up @@ -274,7 +274,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
}
}
},
Expand Down Expand Up @@ -310,17 +310,19 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": {
"auth_url": "string",
"client_id": "string",
"id": "string",
"no_refresh": true,
"regex": "string",
"scopes": ["string"],
"token_url": "string",
"type": "string",
"validate_url": "string"
}
"value": [
{
"auth_url": "string",
"client_id": "string",
"id": "string",
"no_refresh": true,
"regex": "string",
"scopes": ["string"],
"token_url": "string",
"type": "string",
"validate_url": "string"
}
]
},
"http_address": {
"default": "string",
Expand All @@ -345,26 +347,26 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"value": true
},
"max_token_lifetime": {
"default": 0,
"default": -9223372036854776000,
"enterprise": true,
"flag": "string",
"hidden": true,
"name": "string",
"secret": true,
"shorthand": "string",
"usage": "string",
"value": 0
"value": -9223372036854776000
},
"metrics_cache_refresh_interval": {
"default": 0,
"default": -9223372036854776000,
"enterprise": true,
"flag": "string",
"hidden": true,
"name": "string",
"secret": true,
"shorthand": "string",
"usage": "string",
"value": 0
"value": -9223372036854776000
},
"oauth2": {
"github": {
Expand Down Expand Up @@ -399,7 +401,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
},
"allowed_teams": {
"default": ["string"],
Expand All @@ -410,7 +412,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
},
"client_id": {
"default": "string",
Expand Down Expand Up @@ -490,7 +492,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
},
"ignore_email_verified": {
"default": true,
Expand Down Expand Up @@ -523,7 +525,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
},
"username_field": {
"default": "string",
Expand Down Expand Up @@ -598,26 +600,26 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
},
"provisioner": {
"daemon_poll_interval": {
"default": 0,
"default": -9223372036854776000,
"enterprise": true,
"flag": "string",
"hidden": true,
"name": "string",
"secret": true,
"shorthand": "string",
"usage": "string",
"value": 0
"value": -9223372036854776000
},
"daemon_poll_jitter": {
"default": 0,
"default": -9223372036854776000,
"enterprise": true,
"flag": "string",
"hidden": true,
"name": "string",
"secret": true,
"shorthand": "string",
"usage": "string",
"value": 0
"value": -9223372036854776000
},
"daemons": {
"default": 0,
Expand All @@ -631,15 +633,15 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"value": 0
},
"force_cancel_interval": {
"default": 0,
"default": -9223372036854776000,
"enterprise": true,
"flag": "string",
"hidden": true,
"name": "string",
"secret": true,
"shorthand": "string",
"usage": "string",
"value": 0
"value": -9223372036854776000
}
},
"proxy_trusted_headers": {
Expand All @@ -651,7 +653,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
},
"proxy_trusted_origins": {
"default": ["string"],
Expand All @@ -662,7 +664,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
},
"scim_api_key": {
"default": "string",
Expand Down Expand Up @@ -766,7 +768,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
},
"client_auth": {
"default": "string",
Expand Down Expand Up @@ -832,7 +834,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
"secret": true,
"shorthand": "string",
"usage": "string",
"value": "string"
"value": ["string"]
},
"min_version": {
"default": "string",
Expand Down
22 changes: 11 additions & 11 deletions docs/api/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,17 +59,17 @@ curl -X GET http://coder-server:8080/api/v2/parameters/{scope}/{id} \

Status Code **200**

| Name | Type | Required | Restrictions | Description |
| ---------------------- | ----------------- | -------- | ------------ | ------------------------------------------------- |
| `[array item]` | array | false | | [Parameter represents a set value for the scope.] |
| `» created_at` | string(date-time) | false | | |
| `» destination_scheme` | string | false | | |
| `» id` | string(uuid) | false | | |
| `» name` | string | false | | |
| `» scope` | string | false | | |
| `» scope_id` | string(uuid) | false | | |
| `» source_scheme` | string | false | | |
| `» updated_at` | string(date-time) | false | | |
| Name | Type | Required | Restrictions | Description |
| ---------------------- | ------------------------------------- | -------- | ------------ | ------------------------------------------------- |
| `[array item]` | array | false | | [Parameter represents a set value for the scope.] |
| `» created_at` | string(date-time) | false | | |
| `» destination_scheme` | `codersdk.ParameterDestinationScheme` | false | | |
| `» id` | string(uuid) | false | | |
| `» name` | string | false | | |
| `» scope` | `codersdk.ParameterScope` | false | | |
| `» scope_id` | string(uuid) | false | | |
| `» source_scheme` | `codersdk.ParameterSourceScheme` | false | | |
| `» updated_at` | string(date-time) | false | | |

#### Enumerated Values

Expand Down
Loading