feat(ci): add API types sync check [BE-13014] (#3102)

Co-authored-by: Claude <noreply@anthropic.com>

.gitignore

@@ -14,7 +14,6 @@ debug-storybook.log
 .eslintcache
 __debug_bin*
 
-api/docs
 .idea
 .env
 go.work.sum

Makefile

@@ -119,20 +119,31 @@ dev-extension: build-server build-client ## Run the extension in development mod
 	make local -f build/docker-extension/Makefile
 
 ##@ Docs
-.PHONY: docs-build docs-validate docs-clean docs-validate-clean
+.PHONY: docs-build docs-validate docs-sync-check docs-clean docs-validate-clean
-docs-build: init-dist ## Build docs
+docs-build: ## Build docs
 	go mod download
-	cd api && $(SWAG) init -o "../dist/docs" -ot "yaml" -g ./http/handler/handler.go --parseDependency --parseInternal --parseDepth 2 -p pascalcase --markdownFiles ./ --overridesFile .swaggo
+	mkdir -p api/docs
+	cd api && $(SWAG) init -o "./docs" -ot "yaml" -g ./http/handler/handler.go --parseDependency --parseInternal --parseDepth 2 -p pascalcase --markdownFiles ./ --overridesFile .swaggo
 
 docs-validate: docs-build ## Validate docs
-	pnpm swagger2openapi --warnOnly dist/docs/swagger.yaml -o dist/docs/openapi.yaml
+	pnpm swagger2openapi --warnOnly api/docs/swagger.yaml -o api/docs/openapi.yaml
-	pnpm swagger-cli validate dist/docs/openapi.yaml
+	pnpm swagger-cli validate api/docs/openapi.yaml
+
+docs-sync-check: docs-build ## Check if committed API spec is in sync with Go annotations; fail if not
+	@if ! git diff --exit-code api/docs/swagger.yaml > /dev/null 2>&1; then \
+		echo ""; \
+		echo "ERROR: API spec is out of sync with Go annotations."; \
+		echo "Run 'make generate-api' in package/server-ce and commit the result."; \
+		echo ""; \
+		git diff --stat api/docs/swagger.yaml; \
+		exit 1; \
+	fi
 
 .PHONY: docs-serve
 docs-serve: docs-build ## Serve docs locally with Swagger UI on port 8080
 	docker run -p 8080:8080 \
 		-e SWAGGER_JSON=/foo/swagger.yaml \
-		-v $(PWD)/dist/docs:/foo \
+		-v $(PWD)/api/docs:/foo \
 		swaggerapi/swagger-ui
 
 .PHONY: generate-api

lint-staged.config.js

@@ -2,5 +2,5 @@ module.exports = {
   '*.(js|ts){,x}': 'pnpm eslint --cache --fix',
   '*.(ts){,x}': () => 'tsc --noEmit',
   '*.{js,ts,tsx,css,md,html,json}': 'pnpm prettier --log-level warn --write',
-  '*.go': () => 'make lint-server',
+  '*.go': () => ['make lint-server', 'make docs-sync-check'],
 };

openapi-ts.config.ts

@@ -1,7 +1,7 @@
 import { defineConfig } from '@hey-api/openapi-ts';
 
 export default defineConfig({
-  input: './dist/docs/openapi.yaml',
+  input: './api/docs/openapi.yaml',
   output: {
     path: 'app/react/portainer/generated-api/portainer',
     clean: true,