feat: generate and propagate X-Correlation-Id through /api/comments h… - #718
Merged
greatest0fallt1me merged 3 commits intoJul 29, 2026
Conversation
…andlers
- Register GET /api/comments and POST /api/comments in OpenAPI registry
with X-Correlation-Id request/response header documentation
- Update GET /api/markets/{id}/comments registration to document the
X-Correlation-Id header and add 'Comments' tag
- Add docs/comments-api.md full runbook: endpoint reference, correlation
ID lifecycle (sanitise → resolve → store → echo → propagate),
structured log fields, error envelope, rate limiting/CORS notes
- Update README.md with Comments API section linking to the new doc
The correlation middleware, route handlers, and tests were already
present on main (src/middleware/correlation.ts, src/routes/comments.ts,
tests/comments-correlation.test.ts, tests/middleware/correlation.test.ts,
tests/market-comments.test.ts — 35 tests passing).
|
@victorocheje Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
CI passed, solid PR — merged. |
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
2 participants
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.
…andlers
The correlation middleware, route handlers, and tests were already present on main (src/middleware/correlation.ts, src/routes/comments.ts, tests/comments-correlation.test.ts, tests/middleware/correlation.test.ts, tests/market-comments.test.ts — 35 tests passing).
closes #581