diff options
author | Robby Zambito <contact@robbyzambito.me> | 2025-08-08 13:29:10 -0400 |
---|---|---|
committer | Robby Zambito <contact@robbyzambito.me> | 2025-08-08 13:29:10 -0400 |
commit | cc7906c7648ca74878d694ccba889b24b0671ab3 (patch) | |
tree | 14ff145508393947ee5b2ec9709e8ee2452d19b1 /static | |
parent | d4c519c3b9935768a7481f83ee7cc717c25d3361 (diff) |
Add logs to api docs
Diffstat (limited to 'static')
-rw-r--r-- | static/api-docs.html | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/static/api-docs.html b/static/api-docs.html index 8a15386..3fd9ff9 100644 --- a/static/api-docs.html +++ b/static/api-docs.html @@ -66,6 +66,7 @@ <li><a href="#status-services" class="nav-item">Services Status</a></li> <li><a href="#status-metrics" class="nav-item">Metrics</a></li> <li><a href="#status-incidents" class="nav-item">Incidents</a></li> + <li><a href="#status-logs" class="nav-item">Logs</a></li> <li><a href="#status-maintenance" class="nav-item">Maintenance</a></li> <li><a href="#status-uptime" class="nav-item">Uptime History</a></li> <li><a href="#status-subscribe" class="nav-item">Subscribe</a></li> @@ -734,6 +735,29 @@ X-RateLimit-Reset: 1640995200</code></pre> </div> </section> + <section id="status-logs" class="doc-section"> + <div class="endpoint"> + <div class="endpoint-header"> + <span class="method get">GET</span> + <span class="path">/status/logs</span> + </div> + <p>Get service logs.</p> + + <h4>Response</h4> + <div class="code-example"> + <div class="code-header"> + <span>200 OK</span> + </div> + <div class="code-block"> + <pre><code>{"clientAddr":"127.0.0.XXX:33906","requestedPath":"/api-docs.html","requestTime":"2025-08-08T17:26:29.552168681Z","httpMethod":"GET"} +{"incidentEvent": {"id":"32","title":"Out-of-memory exception in worker thread","description":"Out-of-memory exception in worker thread","status":"degraded","severity":"minor","startTime":"2025-08-08T17:26:38.05963434Z","affectedServices":[]}} +</code></pre> + <button class="copy-btn" data-copy='[{"id":"incident_123","title":"Intermittent API Timeouts","description":"Some users may experience slow response times when accessing the API.","status":"investigating","severity":"minor","startTime":"2025-08-07T13:30:00Z","endTime":null,"affectedServices":["api","web"],"updates":[{"timestamp":"2025-08-07T13:30:00Z","status":"investigating","message":"We are investigating reports of slow API response times."}]}]'>Copy</button> + </div> + </div> + </div> + </section> + <section id="status-maintenance" class="doc-section"> <div class="endpoint"> <div class="endpoint-header"> |