Repository navigation
[O2B-1623] Document the simulation passes endpoints in the HTTP API documentation - #2270
Open
graduta wants to merge 2 commits into
Conversation
graduta
added this pull request to stack #2265
October 20, 2026 13:02
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I have a JIRA ticket
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-docspage.Notable changes for users:
simulation passesendpoints are now documented at/api-docs, with parameters, responses andcurlexamples:GET /api/simulationPasses: paginated list with filters (ids, names, LHC periods, data passes) and sortingGET /api/simulationPasses/{id}: one simulation passNotable changes for developers:
lib/server/api-docs/openapi.yamlis updated by hand,API.mdandindex.htmlare regenerated withnpm run docs:api(separate commit).filter[x][]parameters, which is what the Joi validation requires (a single value without[]is rejected). Adds the sharedSortOrderschema.Changes made to the database:
🤖 Generated with Claude Code