Skip to content

fix(kubeflow-dashboard-links): correct interface schema requirer - #663

Open
james-garner-canonical wants to merge 2 commits into
canonical:mainfrom
james-garner-canonical:26-08+chore+interface-schemas-mlops
Open

fix(kubeflow-dashboard-links): correct interface schema requirer#663
james-garner-canonical wants to merge 2 commits into
canonical:mainfrom
james-garner-canonical:26-08+chore+interface-schemas-mlops

Conversation

@james-garner-canonical

Copy link
Copy Markdown
Collaborator

The schema declared the requirer's application databag as a bare list of dashboard items. A Juju databag is always a mapping, and the library (charms.kubeflow_dashboard.v0.kubeflow_dashboard_links) writes the list JSON-encoded under a dashboard_links key. The schema now says that, which also makes it usable with ops.Relation.load. The README hsa been updated to reflect this.

Alongside this, the schema moves to the new format: models are named directly as ProviderAppData, ProviderUnitData, RequirerAppData and RequirerUnitData rather than wrapped in pytest-interface-tester classes, with None for a databag that is always empty.

A follow up PR will document the new format and add tooling to enforce it, after similar PRs have landed for all the other CODEOWNERS in this repository.

…terface schema

The schema declared the requirer's application databag as a bare list of
dashboard items. A Juju databag is always a mapping, and the library
(`charms.kubeflow_dashboard.v0.kubeflow_dashboard_links`) writes the list
JSON-encoded under a `dashboard_links` key. The schema now says that, which also
makes it usable with `ops.Relation.load`.

The interface README still shows the bare list, and should be updated to match.

Alongside this, the schema moves to the new format: models are named directly as
`ProviderAppData`, `ProviderUnitData`, `RequirerAppData` and `RequirerUnitData`
rather than wrapped in `pytest-interface-tester` classes, with `None` for a
databag that is always empty.

A follow-up PR documents the format and adds a CI check for it, once every
interface has been migrated.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@james-garner-canonical
james-garner-canonical marked this pull request as ready for review September 3, 2026 06:01
@james-garner-canonical
james-garner-canonical requested a review from a team as a code owner September 3, 2026 06:01

@NohaIhab NohaIhab left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@james-garner-canonical
james-garner-canonical force-pushed the 26-08+chore+interface-schemas-mlops branch from fafc6fa to a900aa7 Compare September 11, 2026 03:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants