Skip to content

[O2B-1623] Document the shift-data endpoint in the HTTP API documentation - #2269

Open
graduta wants to merge 2 commits into
feature/O2B-1623/docs-ctp-trigger-counters-endpointfrom
feature/O2B-1623/docs-shift-data-endpoint
Open

graduta wants to merge 2 commits into
feature/O2B-1623/docs-ctp-trigger-counters-endpointfrom
feature/O2B-1623/docs-shift-data-endpoint

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 shift-data endpoints are now documented at /api-docs, with parameters, responses and curl examples:
    • 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:

  • lib/server/api-docs/openapi.yaml is updated by hand, API.md and index.html are regenerated with npm run docs:api (separate commit).
  • Log, run and environment entities returned inside the shift data are left as free-form objects until the logs, runs and environments resources are documented.

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:01
@graduta
graduta added this pull request to stack #2265 October 20, 2026 13:01
@graduta graduta changed the title feature/O2B 1623/docs shift data endpoint [O2B-1623] Document the shift-data endpoint 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.44%. Comparing base (c769469) to head (2157956).

Additional details and impacted files
@@                                 Coverage Diff                                  @@
##           feature/O2B-1623/docs-ctp-trigger-counters-endpoint    #2269   +/-   ##
====================================================================================
  Coverage                                                46.44%   46.44%           
====================================================================================
  Files                                                     1053     1053           
  Lines                                                    17359    17359           
  Branches                                                  3162     3162           
====================================================================================
  Hits                                                      8063     8063           
  Misses                                                    9296     9296           

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

@graduta
graduta removed this pull request from stack #2265 October 22, 2026 09:29
@graduta
graduta added this pull request to stack #2276 October 22, 2026 09:30

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