Skip to content

chore(interfaces): move the unowned interface schemas to the new format - #659

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

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

Conversation

@james-garner-canonical

@james-garner-canonical james-garner-canonical commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Interface schemas will 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.

This PR updates the schemas without specific team CODEOWNERS accordingly. A follow up PR will document this and add tooling to enforce it, after similar PRs have landed for all the other CODEOWNERS in this repository.

Only the latest version of each schema is updated. We plan to flatten the interface definitions in future to no longer store old versions, and only validate and document the current version.

This PR also removes the interface test definitions for these interfaces. The interface tests are being retired; the tooling that ran them is being removed separately.

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.

This also removes the interface test definitions for these interfaces. The
interface tests are being retired; the tooling that ran them is removed
separately.

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 02:54
@james-garner-canonical
james-garner-canonical requested a review from a team as a code owner September 3, 2026 02:54
@james-garner-canonical
james-garner-canonical force-pushed the 26-08+chore+interface-schemas-maintainers branch from e833e42 to 92afc9a 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