Check if open api has been regenerated (#61)

## Description, Motivation and Context

Check if the room manager open api is up to date, so every app using
room manager has an up-to-date reference.


## Types of changes

- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to
      not work as expected)

.github/workflows/static.yaml

@@ -38,3 +38,14 @@ jobs:
 
       - name: Check typing
         run: yarn typecheck
+
+      - name: Generate OpenAPI reference 📸
+        run: yarn gen:openapi ref.yaml
+
+      - name: Compare OpenAPI reference 🔦
+        run: |
+          RM_PATH=examples/room-manager
+          if ! cmp --silent "$RM_PATH/openapi.yaml" "$RM_PATH/ref.yaml"; then
+            echo "OpenAPI spec is out of date. Please run 'yarn gen:openapi' and commit the changes."
+            exit 1
+          fi

examples/room-manager/.prettierignore

@@ -0,0 +1 @@
+openapi.yaml

examples/room-manager/openapi.yaml

@@ -8,7 +8,7 @@ paths:
   /health:
     get:
       responses:
-        '200':
+        "200":
           description: Default Response
   /api/rooms:
     get:
@@ -27,7 +27,7 @@ paths:
           name: peerName
           required: true
       responses:
-        '200':
+        "200":
           description: Default Response
           content:
             application/json:
@@ -55,7 +55,7 @@ paths:
                 required:
                   - peerToken
                   - url
-        '410':
+        "410":
           description: Default Response
           content:
             application/json:
@@ -70,7 +70,7 @@ paths:
                     type: string
                 required:
                   - error
-        '500':
+        "500":
           description: Default Response
           content:
             application/json:
@@ -99,12 +99,12 @@ paths:
           name: roomName
           required: true
       responses:
-        '200':
+        "200":
           description: Default Response
   /api/rooms/webhook:
     post:
       responses:
-        '200':
+        "200":
           description: Default Response
 servers:
   - url: http://localhost:5004

examples/room-manager/scripts/generate-openapi-schema.ts

@@ -1,6 +1,8 @@
 import { writeFile } from 'node:fs/promises';
 import { fastify } from '../src';
 
+const [fileName] = process.argv.slice(2);
+
 (async () => {
   await fastify.ready();
 
@@ -9,7 +11,7 @@ import { fastify } from '../src';
   }
 
   const schema = fastify.swagger({ yaml: true });
-  await writeFile('openapi.yaml', schema, { flag: 'w+' });
+  await writeFile(fileName ?? 'openapi.yaml', schema, { flag: 'w+' });
 
   await fastify.close();
 })();

examples/room-manager/src/index.ts

@@ -6,7 +6,7 @@ import { roomsEndpoints } from './rooms';
 import { ServerMessage } from '@fishjam-cloud/js-server-sdk/proto';
 import healthcheck from 'fastify-healthcheck';
 import fastifySwagger from '@fastify/swagger';
-import { openapi } from './opanapi';
+import openapi from './openapi';
 
 const envToLogger = {
   development: {

examples/room-manager/src/opanapi.ts → examples/room-manager/src/openapi.ts

@@ -1,4 +1,4 @@
-export const openapi = {
+export default {
   openapi: '3.0.0',
   info: {
     title: 'Room manager',