[graduta]

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 are merged: this one is rebased on main and regenerated with the current generator. It is the last PR of the stack.

Notable changes for users:

• GET /api/lhcPeriodsStatistics/{lhcPeriodId} now rejects (400) an id that is not a positive integer (0, negative numbers, decimals), instead of answering with a 404.
• The LHC periods statistics endpoints are now documented at /api-docs, with parameters, responses and curl examples:
  • GET /api/lhcPeriodsStatistics: paginated list with filters (ids, names, years, PDP beam types) and sorting
  • GET /api/lhcPeriodsStatistics/{lhcPeriodId}: statistics of one LHC period

Notable changes for developers:

• Checked the chain of the endpoint: all files have their license header, no use case is involved, the entity has no createdAt / updatedAt, and the router references existing handlers.
• LhcPeriodStatisticsService queried the repository directly (with an inline sub-query for the PDP beam types) and has no small functions: it now uses getLhcPeriodStatistics, getLhcPeriodStatisticsOrFail, getAllLhcPeriodStatistics(qbConfiguration) and getLhcPeriodStatisticsIdsByPdpBeamTypes (each id returned once), and prepareQueryBuilder can reuse an existing query builder. The behaviour is unchanged (same not found message, same BadParameterError) and the four functions have tests. A & used instead of && in the check of the id is fixed.
• Removed lib/server/services/period/getOrCreateLhcPeriod.js: an unused copy of lib/server/services/lhcPeriod/getOrCreateLhcPeriod.js (nothing required it).
• The controller disabled the JSDoc rules for the whole file, its handlers are documented; the documentation of the service, of getOrCreateLhcPeriod and of getLhcPeriod, copied from the run types and the logs, describes LHC periods.
• The id of the endpoint is validated with EntityIdDto (it was a plain Joi.number()), with an API test of the four kinds of invalid values.
• lib/server/api-docs/openapi.yaml is updated by hand, API.md and index.html are regenerated with npm run docs:api (separate commit).
• Statistics are computed on the physics runs of each period.

Changes made to the database:

• None

🤖 Generated with Claude Code

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.54%. Comparing base (2249a99) to head (ec34926).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2271      +/-   ##
==========================================
+ Coverage   46.45%   46.54%   +0.08%     
==========================================
  Files        1054     1057       +3     
  Lines       17379    17404      +25     
  Branches     3165     3174       +9     
==========================================
+ Hits         8073     8100      +27     
+ Misses       9306     9304       -2     

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