Skip to content

feat(tasks): add operationId fields for Redoc deep-linking + API doc generators#3764

Merged
PierreBrisorgueil merged 1 commit into
masterfrom
feat/promote-tasks-operationid
Jun 1, 2026
Merged

feat(tasks): add operationId fields for Redoc deep-linking + API doc generators#3764
PierreBrisorgueil merged 1 commit into
masterfrom
feat/promote-tasks-operationid

Conversation

@PierreBrisorgueil
Copy link
Copy Markdown
Contributor

Summary

Promote-up from trawl_node: add operationId fields to all 6 operations in modules/tasks/doc/tasks.yml. Closes #3763.

  • GET /api/tasks/statsgetTaskStats
  • GET /api/taskslistTasks
  • POST /api/taskscreateTask
  • GET /api/tasks/{taskId}getTask
  • PUT /api/tasks/{taskId}updateTask
  • DELETE /api/tasks/{taskId}deleteTask

Purely additive — no JS behavior change, no route change, no schema change.

Why

operationId is required by Redoc for stable per-operation deep links and by API doc generators (SDK codegen, OpenAPI client tools) for stable method names. Every devkit downstream with a tasks module + Redoc docs benefits.

PRF Phase 0

/critical-review --via deepseekOK with nits (2 cosmetic nits, 0 blocking findings). Gate passed.

Test plan

  • NODE_ENV=test npm run test:unit -- modules/tasks/tests/tasks.openapi-operationid passes (asserts every operation has a unique operationId)
  • npm run lint clean
  • CI green

References

…eep-linking

Promotes operationId fields from trawl_node to devkit. Every operation
in modules/tasks/doc/tasks.yml now has a unique camelCase operationId
(getTaskStats, listTasks, createTask, getTask, updateTask, deleteTask),
enabling stable per-operation deep links in Redoc and compatibility with
API doc generators. Purely additive — no behavior change.

Adds tasks.openapi-operationid.unit.tests.js to assert every operation
has a defined, unique operationId.

Part of infra plan 2026-06-01-trawl-promote-up-followups.md Task 3.
Copilot AI review requested due to automatic review settings June 1, 2026 19:20
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.14%. Comparing base (7ed5291) to head (92d7bd5).

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #3764       +/-   ##
===========================================
+ Coverage   59.43%   90.14%   +30.70%     
===========================================
  Files         151      151               
  Lines        4970     4970               
  Branches     1577     1577               
===========================================
+ Hits         2954     4480     +1526     
+ Misses       1491      385     -1106     
+ Partials      525      105      -420     
Flag Coverage Δ
integration 59.43% <ø> (ø)
unit 68.91% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ed5291...92d7bd5. Read the comment docs.

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

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds OpenAPI operationId fields to the Tasks module’s documented endpoints to support stable Redoc deep links and consistent method naming for OpenAPI tooling/code generators. It also introduces a unit test to ensure operationId presence and uniqueness within modules/tasks/doc/tasks.yml.

Changes:

  • Add operationId to all 6 /api/tasks* operations in modules/tasks/doc/tasks.yml.
  • Add a unit test that parses tasks.yml and asserts every HTTP operation has a string operationId and that all are unique.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
modules/tasks/doc/tasks.yml Adds operationId to each tasks operation for stable deep-linking/codegen identifiers.
modules/tasks/tests/tasks.openapi-operationid.unit.tests.js Adds a unit test to enforce presence + uniqueness of operationId values in tasks.yml.

@PierreBrisorgueil PierreBrisorgueil merged commit 11ab4b7 into master Jun 1, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(tasks): add OpenAPI operationId fields for stable deep-linking

2 participants