Trace source: document spanLinksValueExpression in the v2 sources external API (OpenAPI parity)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 9.9k
- Forks
- 471
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 117
Description
Summary
#2463 added a Span Links Expression field to the trace source form and schema (spanLinksValueExpression), mirroring Span Events Expression. The field already round-trips through the v2 sources API at runtime because it lives on the shared source schema, but the OpenAPI JSDoc annotation in packages/api/src/routers/external-api/v2/sources.ts is missing. Its sibling spanEventsValueExpression is documented there, so this is a parity gap in the API docs only.
Follow-up
- Add the
spanLinksValueExpressionproperty to the trace source block inpackages/api/src/routers/external-api/v2/sources.ts(mirrorspanEventsValueExpression). - Regenerate
openapi.json(yarn workspace @hyperdx/api run docgen) and confirmlint:openapipasses.
No runtime behavior change. Split out of #2463 to keep that PR app-only and focused.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open packages/api/src/routers/external-api/v2/sources.ts and compare the trace source block with its spanEventsValueExpression property. Add the matching spanLinksValueExpression documentation, then run yarn workspace @hyperdx/api run docgen and confirm lint:openapi passes. Done means the generated OpenAPI specification includes the new property with no runtime changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100