Skip to content

[O2B-1623] Document the flps endpoints in the HTTP API documentation - #2283

Open
graduta wants to merge 7 commits into
feature/O2B-1623/docs-dpl-process-endpointsfrom
feature/O2B-1623/docs-flps-endpoints
Open

graduta wants to merge 7 commits into
feature/O2B-1623/docs-dpl-process-endpointsfrom
feature/O2B-1623/docs-flps-endpoints

Conversation

@graduta

@graduta graduta commented Oct 22, 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.

Notable changes for users:

  • The flps endpoints are now documented at /api-docs: list, get one, create, and update the counters of an FLP in a run (create and update are marked as not for LLMs).
  • Errors of the FLP endpoints now use the standard error format: an unknown FLP (or run) answers 404 (title: Not found, with a detail) instead of 400, and creating an FLP with an existing id answers 409.
  • Updating the counters of an FLP only changes the counters given in the body.
  • The list can be sorted by id, name, hostname and runNumber (the previously accepted text sort key was not a valid column).

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).
  • Removed the dead, never required flp.controller.js; added the missing license header to updateFlpRole.js; handlers have JSDoc and error handling; flpId, flpName and runNumber are required in the DTOs; UpdateFlpDto no longer validates unused query fields.
  • FlpRole entity and adapter do not expose createdAt/updatedAt: nothing to remove.
  • The FLP use cases are migrated to FlpRoleService (getAll, getOneOrFail, create, update) on small functions (getAllFlpRoles, getFlpRoleOrFail with query builder configuration); lib/usecases/flp and its tests are removed.

Changes made to the database:

  • None

🤖 Generated with Claude Code

@graduta
graduta requested a review from isaachilly as a code owner October 22, 2026 14:01
@graduta graduta added documentation Improvements or additions to documentation backend labels Oct 22, 2026
@graduta
graduta added this pull request to stack #2276 October 22, 2026 14:02
@codecov

codecov Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 95.12195% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 43.21%. Comparing base (defc87e) to head (3f093b0).

Files with missing lines Patch % Lines
lib/server/controllers/flps.controller.js 88.23% 2 Missing ⚠️
Additional details and impacted files
@@                               Coverage Diff                               @@
##           feature/O2B-1623/docs-dpl-process-endpoints    #2283      +/-   ##
===============================================================================
+ Coverage                                        43.11%   43.21%   +0.09%     
===============================================================================
  Files                                             1071     1066       -5     
  Lines                                            17496    17451      -45     
  Branches                                          3176     3167       -9     
===============================================================================
- Hits                                              7543     7541       -2     
+ Misses                                            9953     9910      -43     

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

…ndle errors, tighten the DTOs

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…e migration

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@graduta
graduta force-pushed the feature/O2B-1623/docs-flps-endpoints branch from 15ed776 to f0fa4c2 Compare October 22, 2026 14:35
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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