Repository navigation
[O2B-1623] Document the shift-data endpoint in the HTTP API documentation - #2269
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2269 +/- ##
=======================================
Coverage 46.40% 46.40%
=======================================
Files 1051 1051
Lines 17363 17363
Branches 3161 3161
=======================================
Hits 8057 8057
Misses 9306 9306 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Base automatically changed from
feature/O2B-1623/docs-ctp-trigger-counters-endpoint
to
main
October 22, 2026 11:57
The handler documentation was replaced by a disabled JSDoc rule: it now describes its parameters and its result.
graduta
force-pushed
the
feature/O2B-1623/docs-shift-data-endpoint
branch
from
October 22, 2026 12:00
2157956 to
47cba75
Compare
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). The earlier PRs of the stack are merged: this one is rebased on
mainand 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:
shift-dataendpoints are now documented at/api-docs, with parameters, responses andcurlexamples:GET /api/shift-data: data of the calling user's pending shift (issues, runs or environments depending on the shift type, and the information left by the previous shifter)Notable changes for developers:
ShiftServiceand its small functions, tests): all files have their license header, no use case is involved,ShiftServiceis already built on small functions (no direct repository use), every function of the chain is used and the router references an existing handler. The only fix is the controller handler, which disabled a JSDoc rule instead of being documented.createdAt/updatedAtare not removed: the shift itself has none, and the nested logs, runs and environments come from the shared adapters of those resources (the ECS report form readsenvironment.createdAt).lib/server/api-docs/openapi.yamlis updated by hand,API.mdandindex.htmlare regenerated withnpm run docs:api(separate commit).Changes made to the database:
🤖 Generated with Claude Code