WIP

mtojek · mtojek · commit b7c22dc0ea1b · 2022-12-14T17:44:46.000+01:00
diff --git a/Makefile b/Makefile
@@ -401,13 +401,13 @@ gen: \
 	provisionerd/proto/provisionerd.pb.go \
 	site/src/api/typesGenerated.ts \
 	docs/admin/prometheus.md \
-	$(wildcard docs/api/*.md) $(wildcard coder/apidocs/*)
+	coderd/apidocs/swagger.json
 .PHONY: gen
 
 # Mark all generated files as fresh so make thinks they're up-to-date. This is
 # used during releases so we don't run generation scripts.
 gen/mark-fresh:
-	files="coderd/database/dump.sql coderd/database/querier.go provisionersdk/proto/provisioner.pb.go provisionerd/proto/provisionerd.pb.go site/src/api/typesGenerated.ts docs/admin/prometheus.md $(wildcard docs/api/*.md) $(wildcard coder/apidocs/*) $(wildcard coderd/*.go)"
+	files="coderd/database/dump.sql coderd/database/querier.go provisionersdk/proto/provisioner.pb.go provisionerd/proto/provisionerd.pb.go site/src/api/typesGenerated.ts docs/admin/prometheus.md coderd/apidocs/swagger.json"
 	for file in $$files; do
 		echo "$$file"
 		if [ ! -f "$$file" ]; then
@@ -455,7 +455,7 @@ docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/me
 	cd site
 	yarn run format:write ../docs/admin/prometheus.md
 
-coderd/apidocs: $(shell find scripts/apidocgen -type f | grep -v node_modules) $(wildcard coderd/*.go)
+coderd/apidocs/swagger.json: $(shell find scripts/apidocgen -type f | grep -v node_modules) $(wildcard coderd/*.go)
 	./scripts/apidocgen/generate.sh
 	cd site
 ifdef CI
diff --git a/coderd/apidocs/docs.go b/coderd/apidocs/docs.go
@@ -214,7 +214,7 @@ const docTemplate = `{
                 "tags": [
                     "Workspaces"
                 ],
-                "summary": "Get workspace metadata",
+                "summary": "Get workspace metadata 2",
                 "operationId": "get-workspace",
                 "parameters": [
                     {
diff --git a/coderd/apidocs/swagger.json b/coderd/apidocs/swagger.json
@@ -206,7 +206,7 @@
                 "tags": [
                     "Workspaces"
                 ],
-                "summary": "Get workspace metadata",
+                "summary": "Get workspace metadata 2",
                 "operationId": "get-workspace",
                 "parameters": [
                     {
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -43,7 +43,7 @@ var (
 	errDeadlineBeforeStart = xerrors.New("new deadline must be before workspace start time")
 )
 
-// @Summary Get workspace metadata
+// @Summary Get workspace metadata 2
 // @ID get-workspace
 // @Security CoderSessionToken
 // @Produce json
diff --git a/docs/api/workspaces.md b/docs/api/workspaces.md
@@ -169,7 +169,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
 
 To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
 
-## Get workspace metadata
+## Get workspace metadata 2
 
 ### Code samples
 

Original file line number	Diff line number	Diff line change
@@ -214,7 +214,7 @@ const docTemplate = `{
`214`	`214`	`"tags": [`
`215`	`215`	`"Workspaces"`
`216`	`216`	`],`
`217`		`- "summary": "Get workspace metadata",`
	`217`	`+ "summary": "Get workspace metadata 2",`
`218`	`218`	`"operationId": "get-workspace",`
`219`	`219`	`"parameters": [`
`220`	`220`	`{`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@`
`206`	`206`	`"tags": [`
`207`	`207`	`"Workspaces"`
`208`	`208`	`],`
`209`		`- "summary": "Get workspace metadata",`
	`209`	`+ "summary": "Get workspace metadata 2",`
`210`	`210`	`"operationId": "get-workspace",`
`211`	`211`	`"parameters": [`
`212`	`212`	`{`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ var (`
`43`	`43`	`errDeadlineBeforeStart = xerrors.New("new deadline must be before workspace start time")`
`44`	`44`	`)`
`45`	`45`
`46`		`-// @Summary Get workspace metadata`
	`46`	`+// @Summary Get workspace metadata 2`
`47`	`47`	`// @ID get-workspace`
`48`	`48`	`// @Security CoderSessionToken`
`49`	`49`	`// @Produce json`