Skip to content

bugfix/keyerror-at-fields-to-jsonapi-schema-rendering #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
creativecodemind wants to merge 2 commits into
base: master
Choose a base branch
from
Open

bugfix/keyerror-at-fields-to-jsonapi-schema-rendering #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8cba9c
Fix KeyError @ fields to JSON:API schema rendering
Feb 29, 2024
e657182
Unit tests: test random order of fields conversion
Mar 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion starlette_jsonapi/openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def fields2jsonschema(self, fields, *, ordered=False, partial=None):
properties['attributes']['properties'][observed_field_name] = prop
# TODO: support meta fields

if field_obj.required:
if field_obj.required and field_name != 'id':
if not partial or (
is_collection(partial) and field_name not in partial
):
Expand Down
200 changes: 199 additions & 1 deletion tests/test_openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,209 @@
from starlette_jsonapi.schema import JSONAPISchema
from starlette_jsonapi.meta import registered_resources
from starlette_jsonapi.openapi import (
JSONAPISchemaGenerator, JSONAPIMarshmallowPlugin,
JSONAPISchemaConverter, JSONAPISchemaGenerator, JSONAPIMarshmallowPlugin,
with_openapi_info, response_for_relationship, request_for_relationship,
)


JSONAPI_SCHEMA_CONVERTER = JSONAPISchemaConverter(
openapi_version='3.0.0',
schema_name_resolver=None,
spec=APISpec(
title='Test API',
version='1.0',
openapi_version='3.0.0',
info={'description': 'Test OpenAPI resource'},
plugins=[JSONAPIMarshmallowPlugin()],
)
)


class FakeSchema(JSONAPISchema):
class Meta:
type_ = "fakes"
self_route = f"{type_}:get"
self_route_kwargs = {"id": "<id>"}
self_route_many = f"{type_}:get_many"

id = fields.UUID(
metadata={
'unique': True,
'description': 'identifier of the instance',
},
required=True,
)
name = fields.Str(
required=True,
metadata={
'description': 'name of the instance'
}
)
version = fields.Str(
metadata={
'description': 'version of the instance'
}
)
deleted = fields.Boolean(
required=True,
metadata={
'description': 'if the instance is deleted'
}
)

@classmethod
def get_fields_with_parent_assigned(cls):
fields_parent_assigned = FakeSchema.get_fields()

for item in fields_parent_assigned:
fields_parent_assigned[item].parent = FakeSchema

return fields_parent_assigned


def test_fields2jsonschema_conversion_if_id_first_item_iterated():
error = None
fields_to_convert = FakeSchema.get_fields_with_parent_assigned()

try:
jsonschema = JSONAPI_SCHEMA_CONVERTER.fields2jsonschema(
fields={
'id': fields_to_convert['id'],
'name': fields_to_convert['name'],
'deleted': fields_to_convert['deleted'],
},
)
except Exception as e:
error = e

assert not error
assert jsonschema == {
'type': 'object',
'properties': {
'id': {
'type': 'string',
'format': 'uuid',
'description': 'identifier of the instance',
},
'type': {
'type': 'string',
'enum': ['fakes'],
},
'attributes': {
'type': 'object',
'properties': {
'name': {
'type': 'string',
'description': 'name of the instance',
},
'deleted': {
'type': 'boolean',
'description': 'if the instance is deleted',
}
},
'required': ['deleted', 'name'],
}
},
'required': ['type', 'attributes'],
}


def test_fields2jsonschema_conversion_if_id_last_item_iterated():
error = None
fields_to_convert = FakeSchema.get_fields_with_parent_assigned()

try:
jsonschema = JSONAPI_SCHEMA_CONVERTER.fields2jsonschema(
fields={
'name': fields_to_convert['name'],
'deleted': fields_to_convert['deleted'],
'id': fields_to_convert['id'],
},
)
except Exception as e:
error = e

assert not error
assert jsonschema == {
'type': 'object',
'properties': {
'id': {
'type': 'string',
'format': 'uuid',
'description': 'identifier of the instance',
},
'type': {
'type': 'string',
'enum': ['fakes'],
},
'attributes': {
'type': 'object',
'properties': {
'name': {
'type': 'string',
'description': 'name of the instance',
},
'deleted': {
'type': 'boolean',
'description': 'if the instance is deleted',
}
},
'required': ['deleted', 'name'],
}
},
'required': ['type', 'attributes'],
}


def test_fields2jsonschema_conversion_if_id_in_between_item_iterated():
error = None
fields_to_convert = FakeSchema.get_fields_with_parent_assigned()

try:
jsonschema = JSONAPI_SCHEMA_CONVERTER.fields2jsonschema(
fields={
'name': fields_to_convert['name'],
'version': fields_to_convert['version'],
'id': fields_to_convert['id'],
'deleted': fields_to_convert['deleted'],
},
)
except Exception as e:
error = e

assert not error
assert jsonschema == {
'type': 'object',
'properties': {
'id': {
'type': 'string',
'format': 'uuid',
'description': 'identifier of the instance',
},
'type': {
'type': 'string',
'enum': ['fakes'],
},
'attributes': {
'type': 'object',
'properties': {
'name': {
'type': 'string',
'description': 'name of the instance',
},
'deleted': {
'type': 'boolean',
'description': 'if the instance is deleted',
},
'version': {'description': 'version of the instance', 'type': 'string'},
},
'required': ['deleted', 'name'],
}
},
'required': ['type', 'attributes'],
}


@pytest.fixture
def openapi_schema_as_dict():
def make_schema_for_app(starlette_app: Starlette) -> dict:
Expand Down