API to fetch panels for a dashboard#2218
Merged
Merged
Conversation
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…-common into obs-fix
Contributor
✅ API Diff Results -
|
…-common into feature/grafana-get-panels
…kit/chainlink-common into feature/grafana-get-panels
ilija42
approved these changes
Jul 3, 2026
Krish-vemula
approved these changes
Jul 10, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Grafana API client method for retrieving all panels for a dashboard (including nested row panels) by dashboard UID, returning a flattened list of panel metadata.
Changes:
- Introduce
GetDashboardPanelsByUIDplus supporting response/types and a recursive panel-flattening helper. - Add unit tests covering the happy-path (nested panels) and 404-not-found behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| observability-lib/api/dashboard.go | Adds panel types + GetDashboardPanelsByUID that fetches dashboard JSON and flattens nested panels. |
| observability-lib/api/dashboard_test.go | Adds tests for panel fetching/flattening and not-found handling using an httptest server. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+16
to
+39
| expectedResponse := getDashboardByUIDResponse{ | ||
| Dashboard: struct { | ||
| ID uint `json:"id"` | ||
| UID string `json:"uid"` | ||
| Title string `json:"title"` | ||
| Panels []dashboardPanelJSON `json:"panels"` | ||
| }{ | ||
| ID: 10, | ||
| UID: dashboardUID, | ||
| Title: "Test Dashboard", | ||
| Panels: []dashboardPanelJSON{ | ||
| {ID: 1, Title: "Uptime", Type: "stat"}, | ||
| { | ||
| ID: 2, | ||
| Title: "Resource Usage", | ||
| Type: "row", | ||
| Panels: []dashboardPanelJSON{ | ||
| {ID: 3, Title: "CPU Usage", Type: "timeseries"}, | ||
| {ID: 4, Title: "Memory Usage", Type: "stat"}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } |
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
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.
Depends on #2217