WIP

mtojek · mtojek · commit a087aceba84a · 2022-12-12T14:48:19.000+01:00
diff --git a/coderd/apidocs/docs.go b/coderd/apidocs/docs.go
@@ -594,7 +594,7 @@ const docTemplate = `{
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
 	Version:          "2.0",
-	Host:             "",
+	Host:             "localhost:8080",
 	BasePath:         "/api/v2",
 	Schemes:          []string{},
 	Title:            "Coderd API",
diff --git a/coderd/apidocs/swagger.json b/coderd/apidocs/swagger.json
@@ -15,6 +15,7 @@
         },
         "version": "2.0"
     },
+    "host": "localhost:8080",
     "basePath": "/api/v2",
     "paths": {
         "/workspaces": {
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -123,6 +123,7 @@ type Options struct {
 // @license.name AGPL-3.0
 // @license.url https://github.com/coder/coder/blob/main/LICENSE
 
+// @host localhost:8080
 // @BasePath /api/v2
 
 // @securitydefinitions.apiKey CoderSessionToken
diff --git a/docs/api.md b/docs/api.md
@@ -1,17 +1,3 @@
----
-title: Coderd API v2.0
-language_tabs:
-  - shell: curl
-language_clients:
-  - shell: ""
-toc_footers: []
-includes: []
-search: false
-highlight_theme: darkula
-headingLevel: 2
-
----
-
 <!-- Generator: Widdershins v4.0.1 -->
 
 <h1 id="coderd-api">Coderd API v2.0</h1>
@@ -22,7 +8,7 @@ Coderd is the service created by running coder server. It is a thin API that con
 
 Base URLs:
 
-* <a href="/api/v2">/api/v2</a>
+* <a href="//localhost:8080/api/v2">//localhost:8080/api/v2</a>
 
 <a href="https://coder.com/legal/terms-of-service">Terms of service</a>
 Email: <a href="mailto:support@coder.com">API Support</a> Web: <a href="http://coder.com">API Support</a> 
@@ -43,7 +29,7 @@ License: <a href="https://github.com/coder/coder/blob/main/LICENSE">AGPL-3.0</a>
 
 ```shell
 # You can also use wget
-curl -X GET /api/v2/workspaces \
+curl -X GET /localhost:8080/api/v2/workspaces \
   -H 'Accept: application/json' \
   -H 'Coder-Session-Token: API_KEY'
 
@@ -217,7 +203,7 @@ CoderSessionToken
 
 ```shell
 # You can also use wget
-curl -X GET /api/v2/workspaces/{id} \
+curl -X GET /localhost:8080/api/v2/workspaces/{id} \
   -H 'Accept: application/json' \
   -H 'Coder-Session-Token: API_KEY'
 
diff --git a/scripts/apidocgen/generate.sh b/scripts/apidocgen/generate.sh
@@ -28,7 +28,8 @@ SCRIPT_DIR=$(dirname "${BASH_SOURCE[0]}")
 	#
 	node ./node_modules/widdershins/widdershins.js \
 		--search false \
-		--language_tabs 'shell:curl' \
+		--omitHeader true \
+		--language_tabs "shell:curl" \
 		--summary "../../coderd/apidocs/swagger.json" \
 		--outfile "../../docs/api.md"
 )

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,8 @@ SCRIPT_DIR=$(dirname "${BASH_SOURCE[0]}")`
`28`	`28`	`#`
`29`	`29`	`node ./node_modules/widdershins/widdershins.js \`
`30`	`30`	`--search false \`
`31`		`- --language_tabs 'shell:curl' \`
	`31`	`+ --omitHeader true \`
	`32`	`+ --language_tabs "shell:curl" \`
`32`	`33`	`--summary "../../coderd/apidocs/swagger.json" \`
`33`	`34`	`--outfile "../../docs/api.md"`
`34`	`35`	`)`