Skip to content

chore(filesystem_info): move the interface schema to the new format - #657

Open
james-garner-canonical wants to merge 1 commit into
canonical:mainfrom
james-garner-canonical:26-08+chore+interface-schemas-hpc
Open

chore(filesystem_info): move the interface schema to the new format#657
james-garner-canonical wants to merge 1 commit into
canonical:mainfrom
james-garner-canonical:26-08+chore+interface-schemas-hpc

Conversation

@james-garner-canonical

Copy link
Copy Markdown
Collaborator

Interface schemas no longer wrap their models in the ProviderSchema and RequirerSchema classes from pytest-interface-tester. Instead a schema names all four databags directly, as ProviderAppData, ProviderUnitData, RequirerAppData and RequirerUnitData, setting a databag that is always empty to None.

Naming all four makes an empty databag a deliberate choice a reviewer can see, and makes a misspelled name an error rather than a silently empty databag. The models are unchanged; only the wrapper classes around them are gone. Dropping the pytest-interface-tester import leaves Pydantic as the only dependency needed to read a schema.

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

Interface schemas no longer wrap their models in the `ProviderSchema` and
`RequirerSchema` classes from `pytest-interface-tester`. Instead a schema names
all four databags directly, as `ProviderAppData`, `ProviderUnitData`,
`RequirerAppData` and `RequirerUnitData`, setting a databag that is always empty
to `None`.

Naming all four makes an empty databag a deliberate choice a reviewer can see,
and makes a misspelled name an error rather than a silently empty databag. The
models are unchanged; only the wrapper classes around them are gone. Dropping
the `pytest-interface-tester` import leaves Pydantic as the only dependency
needed to read a schema.

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 changed the title chore(filesystem-info): move the interface schema to the new format chore(filesystem_info): move the interface schema to the new format Sep 1, 2026
@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

@jedel1043 jedel1043 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.

Looks good! Thank you for cleaning this up for us

@james-garner-canonical
james-garner-canonical force-pushed the 26-08+chore+interface-schemas-hpc branch from 3c648d0 to 10197ab 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