Replace generic 'type: object' for /api/view_metadata endpoint with
comprehensive ModelMetadata schema that includes:
- Standard modelspec fields (date, architecture, title, description)
- Implementation details (format, license, author)
- Additional metadata with proper typing
- Base64 thumbnail support
This provides much better API documentation for model metadata
responses than the previous generic object definition.
Add 500 error responses to endpoints that previously only had 200:
- /api/prompt GET
- /api/queue GET
- /api/interrupt POST
- /api/free POST
- /api/features GET
- /api/history GET/POST
- /api/object_info endpoints
- /api/embeddings, /api/extensions, /api/system_stats
- /internal/logs and /internal/folder_paths endpoints
This provides complete error coverage for system failures and
improves API reliability documentation.
Replace generic additionalProperties: true for queue items with
detailed QueueItem schema that properly describes the array structure:
- Position number (integer)
- Prompt ID (UUID string)
- Workflow graph (object)
- Extra metadata (object)
- Output node IDs (array)
This provides much better API documentation and validation for
queue responses than the previous generic object definition.
- Add /api/features endpoint with ServerFeatures response schema
- Replace inline objects in /internal/logs/raw with RawLogsResponse schema
- Add LogEntry and TerminalSize component schemas for better reusability
- Replace inline LogsSubscribeRequest object with proper schema component
- Add required field constraints to LogsSubscribeRequest
This addresses the missing features endpoint and improves schema
consistency by moving complex inline objects to reusable components.
Enhance multipart/form-data schemas for image upload endpoints:
- Add required field constraints for image uploads
- Specify enum values for overwrite parameter ("true"/"false")
- Add default values for type ("input") and subfolder ("")
- Mark image and original_ref as required fields for mask uploads
- Improve field descriptions and validation
These changes make the API specification more precise and match
the actual server implementation requirements.
Replace inline object definitions for queue, history, and resource management
operations with reusable schema components:
- Add QueueManageRequest schema for /api/queue POST requests
- Add FreeResourcesRequest schema for /api/free POST requests
- Add HistoryManageRequest schema for /api/history POST requests
- Add UploadResponse schema for upload endpoints
This improves API consistency and reusability by moving common
object definitions to the components section.
- Updated all API paths (except internal routes) to include /api/ prefix
- Changed server URL from "/api" back to "/" and added prefix to individual paths
- Updated test fixtures to not add /api prefix since paths already include it
- Fixed all test assertions to use the new paths with /api/ prefix
This addresses the review comment about endpoints needing the /api/ prefix
and implements it correctly by hardcoding the prefix in each path definition.
Fixes#8219
- Changed server URL from / to /api to reflect the canonical API path
- Made device index field nullable to match actual server response
This addresses the review comment about endpoints needing the /api/ prefix.
