Fix: rename apidocs to apidoc

mtojek · mtojek · commit 2564f31b5c5b · 2022-12-15T17:09:35.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 \
-	coderd/apidocs/swagger.json
+	coderd/apidoc/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 coderd/apidocs/swagger.json"
+	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/apidoc/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/swagger.json: $(shell find scripts/apidocgen -type f | grep -v node_modules) $(wildcard coderd/*.go)
+coderd/apidoc/swagger.json: $(shell find scripts/apidocgen -type f | grep -v node_modules) $(wildcard coderd/*.go)
 	./scripts/apidocgen/generate.sh
 	cd site
 	yarn run format:write ../docs/api ../docs/manifest.json
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -1,6 +1,6 @@
-// Package apidocs GENERATED BY SWAG; DO NOT EDIT
+// Package apidoc GENERATED BY SWAG; DO NOT EDIT
 // This file was generated by swaggo/swag
-package apidocs
+package apidoc
 
 import "github.com/swaggo/swag"
 
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -37,7 +37,7 @@ import (
 	"github.com/coder/coder/buildinfo"
 
 	// Used to serve the Swagger endpoint
-	_ "github.com/coder/coder/coderd/apidocs"
+	_ "github.com/coder/coder/coderd/apidoc"
 	"github.com/coder/coder/coderd/audit"
 	"github.com/coder/coder/coderd/awsidentity"
 	"github.com/coder/coder/coderd/database"
diff --git a/scripts/apidocgen/generate.sh b/scripts/apidocgen/generate.sh
@@ -21,7 +21,7 @@ echo "Use temporary file: ${API_MD_TMP_FILE}"
 	go run github.com/swaggo/swag/cmd/swag@v1.8.6 init \
 		--generalInfo="coderd.go" \
 		--dir="./coderd,./codersdk" \
-		--output="./coderd/apidocs" \
+		--output="./coderd/apidoc" \
 		--outputTypes="go,json" \
 		--parseDependency=true
 ) || exit $?
@@ -39,7 +39,7 @@ echo "Use temporary file: ${API_MD_TMP_FILE}"
 		--search false \
 		--omitHeader true \
 		--language_tabs "shell:curl" \
-		--summary "../../coderd/apidocs/swagger.json" \
+		--summary "../../coderd/apidoc/swagger.json" \
 		--outfile "${API_MD_TMP_FILE}"
 ) || exit $?
 
