Skip to content

[O2B-1623] Document the configuration endpoint in the HTTP API documentation - #2263

Merged
graduta merged 2 commits into
mainfrom
feature/O2B-1623/docs-configuration-endpoint
Oct 22, 2026
Merged

graduta merged 2 commits into
mainfrom
feature/O2B-1623/docs-configuration-endpoint

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). The earlier PRs of the stack (#2261, #2262) are merged: this one is rebased on main and regenerated with the current generator. The following PRs of the stack are rebased one by one, once the previous one is merged.

Notable changes for users:

  • The configuration endpoints are now documented at /api-docs, with parameters, responses and curl examples:
    • GET /api/configuration: URLs of the external services Bookkeeping links to (a URL is null when not configured)

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).

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 configuration endpoint [O2B-1623] Document the configuration endpoint 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.39%. Comparing base (c17a7bb) to head (645708b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2263   +/-   ##
=======================================
  Coverage   46.39%   46.39%           
=======================================
  Files        1053     1053           
  Lines       17384    17384           
  Branches     3168     3168           
=======================================
  Hits         8065     8065           
  Misses       9319     9319           

☔ 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/docs-status-endpoints to main October 21, 2026 14:53
@graduta
graduta force-pushed the feature/O2B-1623/docs-configuration-endpoint branch from c6b1c5c to 391a7e2 Compare October 22, 2026 07:41
@graduta
graduta force-pushed the feature/O2B-1623/docs-configuration-endpoint branch from 391a7e2 to 645708b Compare October 22, 2026 08:04
@graduta
graduta merged commit 82f1a88 into main Oct 22, 2026
26 checks passed
@graduta
graduta deleted the feature/O2B-1623/docs-configuration-endpoint branch October 22, 2026 08:43
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