opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: include server agent API version in buildinfo (#11057)

Browse Source 
First part of #10340 -- we need this version to compare with agents to tell if they are on a deprecated Agent API version
This commit is contained in:
Spike Curtis
2023-12-08 12:50:25 +04:00
committed by GitHub
parent f0969f99ad
commit b4ca1d6579
9 changed files with 33 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/general.md
Generated
+1
View File
@@ -53,6 +53,7 @@ curl -X GET http://coder-server:8080/api/v2/buildinfo \
```json
{
"agent_api_version": "string",
"dashboard_url": "string",
"external_url": "string",
"version": "string",
docs/api/schemas.md
Generated
+8 -6
View File
@@ -1430,6 +1430,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
```json
{
"agent_api_version": "string",
"dashboard_url": "string",
"external_url": "string",
"version": "string",
@@ -1439,12 +1440,13 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `dashboard_url` | string | false | | Dashboard URL is the URL to hit the deployment's dashboard. For external workspace proxies, this is the coderd they are connected to. |
| `external_url` | string | false | | External URL references the current Coder version. For production builds, this will link directly to a release. For development builds, this will link to a commit. |
| `version` | string | false | | Version returns the semantic version of the build. |
| `workspace_proxy` | boolean | false | | |
| Name | Type | Required | Restrictions | Description |
| ------------------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `agent_api_version` | string | false | | Agent api version is the current version of the Agent API (back versions MAY still be supported). |
| `dashboard_url` | string | false | | Dashboard URL is the URL to hit the deployment's dashboard. For external workspace proxies, this is the coderd they are connected to. |
| `external_url` | string | false | | External URL references the current Coder version. For production builds, this will link directly to a release. For development builds, this will link to a commit. |
| `version` | string | false | | Version returns the semantic version of the build. |
| `workspace_proxy` | boolean | false | | |
## codersdk.BuildReason