23 lines
902 B
Markdown
23 lines
902 B
Markdown
# Capability: API Documentation
|
|
|
|
## Purpose
|
|
Provide generated, accessible API documentation for currently implemented authentication endpoints.
|
|
|
|
## Requirements
|
|
|
|
### Requirement: Generate Authentication API Documentation
|
|
The system SHALL generate API documentation for authentication endpoints using Laravel Scribe.
|
|
|
|
#### Scenario: Generate docs successfully
|
|
- **WHEN** `php artisan scribe:generate` is run
|
|
- **THEN** the command completes without errors
|
|
- **AND** generated documentation includes `POST /api/auth/login`, `POST /api/auth/refresh`, and `POST /api/auth/logout`
|
|
|
|
### Requirement: Serve Documentation UI
|
|
The system SHALL serve documentation at `/api/documentation`.
|
|
|
|
#### Scenario: Access generated docs
|
|
- **WHEN** a client requests `GET /api/documentation`
|
|
- **THEN** the application responds with HTTP 200
|
|
- **AND** the page contains the configured API title and authentication guidance
|