Skip to content

[O2B-1623] Document the status endpoints in the HTTP API documentation - #2262

Merged
graduta merged 2 commits into
mainfrom
feature/O2B-1623/docs-status-endpoints
Oct 21, 2026
Merged

graduta merged 2 commits into
mainfrom
feature/O2B-1623/docs-status-endpoints

Conversation

@graduta

@graduta graduta commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

I have a JIRA ticket

  • branch and/or PR name(s) include(s) JIRA ID
  • issue has "Fix version" assigned
  • issue "Status" is set to "In review"
  • PR labels are selected

Part of a stack of PRs documenting the HTTP API (O2B-1623), each PR builds on the previous one: see the stack on GitHub. The first PR of the stack is #2261, which adds the generator and the /api-docs page.

Notable changes for users:

  • The status endpoints are now documented at /api-docs, with parameters, responses and curl examples:
    • GET /api/status/database: database connection status
    • GET /api/status/gui: host, port and version of the running application

Notable changes for developers:

  • lib/server/api-docs/openapi.yaml is updated by hand, API.md and index.html are regenerated with npm run docs:api (separate commit).
  • The work-in-progress note of the spec is reworded, as more than one resource is now documented.

Changes made to the database:

  • None

🤖 Generated with Claude Code

@graduta
graduta requested a review from isaachilly as a code owner October 20, 2026 12:55
@graduta
graduta added this pull request to stack #2265 October 20, 2026 12:55
@graduta graduta changed the title feature/O2B 1623/docs status endpoints [O2B-1623] Document the status endpoints in the HTTP API documentation Oct 20, 2026
@graduta graduta added documentation Improvements or additions to documentation backend labels Oct 20, 2026
@codecov

codecov Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.46%. Comparing base (3cc120b) to head (370666f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2262   +/-   ##
=======================================
  Coverage   46.46%   46.46%           
=======================================
  Files        1053     1053           
  Lines       17359    17359           
  Branches     3162     3162           
=======================================
  Hits         8065     8065           
  Misses       9294     9294           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Base automatically changed from feature/O2B-1623/http-api-documentation to main October 20, 2026 15:21
Add GET /status/database and GET /status/gui, and reword the work-in-progress note now that more than one resource is documented.
@graduta
graduta force-pushed the feature/O2B-1623/docs-status-endpoints branch 2 times, most recently from da42e56 to 370666f Compare October 21, 2026 14:07
@graduta
graduta merged commit 8eb1375 into main Oct 21, 2026
25 checks passed
@graduta
graduta deleted the feature/O2B-1623/docs-status-endpoints branch October 21, 2026 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

2 participants