matchbox-db 0.6.3.dev96__tar.gz → 0.7.0__tar.gz

{matchbox_db-0.6.3.dev96/src/matchbox_db.egg-info → matchbox_db-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matchbox-db
-Version: 0.6.3.dev96
+Version: 0.7.0
 Summary: A framework for orchestrating and comparing data linking and deduplication methodologies.
 Author: Department for Business and Trade
 Project-URL: Documentation, https://uktrade.github.io/matchbox/

{matchbox_db-0.6.3.dev96 → matchbox_db-0.7.0}/src/matchbox/common/dtos.py

@@ -16,10 +16,12 @@ from pydantic import (
     ConfigDict,
     Field,
     GetCoreSchemaHandler,
+    GetJsonSchemaHandler,
     field_serializer,
     field_validator,
     model_validator,
 )
+from pydantic.json_schema import JsonSchemaValue
 from pydantic_core import core_schema
 from sqlglot import errors, expressions, parse_one
 
@@ -218,11 +220,13 @@ class LocationType(StrEnum):
 class MatchboxName(str):
     """Sub-class of string which validates names for the Matchbox DB."""
 
+    PATTERN = r"^[a-zA-Z0-9_.-]+$"
+
     def __new__(cls, value: str):
         """Creates new instance of validated name."""
         if not isinstance(value, str):
             raise MatchboxNameError("Name must be a string")
-        if not re.match(r"^[a-zA-Z0-9_.-]+$", value):
+        if not re.match(cls.PATTERN, value):
             raise MatchboxNameError(
                 f"Name '{value}' is invalid. It can only include "
                 "alphanumeric characters, underscores, dots or hyphens."
@@ -242,6 +246,22 @@ class MatchboxName(str):
             ),
         )
 
+    @classmethod
+    def __get_pydantic_json_schema__(
+        cls,
+        schema: core_schema.CoreSchema,
+        handler: GetJsonSchemaHandler,
+    ) -> JsonSchemaValue:
+        """Generate JSON schema for OpenAPI documentation."""
+        json_schema = handler(core_schema.str_schema())
+        json_schema.update(
+            {
+                "type": "string",
+                "pattern": cls.PATTERN,
+            }
+        )
+        return json_schema
+
 
 CollectionName: TypeAlias = MatchboxName
 """Type alias for collection names."""

{matchbox_db-0.6.3.dev96 → matchbox_db-0.7.0/src/matchbox_db.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matchbox-db
-Version: 0.6.3.dev96
+Version: 0.7.0
 Summary: A framework for orchestrating and comparing data linking and deduplication methodologies.
 Author: Department for Business and Trade
 Project-URL: Documentation, https://uktrade.github.io/matchbox/