Dashboard: Add collapsible sections support to Open API (v2)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- api
Research direction
Start with the external API Zod schemas in packages/api/src/utils/zod.ts, then locate ExternalDashboard, ExternalDashboardTileWithId, convertToExternalDashboard, and the dashboard create/update flows. Verify how sections and tile sectionId are represented by the internal API and frontend. Done means GET, POST, and PATCH expose and preserve these fields, with applicable OpenAPI or Swagger documentation updated.
Written by the indexing model from the issue text.
Description
Summary
The internal API and frontend now support collapsible dashboard sections (#1896, #1897). The external/Open API (v2) should be updated to expose this capability so users can programmatically create and manage dashboards with sections.
Scope
Read path (GET)
- Add
sectionsfield toExternalDashboardtype - Add
sectionIdfield toExternalDashboardTileWithIdtype - Update
convertToExternalDashboardto include sections and tile sectionId
Write path (POST/PATCH)
- Add
sectionsto the external dashboard input validation schemas - Add
sectionIdto the external tile input schemas - Pass through sections in create/update flows
Schema / docs
- Update the external API Zod schemas in
packages/api/src/utils/zod.ts - Update any OpenAPI/Swagger documentation if applicable
Dependencies
- #1896 (core mechanics) — merged or in progress
- #1897 (authoring UX) — ideally landed first so the feature is fully usable end-to-end before exposing via API
- Dominant language
- TypeScript
- Stars
- 9.9k
- Forks
- 471
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 117
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.
More from hyperdxio/hyperdx
-
enhancement external good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Trace source: document spanLinksValueExpression in the v2 sources external API (OpenAPI parity) Open
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
count_distinct aggFn on metric tiles ignores valueExpression, always counts distinct metric Values Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
All issues in hyperdxio/hyperdx
Similar issues
-
comp/dashboard P3 type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
NousResearch/hermes-agent#117722 ·
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·