6 Commits

Author	SHA1	Message	Date
mannilakash	3654c58469	fix: removing GET /monitors from swagger docs	2026-03-02 12:48:04 -05:00
gorkem-bwl	ab25531758	docs: fix OpenAPI spec accuracy and warnings ... ## Changes ### Route Corrections - Remove non-existent `/auth/refresh` endpoint - Add missing `/auth/users/{userId}/password` PUT endpoint - Fix `/notifications` GET -> `/notifications/team` GET (correct path) ### OpenAPI 3.1.0 Compliance - Fix `nullable` warnings by using `type: ["string", "null"]` syntax - Updated Incident schema nullable fields (endTime, message, statusCode, etc.) - Updated QueueJob schema nullable fields (processedOn, finishedOn) - Updated Check schema nullable field (ackAt) ### Verified Against Codebase - Audited all 76 API endpoints across 12 route files - Confirmed DELETE /checks/team and DELETE /checks/{monitorId} exist - All routes now match actual codebase implementation ## Validation - Passes `swagger-cli validate` - Only remaining warnings are cosmetic `example` deprecations	2026-01-19 14:13:18 -05:00
gorkem-bwl	3b0326457f	docs: update OpenAPI specification to match current API ... ## Changes ### New Endpoints Added - `/incidents/team` - Get incidents by team with filtering - `/incidents/team/summary` - Get incident summary statistics - `/incidents/{incidentId}` - Get incident by ID - `/incidents/{incidentId}/resolve` - Manually resolve incident - `/queue/jobs` (GET) - List queue jobs (admin only) - `/queue/jobs` (POST) - Add job to queue (admin only) - `/queue/metrics` - Get queue metrics (admin only) - `/monitors/team/groups` - Get monitor groups by team - `/monitors/pagespeed/details/{monitorId}` - Get PageSpeed details - `/checks/{action}` - Acknowledge all checks for all monitors - `/checks/{action}/{monitorId}` - Acknowledge checks for specific monitor ### Endpoints Fixed - `/monitors/export` changed to `/monitors/export/json` (matches actual route) - Removed non-existent `/monitors/stats/{monitorId}` endpoint - Removed non-existent `/monitors/team/summary` endpoint - Split optional path parameter into two valid endpoints for checks ### New Schemas Added - `Incident` - Complete incident model - `IncidentSummary` - Incident statistics summary - `QueueJob` - Queue job information - `QueueMetrics` - Queue metrics data - `Check` - Complete check result model - `CheckTimings` - HTTP timing information - `CheckCpuInfo` - CPU metrics for infrastructure checks - `CheckMemoryInfo` - Memory metrics for infrastructure checks - `CheckDiskInfo` - Disk metrics for infrastructure checks - `CheckHostInfo` - Host information for infrastructure checks - `CheckErrorInfo` - Error information from checks - `CheckCaptureInfo` - Capture agent information - `CheckNetworkInfo` - Network interface metrics - `CheckAudits` - PageSpeed audit results - `LighthouseAudit` - Individual Lighthouse audit result ### Responses Added - `BadRequest` - 400 error response ### Other Fixes - Simplified server variables to fix OpenAPI 3.1.0 validation - Added request body to `/checks/check/{checkId}` endpoint - Added "incidents" tag to tags array ## Benefits - OpenAPI specification now accurately reflects the actual API - All endpoints have proper request/response schemas - Validation passes with swagger-cli - Better API documentation for consumers	2026-01-19 13:49:08 -05:00
Alex Holliday	c5dd16511d	update openapi specs	2025-08-11 13:55:01 -07:00
Alex Holliday	bfa6832beb	format	2025-07-21 10:34:16 -07:00
Alex Holliday	8b7e3c650b	restore repo structure	2025-04-20 11:29:53 -07:00