fix: update OpenAPI paths and documentation references

Author: TerrorSquad

.github/copilot-instructions.md

@@ -49,7 +49,7 @@ If inside a DDEV project, prefix composer commands with `ddev`. Otherwise call `
 | Run all static checks (if aggregated) | Suggest existing combined script if present (inspect composer.json) |
 | Commit message lint | Git hook (do not manually run unless needed) |
 | Branch validation | `validate-branch-name` via hook or `node_modules/.bin/validate-branch-name -t <branch>` |
-| OpenAPI editing | Modify `documentation/openapi.yml` (do not generate large boilerplate) |
+| OpenAPI editing | Modify `openapi/openapi.yml` (do not generate large boilerplate) |
 
 Copilot SHOULD NOT generate raw php-cs-fixer, phpstan, rector, or psalm command lines if a composer script already exists.
 
@@ -79,7 +79,7 @@ Copilot SHOULD NOT generate raw php-cs-fixer, phpstan, rector, or psalm command
 | `sonar-project.properties` | SonarQube settings |
 | `.editorconfig` | Base editor formatting |
 | `.vscode/` & `.phpstorm/` | Editor recommendations |
-| `documentation/openapi.yml` | API spec seed |
+| `openapi/openapi.yml` | API spec seed |
 
 Copilot SHOULD reference or extend these—NOT generate new parallel config files with different names.
 
@@ -171,7 +171,6 @@ Copilot SHOULD:
 The documentation is a **Nuxt 3** application using the **Docus** theme.
 - Content is in `docs/content/`.
 - Run `npm run dev` (or `pnpm dev`) inside `docs/` to preview.
-- Do not confuse `docs/` (the website) with `booster/documentation/` (the OpenAPI starter for consumers).
 
 ---
 End of repository-specific Copilot instructions.

booster/.husky/README.md

@@ -73,7 +73,7 @@ Enforces commit message standards and branch naming.
 Ensures the codebase is ready for deployment.
 
 - **Tests**: Runs the fast test suite (`composer test:pest`).
-- **API Documentation**: Checks if `documentation/openapi.yml` matches the code.
+- **API Documentation**: Checks if `openapi/openapi.yml` matches the code.
   - If outdated, it **regenerates** the docs and **auto-commits** them.
   - **Important**: If an auto-commit occurs, the hook will warn you to **push again** to include the new commit.
 

booster/.husky/shared/extras.ts

@@ -49,7 +49,7 @@ export async function generateApiDocs(): Promise<void> {
       const diffResult = await exec(['git', 'diff', '--name-only'], { quiet: true })
       const modifiedFiles = diffResult.toString().trim().split('\n')
 
-      if (modifiedFiles.includes('documentation/openapi.yml')) {
+      if (modifiedFiles.includes('openapi/openapi.yml')) {
         log.info('API spec changed, regenerating HTML...')
 
         try {
@@ -58,7 +58,7 @@ export async function generateApiDocs(): Promise<void> {
 
           // Stage the generated files
           await exec(
-            ['git', 'add', 'documentation/openapi.html', 'documentation/openapi.yml'],
+            ['git', 'add', 'openapi/openapi.html', 'openapi/openapi.yml'],
             { quiet: true },
           )
 

booster/.husky/tests/shared/extras.test.ts

@@ -96,7 +96,7 @@ describe('extras.ts', () => {
       vi.mocked(fs.pathExists).mockResolvedValue(true)
       vi.mocked(exec)
         .mockResolvedValueOnce({} as any) // generate-api-spec
-        .mockResolvedValueOnce({ toString: () => 'documentation/openapi.yml' } as any) // git diff
+        .mockResolvedValueOnce({ toString: () => 'openapi/openapi.yml' } as any) // git diff
         .mockResolvedValueOnce({} as any) // generate html
         .mockResolvedValueOnce({} as any) // git add
         .mockRejectedValueOnce(new Error('diff failed')) // git diff (changes exist)
@@ -112,7 +112,7 @@ describe('extras.ts', () => {
       vi.mocked(fs.pathExists).mockResolvedValue(true)
       vi.mocked(exec)
         .mockResolvedValueOnce({} as any) // generate-api-spec
-        .mockResolvedValueOnce({ toString: () => 'documentation/openapi.yml' } as any) // git diff (spec changed)
+        .mockResolvedValueOnce({ toString: () => 'openapi/openapi.yml' } as any) // git diff (spec changed)
         .mockResolvedValueOnce({} as any) // generate html
         .mockResolvedValueOnce({} as any) // git add
         .mockResolvedValueOnce({} as any) // git diff (no staged changes)
@@ -126,7 +126,7 @@ describe('extras.ts', () => {
       vi.mocked(fs.pathExists).mockResolvedValue(true)
       vi.mocked(exec)
         .mockResolvedValueOnce({} as any) // generate-api-spec
-        .mockResolvedValueOnce({ toString: () => 'documentation/openapi.yml' } as any) // git diff
+        .mockResolvedValueOnce({ toString: () => 'openapi/openapi.yml' } as any) // git diff
         .mockRejectedValueOnce(new Error('html gen failed')) // generate html fails
 
       await expect(generateApiDocs()).rejects.toThrow('html gen failed')

booster/composer.json

@@ -17,7 +17,7 @@
     "deptrac/deptrac": "^4.5.0"
   },
   "scripts": {
-    "generate-api-spec": "php documentation/api.php",
+    "generate-api-spec": "php openapi/api.php",
     "check-cs": "vendor/bin/ecs check --ansi",
     "fix-cs": "vendor/bin/ecs check --fix --ansi",
     "ecs": "vendor/bin/ecs check --ansi",

booster/integrate_booster.sh

@@ -790,17 +790,17 @@ function update_gitignore() {
 # --- Function to Update Tool Paths Dynamically ---
 function update_tool_paths() {
     # --- Copy Documentation Directory ---
-    local booster_doc_path="${BOOSTER_INTERNAL_PATH}/documentation"
+    local booster_doc_path="${BOOSTER_INTERNAL_PATH}/openapi"
     if [ -d "$booster_doc_path" ]; then
-        if [ ! -d "documentation" ]; then
-            log "  Copying '$booster_doc_path' to 'documentation'..."
-            cp -R "$booster_doc_path" "documentation" || warn "Failed to copy documentation directory."
+        if [ ! -d "openapi" ]; then
+            log "  Copying '$booster_doc_path' to 'openapi'..."
+            cp -R "$booster_doc_path" "openapi" || warn "Failed to copy openapi directory."
         else
-            log "  'documentation' directory exists. Copying missing files..."
+            log "  'openapi' directory exists. Copying missing files..."
             for doc_file in "$booster_doc_path"/*; do
                 local filename=$(basename "$doc_file")
-                if [ ! -e "documentation/$filename" ]; then
-                    cp -R "$doc_file" "documentation/"
+                if [ ! -e "openapi/$filename" ]; then
+                    cp -R "$doc_file" "openapi/"
                     log "    Copied '$filename'."
                 else
                     log "    '$filename' already exists. Skipping to preserve customizations."

booster/documentation/api.php booster/openapi/api.phpbooster/documentation/api.php renamed to booster/openapi/api.php

@@ -21,7 +21,7 @@
     exit('Failed to generate OpenAPI documentation.');
 }
 
-$filename = 'documentation/openapi.yml';
+$filename = 'openapi/openapi.yml';
 $content = $openapi->toYaml();
 
 if (file_put_contents($filename, $content) === false) {

booster/documentation/openapi.yml booster/openapi/openapi.ymlbooster/documentation/openapi.yml renamed to booster/openapi/openapi.yml

@@ -7,7 +7,7 @@
     "commit": "commit",
     "test": "vitest run .husky/tests",
     "test:coverage": "vitest run .husky/tests --coverage",
-    "generate:api-doc:html": "redocly build-docs documentation/openapi.yml --output=documentation/openapi.html",
+    "generate:api-doc:html": "redocly build-docs openapi/openapi.yml --output=openapi/openapi.html",
     "prepare": "husky || true"
   },
   "devDependencies": {

booster/package.json

@@ -308,17 +308,17 @@ function update_gitignore() {
 # --- Function to Update Tool Paths Dynamically ---
 function update_tool_paths() {
     # --- Copy Documentation Directory ---
-    local booster_doc_path="${BOOSTER_INTERNAL_PATH}/documentation"
+    local booster_doc_path="${BOOSTER_INTERNAL_PATH}/openapi"
     if [ -d "$booster_doc_path" ]; then
-        if [ ! -d "documentation" ]; then
-            log "  Copying '$booster_doc_path' to 'documentation'..."
-            cp -R "$booster_doc_path" "documentation" || warn "Failed to copy documentation directory."
+        if [ ! -d "openapi" ]; then
+            log "  Copying '$booster_doc_path' to 'openapi'..."
+            cp -R "$booster_doc_path" "openapi" || warn "Failed to copy openapi directory."
         else
-            log "  'documentation' directory exists. Copying missing files..."
+            log "  'openapi' directory exists. Copying missing files..."
             for doc_file in "$booster_doc_path"/*; do
                 local filename=$(basename "$doc_file")
-                if [ ! -e "documentation/$filename" ]; then
-                    cp -R "$doc_file" "documentation/"
+                if [ ! -e "openapi/$filename" ]; then
+                    cp -R "$doc_file" "openapi/"
                     log "    Copied '$filename'."
                 else
                     log "    '$filename' already exists. Skipping to preserve customizations."