Skip to content

Commit 04540f8

Browse files
mtojekmtojek
committed
Fix merge
1 parent 1c8b44f commit 04540f8

File tree

5 files changed

+43
-9
lines changed

5 files changed

+43
-9
lines changed

‎Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/me
458458
coderd/apidocs/swagger.json: $(shell find scripts/apidocgen -type f | grep -v node_modules) $(wildcard coderd/*.go)
459459
./scripts/apidocgen/generate.sh
460460
cd site
461-
yarn run format:write ../docs
461+
yarn run format:write ../docs/api
462462

463463
update-golden-files: cli/testdata/.gen-golden
464464
.PHONY: update-golden-files

‎coderd/apidocs/docs.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -669,6 +669,10 @@ const docTemplate = `{
669669
"description": "DisplayName is a friendly name for the app.",
670670
"type": "string"
671671
},
672+
"external": {
673+
"description": "External specifies whether the URL should be opened externally on\nthe client or not.",
674+
"type": "boolean"
675+
},
672676
"health": {
673677
"type": "string"
674678
},
@@ -693,6 +697,10 @@ const docTemplate = `{
693697
"subdomain": {
694698
"description": "Subdomain denotes whether the app should be accessed via a path on the\n` + "`" + `coder server` + "`" + ` or via a hostname-based dev URL. If this is set to true\nand there is no app wildcard configured on the server, the app will not\nbe accessible in the UI.",
695699
"type": "boolean"
700+
},
701+
"url": {
702+
"description": "URL is the address being proxied to inside the workspace.\nIf external is specified, this will be opened on the client.",
703+
"type": "string"
696704
}
697705
}
698706
},

‎coderd/apidocs/swagger.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -661,6 +661,10 @@
661661
"description": "DisplayName is a friendly name for the app.",
662662
"type": "string"
663663
},
664+
"external": {
665+
"description": "External specifies whether the URL should be opened externally on\nthe client or not.",
666+
"type": "boolean"
667+
},
664668
"health": {
665669
"type": "string"
666670
},
@@ -685,6 +689,10 @@
685689
"subdomain": {
686690
"description": "Subdomain denotes whether the app should be accessed via a path on the\n`coder server` or via a hostname-based dev URL. If this is set to true\nand there is no app wildcard configured on the server, the app will not\nbe accessible in the UI.",
687691
"type": "boolean"
692+
},
693+
"url": {
694+
"description": "URL is the address being proxied to inside the workspace.\nIf external is specified, this will be opened on the client.",
695+
"type": "string"
688696
}
689697
}
690698
},

‎docs/api/schemas.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,7 @@
326326
{
327327
"command": "string",
328328
"display_name": "string",
329+
"external": true,
329330
"health": "string",
330331
"healthcheck": {
331332
"interval": 0,
@@ -336,7 +337,8 @@
336337
"id": "string",
337338
"sharing_level": "string",
338339
"slug": "string",
339-
"subdomain": true
340+
"subdomain": true,
341+
"url": "string"
340342
}
341343
],
342344
"architecture": "string",
@@ -443,6 +445,7 @@
443445
{
444446
"command": "string",
445447
"display_name": "string",
448+
"external": true,
446449
"health": "string",
447450
"healthcheck": {
448451
"interval": 0,
@@ -453,7 +456,8 @@
453456
"id": "string",
454457
"sharing_level": "string",
455458
"slug": "string",
456-
"subdomain": true
459+
"subdomain": true,
460+
"url": "string"
457461
}
458462
],
459463
"architecture": "string",
@@ -523,6 +527,7 @@
523527
{
524528
"command": "string",
525529
"display_name": "string",
530+
"external": true,
526531
"health": "string",
527532
"healthcheck": {
528533
"interval": 0,
@@ -533,7 +538,8 @@
533538
"id": "string",
534539
"sharing_level": "string",
535540
"slug": "string",
536-
"subdomain": true
541+
"subdomain": true,
542+
"url": "string"
537543
}
538544
```
539545

@@ -543,13 +549,15 @@
543549
| ------------- | ---------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
544550
| command | string | false | none | none |
545551
| display_name | string | false | none | DisplayName is a friendly name for the app. |
552+
| external | boolean | false | none | External specifies whether the URL should be opened externally on<br>the client or not. |
546553
| health | string | false | none | none |
547554
| healthcheck | `codersdk.Healthcheck` | false | none | none |
548555
| icon | string | false | none | Icon is a relative path or external URL that specifies<br>an icon to be displayed in the dashboard. |
549556
| id | string | false | none | none |
550557
| sharing_level | string | false | none | none |
551558
| slug | string | false | none | Slug is a unique identifier within the agent. |
552559
| subdomain | boolean | false | none | Subdomain denotes whether the app should be accessed via a path on the<br>`coder server` or via a hostname-based dev URL. If this is set to true<br>and there is no app wildcard configured on the server, the app will not<br>be accessible in the UI. |
560+
| url | string | false | none | URL is the address being proxied to inside the workspace.<br>If external is specified, this will be opened on the client. |
553561

554562
## codersdk.WorkspaceBuild
555563

@@ -589,6 +597,7 @@
589597
{
590598
"command": "string",
591599
"display_name": "string",
600+
"external": true,
592601
"health": "string",
593602
"healthcheck": {
594603
"interval": 0,
@@ -599,7 +608,8 @@
599608
"id": "string",
600609
"sharing_level": "string",
601610
"slug": "string",
602-
"subdomain": true
611+
"subdomain": true,
612+
"url": "string"
603613
}
604614
],
605615
"architecture": "string",
@@ -699,6 +709,7 @@
699709
{
700710
"command": "string",
701711
"display_name": "string",
712+
"external": true,
702713
"health": "string",
703714
"healthcheck": {
704715
"interval": 0,
@@ -709,7 +720,8 @@
709720
"id": "string",
710721
"sharing_level": "string",
711722
"slug": "string",
712-
"subdomain": true
723+
"subdomain": true,
724+
"url": "string"
713725
}
714726
],
715727
"architecture": "string",
@@ -844,13 +856,15 @@
844856
{
845857
"command": "string",
846858
"display_name": "string",
859+
"external": true,
847860
"health": "string",
848861
"healthcheck": {},
849862
"icon": "string",
850863
"id": "string",
851864
"sharing_level": "string",
852865
"slug": "string",
853-
"subdomain": true
866+
"subdomain": true,
867+
"url": "string"
854868
}
855869
],
856870
"architecture": "string",

‎docs/api/workspaces.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,15 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
7373
{
7474
"command": "string",
7575
"display_name": "string",
76+
"external": true,
7677
"health": "string",
7778
"healthcheck": {},
7879
"icon": "string",
7980
"id": "string",
8081
"sharing_level": "string",
8182
"slug": "string",
82-
"subdomain": true
83+
"subdomain": true,
84+
"url": "string"
8385
}
8486
],
8587
"architecture": "string",
@@ -235,6 +237,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{id} \
235237
{
236238
"command": "string",
237239
"display_name": "string",
240+
"external": true,
238241
"health": "string",
239242
"healthcheck": {
240243
"interval": 0,
@@ -245,7 +248,8 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{id} \
245248
"id": "string",
246249
"sharing_level": "string",
247250
"slug": "string",
248-
"subdomain": true
251+
"subdomain": true,
252+
"url": "string"
249253
}
250254
],
251255
"architecture": "string",

0 commit comments

Comments
 (0)