Feature/codegen automation (#58)

Author: stark-cybertech

.github/workflows/update_api_spec.yml

@@ -0,0 +1,66 @@
+# This workflow should generate code based on the openapi.yaml and commit it to the branch.
+name: Update API Spec
+
+# This workflow is triggered only when called by another workflow
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'api/openapi.yaml'
+
+jobs:
+
+  generate:
+    name: Generate code from OpenAPI spec
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Make Scripts Executable
+        run: |
+          chmod +x api/scripts/gen_docs.sh
+          chmod +x api/scripts/gen_spring.sh
+          chmod +x api/scripts/gen_typescript.sh
+          chmod +x api/scripts/install_tools.sh
+          chmod +x api/scripts/lint.sh
+        
+      - name: Install Tools
+        run: ./api/scripts/install_tools.sh
+        shell: bash
+
+      - name: Lint
+        run: ./api/scripts/lint.sh
+        shell: bash
+        
+      - name: Generate Docs
+        run: ./api/scripts/gen_docs.sh
+        shell: bash
+
+      - name: Generate Spring Code
+        run: ./api/scripts/gen_spring.sh
+        shell: bash
+
+      - name: Generate api.ts
+        run: ./api/scripts/gen_typescript.sh
+        shell: bash
+
+      - name: Setup Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Stage Generated Code
+        run: |
+          git add server/matching/generated
+          git add server/user/generated
+          git add server/gateway/generated
+          git add client/src/api.ts
+          git add docs/api.html
+
+      - name: Commit & Push Generated Code
+        run: | 
+          git commit -m "gen: generate code and documentation based on latest version of openapi.yaml"
+          git push

api/changelogs/changelog_v2_1.md

@@ -0,0 +1,69 @@
+## Info
+### Version
+v2.1
+### Date
+2025-06-27
+### Autor
+James Stark
+## Changelog:
+
+### Models
+- Add new Collection models
+    - these are returned by paths instead of {array[Object]}
+    - this should not change return types, just make code-generation cleaner
+- Flattened directory structure
+    - this avoids openapi-codegen from generating several different model files when referencing across subfolders
+
+``` diff
+
+@@ Collections: @@
++ add model UserCollection
++ add model MatchCollection
++ add model MatchRequestCollection
++ add model ConversationStarterCollection
+# add collection objects {array[Object]} to make return types that contain several objects cleaner
+# this should not change the return types themselves, just make codegen cleaner
+
+@@ All @@
+- remove model.yaml from subfolders ../models/{collections | values | masks | objects}/model
++ insert entry for each model into openapi.yaml
++ update refernces to point at new flattened model
+# this helps prevent openapi-codegen from generating multiple model files for each relative path
+
+@ Update / New @@
+- remove all models with template NewObject
+- remove all models with template UpdateObject
++ insert models with template ObjectNew
++ insert models with template ObjectUpdate
+# this helps keep things together alphabetically
+
+```
+
+### Paths
+- Replace {array[Object]} with ObjectCollections
+    - this should not change return types, just make code-generation cleaner
+- updated refs to point to new flatend models in Openapi.yaml
+
+``` diff
+
+@@ All @@
+- remove model references to subfolders ../models/{collections | values | masks | objects}/model
++ insert model references to new flattened structure within openapi.yaml
+# this helps prevent openapi-codegen from generating multiple model files for each relative path
+
+@@ /api/v2/matching/matches/{user-id} GET @@
+- remove response object {array[Match]}
++ insert response object MatchCollection
+
+@@ /api/v2/matching/requests/{user-id} GET @@
+- remove response object {array[MatchRequest]}
++ insert response object MatchRequestCollection
+
+@@ /api/v2/genai/conversation-starter GET @@
+- remove request object {array[User]}
++ insert request object UserCollection
+- remove response object {array[ConversationStarter]}
++ insert response object ConversationStarterCollection
+
+
+```