Add check-api-reference makefile command

Author: Syriiin

.github/workflows/test-on-push.yml

@@ -12,3 +12,9 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: make test-e2e
+
+  check-api-reference:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - run: make check-api-reference

Makefile

@@ -27,11 +27,11 @@ start-dev: build-dev	## Starts development environment
 clean-dev:	## Cleans development environment
 	$(COMPOSE_APP_DEV) down --remove-orphans
 
-update-openapi-schemas:	## Updates OpenAPI schemas in docs site
-	curl localhost:5000/swagger/v1/swagger.json -o docs/docs/api-reference/difficalcy-osu.json
-	curl localhost:5001/swagger/v1/swagger.json -o docs/docs/api-reference/difficalcy-taiko.json
-	curl localhost:5002/swagger/v1/swagger.json -o docs/docs/api-reference/difficalcy-catch.json
-	curl localhost:5003/swagger/v1/swagger.json -o docs/docs/api-reference/difficalcy-mania.json
+update-api-reference:	## Updates OpenAPI schemas in docs site
+	@scripts/update-api-reference.sh
+
+check-api-reference: ## Checks OpenAPI schemas are updated
+	@scripts/check-api-reference.sh
 
 build-docs:	## Builds documentation site
 	$(COMPOSE_RUN_DOCS) build --strict --clean

scripts/check-api-reference.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+
+diff -q docs/docs/api-reference/difficalcy-osu.json <(curl --silent localhost:5000/swagger/v1/swagger.json)
+diff -q docs/docs/api-reference/difficalcy-taiko.json <(curl --silent localhost:5001/swagger/v1/swagger.json)
+diff -q docs/docs/api-reference/difficalcy-catch.json <(curl --silent localhost:5002/swagger/v1/swagger.json)
+diff -q docs/docs/api-reference/difficalcy-mania.json <(curl --silent localhost:5003/swagger/v1/swagger.json)

scripts/update-api-reference.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+
+curl localhost:5000/swagger/v1/swagger.json -o docs/docs/api-reference/difficalcy-osu.json
+curl localhost:5001/swagger/v1/swagger.json -o docs/docs/api-reference/difficalcy-taiko.json
+curl localhost:5002/swagger/v1/swagger.json -o docs/docs/api-reference/difficalcy-catch.json
+curl localhost:5003/swagger/v1/swagger.json -o docs/docs/api-reference/difficalcy-mania.json