feat(external-api): support Timeline tiles in dashboard GET/PUT round-trip

Open
#2,226 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript

Research direction

Start in packages/api/src/routers/external-api/v2/utils/dashboards.ts and trace convertToExternalTileChartConfig through both raw-SQL and builder paths. Then inspect the external schemas in packages/api/src/utils/zod.ts, packages/mcp/tools/dashboards/schemas.ts, and packages/mcp/prompts/dashboards/content.ts, along with the external-api tests. Done means Timeline tiles preserve their configuration through GET/PUT round trips without the conversion error.

Written by the indexing model from the issue text.

Description

Currently Timeline tiles are not supported in the external dashboards API (packages/api/src/routers/external-api/v2/utils/dashboards.ts). When a Timeline tile is read via GET, the converter logs an error and falls back to a Line tile config, losing the user's intent.

Follow-up from #2190 (Timeline schema PR). To fix when the Timeline renderer lands:

  • Add a DisplayType.Timeline branch to convertToExternalTileChartConfig (both the raw-SQL and builder paths)
  • Add a corresponding timeline case to the external schema in packages/api/src/utils/zod.ts and packages/mcp/tools/dashboards/schemas.ts / packages/mcp/prompts/dashboards/content.ts
  • Add round-trip tests for Timeline tiles in the external-api test suite

Linked PRs: #2190 (schema), #2192 (renderer)

Dominant language
TypeScript
Stars
9.9k
Forks
471
Avg merge
2d 4h
Merged PRs (30d)
117

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from hyperdxio/hyperdx

All issues in hyperdxio/hyperdx

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.