chore(interfaces): move platform-engineering schemas to new format

interfaces/cloudflared_route/interface/v0/schema.py

@@ -1,30 +1,26 @@
 # Copyright 2024 Canonical
 # See LICENSE file for licensing details.
 """This file defines the schemas for the provider sides of the cloudflared_route interface.
-It exposes the interfaces.schema_base.DataBagSchema subclasses called:
-- ProviderSchema
 
 Examples:
-    ProviderSchema:
+    Provider:
         unit: <empty>
         app: {
           "tunnel_token_secret_id": "secret:csn5caau557j9bojn7rg",
           "nameserver": "1.1.1.1"
         }
 """
 
-from interface_tester.schema_base import DataBagSchema
 from pydantic import BaseModel, IPvAnyAddress
 
 
-class CloudflaredRouteProvider(BaseModel):
+class ProviderAppData(BaseModel):
     """Provider application databag schema for cloudflared_route integration."""
 
     tunnel_token_secret_id: str
     nameserver: IPvAnyAddress | None = None
 
 
-class ProviderSchema(DataBagSchema):
-    """Provider schema for cloudflared_route integration."""
-
-    app: CloudflaredRouteProvider
+ProviderUnitData = None
+RequirerAppData = None
+RequirerUnitData = None

interfaces/dns_record/interface/v0/schema.py

@@ -1,12 +1,9 @@
 # Copyright 2024 Canonical
 # See LICENSE file for licensing details.
 """This file defines the schemas for the provider and requirer sides of the dns_record interface.
-It exposes two interfaces.schema_base.DataBagSchema subclasses called:
-- ProviderSchema
-- RequirerSchema
 
 Examples:
-    RequirerSchema:
+    Requirer:
         unit: <empty>
         app: {
           "dns_entries": [
@@ -28,7 +25,7 @@
           ]
         }
 
-    ProviderSchema:
+    Provider:
         unit: <empty>
         app: {
           "dns_entries": [
@@ -49,7 +46,6 @@
 from enum import Enum
 from uuid import UUID
 
-from interface_tester.schema_base import DataBagSchema
 from pydantic import BaseModel, Field, IPvAnyAddress
 
 
@@ -111,7 +107,7 @@ class DnsProviderData(BaseModel):
     )
 
 
-class DNSRecordProvider(BaseModel):
+class ProviderAppData(BaseModel):
     """List statuses for the DNS records informed by the requirer."""
 
     dns_entries: list[DnsProviderData] = Field(
@@ -160,21 +156,13 @@ class RequirerEntries(BaseModel):
     )
 
 
-class DNSRecordRequirer(BaseModel):
+class RequirerAppData(BaseModel):
     """List of domains for the provider to manage."""
 
     dns_entries: list[RequirerEntries] = Field(
         name="DNS entries", description="List of DNS records for the provider to manage."
     )
 
 
-class ProviderSchema(DataBagSchema):
-    """Provider schema for dns_record."""
-
-    app: DNSRecordProvider
-
-
-class RequirerSchema(DataBagSchema):
-    """Requirer schema for dns_record."""
-
-    app: DNSRecordRequirer
+ProviderUnitData = None
+RequirerUnitData = None

interfaces/milter/interface/v0/schema.py

@@ -2,21 +2,17 @@
 # See LICENSE file for licensing details.
 """This file defines the schema for the provider side of the milter interface.
 
-It exposes one interfaces.schema_base.DataBagSchema subclass called:
-- ProviderSchema
-
 Examples:
-    ProviderSchema:
+    Provider:
         app: <empty>
         unit:
           port: 8892
 """
 
-from interface_tester.schema_base import DataBagSchema
 from pydantic import BaseModel, Field
 
 
-class MilterProviderData(BaseModel):
+class ProviderUnitData(BaseModel):
     port: int = Field(
         ge=1,
         le=65536,
@@ -26,11 +22,6 @@ class MilterProviderData(BaseModel):
     )
 
 
-class ProviderSchema(DataBagSchema):
-    """Provider schema for Milter."""
-
-    unit: MilterProviderData
-
-
-class RequirerSchema(DataBagSchema):
-    """Requirer schema for Milter."""
+ProviderAppData = None
+RequirerAppData = None
+RequirerUnitData = None

interfaces/nginx-route/interface/v0/schema.py

@@ -2,11 +2,10 @@
 
 from typing import Optional
 
-from interface_tester.schema_base import DataBagSchema
 from pydantic import BaseModel, Field
 
 
-class NginxRouteRequirerSchema(BaseModel):
+class RequirerAppData(BaseModel):
     service_hostname: str = Field(
         alias="service-hostname",
         description="The hostname of the service to create an ingress for.",
@@ -140,11 +139,6 @@ class NginxRouteRequirerSchema(BaseModel):
     )
 
 
-class ProviderSchema(DataBagSchema):
-    """Provider schema for nginx_route."""
-
-
-class RequirerSchema(DataBagSchema):
-    """Requirer schema for nginx_route."""
-
-    app: NginxRouteRequirerSchema
+ProviderAppData = None
+ProviderUnitData = None
+RequirerUnitData = None

interfaces/opencti_connector/interface/v0/schema.py

@@ -2,27 +2,22 @@
 # See LICENSE file for licensing details.
 """This file defines the schemas for the provider and requirer sides of the opencti-connector interface.
 
-It exposes two interfaces.schema_base.DataBagSchema subclasses called:
-- ProviderSchema
-- RequirerSchema
-
 Examples:
-    ProviderSchema:
+    Provider:
         unit: <empty>
         app: {
                 "connector_charm_name": "connector-charm-name",
                 "connector_type": "connector-type",
              }
 
-    RequirerSchema:
+    Requirer:
         unit: <empty>
         app: {
                 "opencti_url": "http://opencti-endpoints.stg-opencti.svc:8080",
                 "opencti_token": "secret:secret-id",
               }
 """
 
-from interface_tester.schema_base import DataBagSchema
 from pydantic import AnyHttpUrl, BaseModel, Field
 
 
@@ -45,12 +40,6 @@ class ProviderAppData(BaseModel):
     )
 
 
-class ProviderSchema(DataBagSchema):
-    """Provider schema for the opencti-connector interface."""
-
-    app: ProviderAppData
-
-
 class RequirerAppData(BaseModel):
     opencti_url: AnyHttpUrl = Field(
         description="URL to the OpenCTI instance.",
@@ -64,7 +53,5 @@ class RequirerAppData(BaseModel):
     )
 
 
-class RequirerSchema(DataBagSchema):
-    """Requirer schema for the opencti-connector interface."""
-
-    app: RequirerAppData
+ProviderUnitData = None
+RequirerUnitData = None

interfaces/saml/interface/v0/schema.py

@@ -2,11 +2,8 @@
 # See LICENSE file for licensing details.
 """This file defines the schema for the provider side of the saml interface.
 
-It exposes one interfaces.schema_base.DataBagSchema subclass called:
-- ProviderSchema
-
 Examples:
-    ProviderSchema:
+    Provider:
         unit: <empty>
         app: {"saml":
                  {
@@ -38,11 +35,10 @@
              }
 """
 
-from interface_tester.schema_base import DataBagSchema
 from pydantic import AnyHttpUrl, BaseModel, Field
 
 
-class SamlProviderData(BaseModel):
+class ProviderAppData(BaseModel):
     metadata_url: AnyHttpUrl | None = Field(
         description="URL to the IdP's metadata.",
         title="Metadata URL",
@@ -124,11 +120,6 @@ class SamlProviderData(BaseModel):
     )
 
 
-class ProviderSchema(DataBagSchema):
-    """Provider schema for SAML."""
-
-    app: SamlProviderData
-
-
-class RequirerSchema(DataBagSchema):
-    """Requirer schema for SAML."""
+ProviderUnitData = None
+RequirerAppData = None
+RequirerUnitData = None

interfaces/saml/ruff.toml

@@ -9,10 +9,3 @@ quote-style = "preserve"
     "D",  # docs
     "E501",  # line too long
 ]
-"./interface/v*/tests/*.py" = [
-    "CPY",  # copyright
-    "D",  # docs
-    "S",  # security
-    "E501",  # line too long
-    "F841",  # assignment to unused variable
-]

interfaces/smtp/interface/v0/schema.py

@@ -2,11 +2,10 @@
 # See LICENSE file for licensing details.
 """This file defines the schema for the provider side of the smtp interface.
 
-It exposes one interfaces.schema_base.DataBagSchema subclass called:
-- ProviderSchema
+It defines one model, `ProviderAppData`.
 
 Examples:
-    ProviderSchema:
+    Provider:
         unit: <empty>
         app: {"smtp":
                  {
@@ -23,7 +22,6 @@
 
 from enum import Enum
 
-from interface_tester.schema_base import DataBagSchema
 from pydantic import BaseModel, Field
 
 
@@ -43,7 +41,7 @@ class AuthType(str, Enum):
     PLAIN = "plain"
 
 
-class SmtpProviderData(BaseModel):
+class ProviderAppData(BaseModel):
     host: str = Field(
         min_length=1,
         description="SMTP host.",
@@ -89,11 +87,6 @@ class SmtpProviderData(BaseModel):
     )
 
 
-class ProviderSchema(DataBagSchema):
-    """Provider schema for SMTP."""
-
-    app: SmtpProviderData
-
-
-class RequirerSchema(DataBagSchema):
-    """Requirer schema for SMTP."""
+ProviderUnitData = None
+RequirerAppData = None
+RequirerUnitData = None

interfaces/smtp/ruff.toml

@@ -9,10 +9,3 @@ quote-style = "preserve"
     "D",  # docs
     "E501",  # line too long
 ]
-"./interface/v*/tests/*.py" = [
-    "CPY",  # copyright
-    "D",  # docs
-    "S",  # security
-    "E501",  # line too long
-    "F841",  # assignment to unused variable
-]