opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-22 13:10:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: add dismissed property to the healthcheck section (#10940)

Browse Source
This commit is contained in:
Marcin Tojek
2023-11-29 16:37:40 +00:00
committed by GitHub
parent d374becdeb
commit 2b574e2b2d
19 changed files with 225 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/debug.md
Generated
+5
View File
@@ -47,6 +47,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
{
"access_url": {
"access_url": "string",
"dismissed": true,
"error": "string",
"healthy": true,
"healthz_response": "string",
@@ -57,6 +58,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
},
"coder_version": "string",
"database": {
"dismissed": true,
"error": "string",
"healthy": true,
"latency": "string",
@@ -67,6 +69,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"warnings": ["string"]
},
"derp": {
"dismissed": true,
"error": "string",
"healthy": true,
"netcheck": {
@@ -249,12 +252,14 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"websocket": {
"body": "string",
"code": 0,
"dismissed": true,
"error": "string",
"healthy": true,
"severity": "ok",
"warnings": ["string"]
},
"workspace_proxy": {
"dismissed": true,
"error": "string",
"healthy": true,
"severity": "ok",
docs/api/schemas.md
Generated
+23 -8
View File
@@ -7302,6 +7302,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
```json
{
"dismissed": true,
"error": "string",
"healthy": true,
"netcheck": {
@@ -7483,6 +7484,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
| Name | Type | Required | Restrictions | Description |
| ------------------ | -------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `netcheck` | [netcheck.Report](#netcheckreport) | false | | |
@@ -7540,6 +7542,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
```json
{
"access_url": "string",
"dismissed": true,
"error": "string",
"healthy": true,
"healthz_response": "string",
@@ -7555,6 +7558,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
| Name | Type | Required | Restrictions | Description |
| ------------------ | ---------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `access_url` | string | false | | |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `healthz_response` | string | false | | |
@@ -7575,6 +7579,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
```json
{
"dismissed": true,
"error": "string",
"healthy": true,
"latency": "string",
@@ -7590,6 +7595,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
| Name | Type | Required | Restrictions | Description |
| -------------- | ---------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `latency` | string | false | | |
@@ -7613,6 +7619,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
{
"access_url": {
"access_url": "string",
"dismissed": true,
"error": "string",
"healthy": true,
"healthz_response": "string",
@@ -7623,6 +7630,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
},
"coder_version": "string",
"database": {
"dismissed": true,
"error": "string",
"healthy": true,
"latency": "string",
@@ -7633,6 +7641,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
"warnings": ["string"]
},
"derp": {
"dismissed": true,
"error": "string",
"healthy": true,
"netcheck": {
@@ -7815,12 +7824,14 @@ If the schedule is empty, the user will be updated to use the default schedule.|
"websocket": {
"body": "string",
"code": 0,
"dismissed": true,
"error": "string",
"healthy": true,
"severity": "ok",
"warnings": ["string"]
},
"workspace_proxy": {
"dismissed": true,
"error": "string",
"healthy": true,
"severity": "ok",
@@ -7885,6 +7896,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
{
"body": "string",
"code": 0,
"dismissed": true,
"error": "string",
"healthy": true,
"severity": "ok",
@@ -7894,14 +7906,15 @@ If the schedule is empty, the user will be updated to use the default schedule.|
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | ---------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `body` | string | false | | |
| `code` | integer | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `severity` | [health.Severity](#healthseverity) | false | | |
| `warnings` | array of string | false | | |
| Name | Type | Required | Restrictions | Description |
| ----------- | ---------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `body` | string | false | | |
| `code` | integer | false | | |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `severity` | [health.Severity](#healthseverity) | false | | |
| `warnings` | array of string | false | | |
#### Enumerated Values
@@ -7915,6 +7928,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
```json
{
"dismissed": true,
"error": "string",
"healthy": true,
"severity": "ok",
@@ -7953,6 +7967,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
| Name | Type | Required | Restrictions | Description |
| ------------------- | ---------------------------------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | |
| `severity` | [health.Severity](#healthseverity) | false | | |