Skip to content

[O2B-1623] Document the simulation passes endpoints in the HTTP API documentation - #2270

Open
graduta wants to merge 2 commits into
feature/O2B-1623/docs-shift-data-endpointfrom
feature/O2B-1623/docs-simulation-passes-endpoints
Open

graduta wants to merge 2 commits into
feature/O2B-1623/docs-shift-data-endpointfrom
feature/O2B-1623/docs-simulation-passes-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 simulation passes endpoints are now documented at /api-docs, with parameters, responses and curl examples:
    • GET /api/simulationPasses: paginated list with filters (ids, names, LHC periods, data passes) and sorting
    • GET /api/simulationPasses/{id}: one simulation pass

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).
  • List filters are documented as repeated filter[x][] parameters, which is what the Joi validation requires (a single value without [] is rejected). Adds the shared SortOrder schema.

Changes made to the database:

  • None

🤖 Generated with Claude Code

@graduta
graduta requested a review from isaachilly as a code owner October 20, 2026 13:02
@graduta
graduta added this pull request to stack #2265 October 20, 2026 13:02
@graduta graduta changed the title feature/O2B 1623/docs simulation passes endpoints [O2B-1623] Document the simulation passes 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.41%. Comparing base (2157956) to head (56653ef).

Additional details and impacted files
@@                              Coverage Diff                              @@
##           feature/O2B-1623/docs-shift-data-endpoint    #2270      +/-   ##
=============================================================================
+ Coverage                                      46.28%   46.41%   +0.12%     
=============================================================================
  Files                                           1053     1053              
  Lines                                          17359    17359              
  Branches                                        3162     3162              
=============================================================================
+ Hits                                            8035     8057      +22     
+ Misses                                          9324     9302      -22     

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

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