Trace source: document spanLinksValueExpression in the v2 sources external API (OpenAPI parity)

Aperta Adatta ai principianti
#2,695 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
openapi, typescript
Ambito
api, documentation

Direzione di ricerca

Apri packages/api/src/routers/external-api/v2/sources.ts e confronta il blocco della source trace con la relativa proprietà spanEventsValueExpression. Aggiungi la documentazione corrispondente per spanLinksValueExpression, quindi esegui yarn workspace @hyperdx/api run docgen e conferma che lint:openapi venga superato. L’attività è completata quando la specifica OpenAPI generata include la nuova proprietà senza modifiche a runtime.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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 spanLinksValueExpression property to the trace source block in packages/api/src/routers/external-api/v2/sources.ts (mirror spanEventsValueExpression).
  • Regenerate openapi.json (yarn workspace @hyperdx/api run docgen) and confirm lint:openapi passes.

No runtime behavior change. Split out of #2463 to keep that PR app-only and focused.

Lingua principale
TypeScript
Stelle
10k
Fork
508
Merge medio
2g 6h
PR unite (30g)
156

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hyperdxio/hyperdx

Tutte le issue di hyperdxio/hyperdx

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.