add schema for example object.

.gitignore

@@ -43,8 +43,9 @@ __pypackages__/
 # Environments
 venv/
 
-# PyCharm
+# IDEs
 .idea/
+.zed/
 
 # PyPI configuration file
 .pypirc

CHANGES.md

@@ -1,3 +1,7 @@
+## Version 0.8.0
+
+* Add schema for example object.
+
 ## Version 0.7.1
 
 * Add schema for tags object.

Makefile

@@ -29,6 +29,7 @@ clean:
 	rm -rf venv/
 	rm -rf dist/
 	rm -rf src/Schema_First.egg-info
+	find . -type d -name __pycache__ -exec rm -r {} \+
 
 build: clean venv
 	$(PYTHON_VENV) -m build

pyproject.toml

@@ -20,7 +20,7 @@ license = {file = "LICENSE"}
 name = "Schema-First"
 readme = "README.md"
 requires-python = ">=3.13"
-version = "0.7.1"
+version = "0.8.0"
 
 [project.optional-dependencies]
 dev = [

src/schema_first/openapi/schemas/v3_1_1/example_schema.py

@@ -0,0 +1,21 @@
+from marshmallow import fields
+from marshmallow import validate
+from marshmallow import validates_schema
+from marshmallow import ValidationError
+
+from ..base import BaseSchema
+from ..base import DocStringFields
+from .schema_object_schema import SchemaObjectSchema
+
+
+class ExampleSchema(DocStringFields, BaseSchema):
+    dataValue = fields.Nested(SchemaObjectSchema)
+    serializedValue = fields.String(validate=validate.Length(min=1))
+    externalValue = fields.String(validate=validate.Length(min=1))
+
+    @validates_schema
+    def validate_exclusive(self, data, **kwargs) -> None:
+        if 'serializedValue' in data and 'externalValue' in data:
+            raise ValidationError(
+                'The <serializedValue> field is mutually exclusive of the <externalValue> field.'
+            )

src/schema_first/openapi/schemas/v3_1_1/schema_object_schema.py

@@ -213,4 +213,4 @@ def load(
                 data, many=many, partial=partial, unknown=unknown
             )
         except KeyError:
-            raise ValidationError(f'Data type <{data["type"]}> not supported.')
+            raise ValidationError(f'Data type in <{data}> not exist.')

tests/conftest.py

@@ -9,9 +9,10 @@
 tests_dir_abspath = os.path.dirname(os.path.abspath(__file__))
 
 pytest_plugins = (
-    'tests.objects.info_object.conftest',
     'tests.objects.contact_object.conftest',
+    'tests.objects.example_object.conftest',
     'tests.objects.external_docs_object.conftest',
+    'tests.objects.info_object.conftest',
     'tests.objects.license_object.conftest',
     'tests.objects.schema_object.conftest',
     'tests.objects.schema_object.string_field.conftest',

tests/objects/example_object/conftest.py

@@ -0,0 +1,17 @@
+import pytest
+
+
+@pytest.fixture
+def fx_example_object_required() -> dict:
+    return {}
+
+
+@pytest.fixture
+def fx_example_object_full(fx_example_object_required, fx_schema_object__full) -> dict:
+    return {
+        **fx_example_object_required,
+        'summary': 'A work with an average rating of 4.5 stars',
+        'description': 'A work with an average rating of 4.5 stars',
+        'dataValue': fx_schema_object__full,
+        'serializedValue': '| {"author": "A. Writer", "title": "An Older Book", "rating": 4.5}',
+    }

tests/objects/example_object/test_example_object.py

@@ -0,0 +1,19 @@
+from marshmallow.exceptions import ValidationError
+import pytest
+
+from src.schema_first.openapi.schemas.v3_1_1.example_schema import ExampleSchema
+
+
+def test_example_schema_required(fx_example_object_required):
+    ExampleSchema().load(fx_example_object_required)
+
+
+def test_example_schema_full(fx_example_object_full):
+    ExampleSchema().load(fx_example_object_full)
+
+
+def test_example_schema_bad_kind(fx_example_object_full):
+    fx_example_object_full['kind'] = 'bad_kind'
+
+    with pytest.raises(ValidationError):
+        ExampleSchema().load(fx_example_object_full)