Skip to content

[O2B-1623] Document the run types endpoints in the HTTP API documentation - #2267

Open
graduta wants to merge 2 commits into
mainfrom
feature/O2B-1623/docs-run-types-endpoints
Open

graduta wants to merge 2 commits into
mainfrom
feature/O2B-1623/docs-run-types-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). The earlier PRs of the stack are merged: this one is rebased on main and 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:

  • The run types endpoints are now documented at /api-docs, with parameters, responses and curl examples:
    • GET /api/runTypes: paginated list of run types (ordered by name, descending)
    • GET /api/runTypes/{runTypeId}: one run type

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).
  • Adds the reusable PageLimit / PageOffset parameters and PageMeta schema used by the paginated endpoints documented in the following PRs.

Changes made to the database:

  • None

🤖 Generated with Claude Code

@graduta
graduta requested a review from isaachilly as a code owner October 20, 2026 12:58
@graduta
graduta added this pull request to stack #2265 October 20, 2026 12:58
@graduta graduta changed the title feature/O2B 1623/docs run types endpoints [O2B-1623] Document the run types 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 (e7d3214) to head (29d7093).

Additional details and impacted files
@@                               Coverage Diff                                @@
##           feature/O2B-1623/docs-dpl-detectors-endpoint    #2267      +/-   ##
================================================================================
- Coverage                                         46.46%   46.41%   -0.06%     
================================================================================
  Files                                              1053     1053              
  Lines                                             17359    17359              
  Branches                                           3162     3162              
================================================================================
- Hits                                               8066     8057       -9     
- Misses                                             9293     9302       +9     

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

…tion

Also add the reusable PageLimit and PageOffset parameters and the PageMeta schema, to be used by the paginated endpoints documented next.
@graduta
graduta force-pushed the feature/O2B-1623/docs-run-types-endpoints branch from 29d7093 to cfcc343 Compare October 22, 2026 09:28
@graduta
graduta removed this pull request from stack #2265 October 22, 2026 09:29
@graduta
graduta changed the base branch from feature/O2B-1623/docs-dpl-detectors-endpoint to main 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