databrickslabs / databrickslabs/lsql
[TECH DEBT] Update `Dashboard.create_dashboard` signature to match the `LakeviewAPI.create/update` signatures
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 39
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
The Python SDK v0.37.0 updated the LakeviewAPI.create/update signature to expect a Dashboard object. We can update our lsql Dashboard.create_dashboard with similar changes:
becomes:
def create_dashboard(
self,
dashboard_metadata: DashboardMetadata,
*,
dashboard: SDKDashboard=None,
publish: bool = False,
) -> SDKDashboard:
Use deprecation warnings to incrementally introduce this signature change
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
Start with src/databricks/labs/lsql/dashboards.py at Dashboard.create_dashboard and compare its current parameters with the linked Databricks SDK LakeviewAPI.create/update signatures. Trace the existing dashboard creation flow, then verify that the compatibility path emits deprecation warnings and that the updated call returns an SDKDashboard.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100