rest api integrate jsonschema compatibility #175
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hackaugusto
force-pushed
the
hacka-rest-api-integrate-jsonschema-compatibility
branch
2 times, most recently
from
3fb0e2b to
8fb3604
Compare
5 tasks
hackaugusto
force-pushed
the
hacka-rest-api-integrate-jsonschema-compatibility
branch
4 times, most recently
from
ce49fb9 to
65dddde
Compare
HelenMel
reviewed
Mar 16, 2021
karapace/avro_compatibility.py
Outdated
| from enum import Enum | ||
| from typing import Any, cast, Dict, List, Optional, Set | ||
| from enum import Enum, unique | ||
| from typing import Any, cast, Dict, Generic, List, Optional, Set, TypeVar |
There was a problem hiding this comment.
mmm....Generics...things become interesting
HelenMel
reviewed
Mar 16, 2021
HelenMel
reviewed
Mar 16, 2021
HelenMel
reviewed
Mar 16, 2021
HelenMel
reviewed
Mar 16, 2021
hackaugusto
force-pushed
the
hacka-rest-api-integrate-jsonschema-compatibility
branch
from
27b217c to
cbcf6bd
Compare
hackaugusto
force-pushed
the
hacka-rest-api-integrate-jsonschema-compatibility
branch
from
cbcf6bd to
569eb1f
Compare
hackaugusto
commented
Mar 16, 2021
|
|
||
| def check_compatibility( | ||
| source: TypedSchema, target: TypedSchema, compatibility_mode: CompatibilityModes | ||
| ) -> SchemaCompatibilityResult: |
There was a problem hiding this comment.
Instead of raising, now the error is returned. This allows the API to report the error message.
| import json | ||
|
|
||
|
|
||
| def parse_schema_definition(schema_definition: str) -> Draft7Validator: |
There was a problem hiding this comment.
I had to move the function to avoid circular imports
hackaugusto
commented
Mar 16, 2021
| result = check_avro_compatibility(reader_schema=target.schema, writer_schema=source.schema) | ||
| result = result.merged_with(check_avro_compatibility(reader_schema=source.schema, writer_schema=target.schema)) | ||
|
|
||
| elif source.schema_type is SchemaType.JSONSCHEMA: |
There was a problem hiding this comment.
Adding this is pretty much all that was needed to support jsonschema in the APIs, the rest of the code was already in place.
This changes the code to use the SchemaCompatibilityResult class instead of IncompatibleSchema exception to report the compatibility status, this allows the server to use the incompatibility message on the response, which can be useful for understading what caused the compatibility problem.
hackaugusto
force-pushed
the
hacka-rest-api-integrate-jsonschema-compatibility
branch
from
569eb1f to
44f0c0b
Compare
hackaugusto
commented
Mar 16, 2021
| subschema = schema.get(type_.value) | ||
| if subschema is not None: | ||
| # https://json-schema.org/draft/2020-12/json-schema-core.html#rfc.section.10.2.1 | ||
| assert isinstance(subschema, list), "allOf/anyOf/oneOf must be an array" |
There was a problem hiding this comment.
This was caught by mypy, not by a test.
I had to add the isinstance check to narrow the type, however that assert fails for NOT, so the two cases had to be split and it fixed the bug with not (I probably need to also add a unit test for that)
|
LGTM. Do you have an intent to add something more? |
Nope |
HelenMel
approved these changes
Mar 17, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #171merged.This integrates the jsonschema compatibility check with the existing rest apis.