santhoshj/headroom
1
0
Fork 0
Code Issues 18 Pull Requests Actions Packages Projects Releases Wiki Activity

Ralph iteration 1: work in progress

Browse Source
This commit is contained in:
Santhosh Janardhanan
2026-02-18 14:18:53 -05:00
parent f6a7e82036
commit a3b7eb116d
12 changed files with 1197 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
openspec/changes/p00-api-documentation/tasks.md
View File

@@ -2,19 +2,19 @@
## Phase 1: Configure Scribe
- [ ] 0.1 Install Scribe (if not already installed): `composer require knuckleswtf/scribe`
- [ ] 0.2 Publish Scribe config: `php artisan vendor:publish --tag=scribe-config`
- [ ] 0.3 Configure `config/scribe.php` with Headroom settings
- [ ] 0.4 Add `/api/documentation` to CORS allowed paths
- [x] 0.1 Install Scribe (if not already installed): `composer require knuckleswtf/scribe`
- [x] 0.2 Publish Scribe config: `php artisan vendor:publish --tag=scribe-config`
- [x] 0.3 Configure `config/scribe.php` with Headroom settings
- [x] 0.4 Add `/api/documentation` to CORS allowed paths
## Phase 2: Annotate Controllers
### AuthController
- [ ] 0.5 Add `@group Authentication` to class
- [ ] 0.6 Document `POST /api/auth/login` with @bodyParam, @response
- [ ] 0.7 Document `POST /api/auth/refresh` with @authenticated, @response
- [ ] 0.8 Document `POST /api/auth/logout` with @authenticated, @response
- [ ] 0.9 Add authentication section to Scribe config
- [x] 0.5 Add `@group Authentication` to class
- [x] 0.6 Document `POST /api/auth/login` with @bodyParam, @response
- [x] 0.7 Document `POST /api/auth/refresh` with @authenticated, @response
- [x] 0.8 Document `POST /api/auth/logout` with @authenticated, @response
- [x] 0.9 Add authentication section to Scribe config
### TeamMemberController
- [ ] 0.10 Add `@group Team Members` to class