component definition.
- """
- if collection:
- data = {
- "type": "array",
- "items": self.get_reference(self.get_response_serializer(path, method)),
- }
- else:
- data = self.get_reference(self.get_response_serializer(path, method))
-
- return {
- "description": operation["operationId"],
- "content": {
- "application/vnd.api+json": {
- "schema": {
- "type": "object",
- "required": ["data"],
- "properties": {
- "data": data,
- "included": {
- "type": "array",
- "uniqueItems": True,
- "items": {"$ref": "#/components/schemas/include"},
- },
- "links": {
- "description": "Link members related to primary data",
- "allOf": [
- {"$ref": "#/components/schemas/links"},
- {"$ref": "#/components/schemas/pagination"},
- ],
- },
- "jsonapi": {"$ref": "#/components/schemas/jsonapi"},
- },
- }
- }
- },
- }
-
- def _add_post_item_response(self, operation, path):
- """
- add response for POST of an item to operation
- """
- operation["requestBody"] = self.get_request_body(path, "POST")
- operation["responses"] = {
- "201": self._get_toplevel_200_response(
- operation, path, "POST", collection=False
- )
- }
- operation["responses"]["201"]["description"] = (
- "[Created](https://jsonapi.org/format/#crud-creating-responses-201). "
- "Assigned `id` and/or any other changes are in this response."
- )
- self._add_async_response(operation)
- operation["responses"]["204"] = {
- "description": "[Created](https://jsonapi.org/format/#crud-creating-responses-204) "
- "with the supplied `id`. No other changes from what was POSTed."
- }
- self._add_post_4xx_responses(operation)
-
- def _add_patch_item_response(self, operation, path):
- """
- Add PATCH response for an item to operation
- """
- operation["requestBody"] = self.get_request_body(path, "PATCH")
- operation["responses"] = {
- "200": self._get_toplevel_200_response(
- operation, path, "PATCH", collection=False
- )
- }
- self._add_patch_4xx_responses(operation)
-
- def _add_delete_item_response(self, operation, path):
- """
- add DELETE response for item or relationship(s) to operation
- """
- # Only DELETE of relationships has a requestBody
- if isinstance(self.view, views.RelationshipView):
- operation["requestBody"] = self.get_request_body(path, "DELETE")
- self._add_delete_responses(operation)
-
- def get_request_body(self, path, method):
- """
- A request body is required by JSON:API for POST, PATCH, and DELETE methods.
- """
- serializer = self.get_request_serializer(path, method)
- if not isinstance(serializer, (serializers.BaseSerializer,)):
- return {}
- is_relationship = isinstance(self.view, views.RelationshipView)
-
- # DRF uses a $ref to the component schema definition, but this
- # doesn't work for JSON:API due to the different required fields based on
- # the method, so make those changes and inline another copy of the schema.
-
- # TODO: A future improvement could make this DRYer with multiple component schemas:
- # A base schema for each viewset that has no required fields
- # One subclassed from the base that requires some fields (`type` but not `id` for POST)
- # Another subclassed from base with required type/id but no required attributes (PATCH)
-
- if is_relationship:
- item_schema = {"$ref": "#/components/schemas/ResourceIdentifierObject"}
- else:
- item_schema = self.map_serializer(serializer)
- if method == "POST":
- # 'type' and 'id' are both required for:
- # - all relationship operations
- # - regular PATCH or DELETE
- # Only 'type' is required for POST: system may assign the 'id'.
- item_schema["required"] = ["type"]
-
- if "properties" in item_schema and "attributes" in item_schema["properties"]:
- # No required attributes for PATCH
- if (
- method in ["PATCH", "PUT"]
- and "required" in item_schema["properties"]["attributes"]
- ):
- del item_schema["properties"]["attributes"]["required"]
- # No read_only fields for request.
- for name, schema in (
- item_schema["properties"]["attributes"]["properties"].copy().items()
- ): # noqa E501
- if "readOnly" in schema:
- del item_schema["properties"]["attributes"]["properties"][name]
-
- if "properties" in item_schema and "relationships" in item_schema["properties"]:
- # No required relationships for PATCH
- if (
- method in ["PATCH", "PUT"]
- and "required" in item_schema["properties"]["relationships"]
- ):
- del item_schema["properties"]["relationships"]["required"]
-
- return {
- "content": {
- ct: {
- "schema": {
- "required": ["data"],
- "properties": {"data": item_schema},
- }
- }
- for ct in self.content_types
- }
- }
-
- def map_serializer(self, serializer):
- """
- Custom map_serializer that serializes the schema using the JSON:API spec.
-
- Non-attributes like related and identity fields, are moved to 'relationships'
- and 'links'.
- """
- # TODO: remove attributes, etc. for relationshipView??
- if isinstance(
- serializer.parent, (serializers.ListField, serializers.BaseSerializer)
- ):
- # Return plain non-JSON:API serializer schema for serializers nested inside
- # a Serializer or a ListField, as those don't use the full JSON:API
- # serializer schemas.
- return super().map_serializer(serializer)
-
- required = []
- attributes = {}
- relationships_required = []
- relationships = {}
-
- for field in serializer.fields.values():
- if isinstance(field, serializers.HyperlinkedIdentityField):
- # the 'url' is not an attribute but rather a self.link, so don't map it here.
- continue
- if isinstance(field, serializers.HiddenField):
- continue
- if isinstance(
- field,
- (
- serializers.ManyRelatedField,
- ManySerializerMethodResourceRelatedField,
- ),
- ):
- if field.required:
- relationships_required.append(format_field_name(field.field_name))
- relationships[format_field_name(field.field_name)] = {
- "$ref": "#/components/schemas/reltomany"
- }
- continue
- if isinstance(field, serializers.RelatedField):
- if field.required:
- relationships_required.append(format_field_name(field.field_name))
- relationships[format_field_name(field.field_name)] = {
- "$ref": "#/components/schemas/reltoone"
- }
- continue
- if field.field_name == "id":
- # ID is always provided in the root of JSON:API and removed from the
- # attributes in JSONRenderer.
- continue
-
- if field.required:
- required.append(format_field_name(field.field_name))
-
- schema = self.map_field(field)
- if field.read_only:
- schema["readOnly"] = True
- if field.write_only:
- schema["writeOnly"] = True
- if field.allow_null:
- schema["nullable"] = True
- if field.default and field.default != empty and not callable(field.default):
- schema["default"] = field.default
- if field.help_text:
- # Ensure django gettext_lazy is rendered correctly
- schema["description"] = str(field.help_text)
- self.map_field_validators(field, schema)
-
- attributes[format_field_name(field.field_name)] = schema
-
- result = {
- "type": "object",
- "required": ["type", "id"],
- "additionalProperties": False,
- "properties": {
- "type": {"$ref": "#/components/schemas/type"},
- "id": {"$ref": "#/components/schemas/id"},
- "links": {
- "type": "object",
- "properties": {"self": {"$ref": "#/components/schemas/link"}},
- },
- },
- }
- if attributes:
- result["properties"]["attributes"] = {
- "type": "object",
- "properties": attributes,
- }
- if required:
- result["properties"]["attributes"]["required"] = required
-
- if relationships:
- result["properties"]["relationships"] = {
- "type": "object",
- "properties": relationships,
- }
- if relationships_required:
- result["properties"]["relationships"][
- "required"
- ] = relationships_required
- return result
-
- def _add_async_response(self, operation):
- """
- Add async response to operation
- """
- operation["responses"]["202"] = {
- "description": "Accepted for [asynchronous processing]"
- "(https://jsonapi.org/recommendations/#asynchronous-processing)",
- "content": {
- "application/vnd.api+json": {
- "schema": {"$ref": "#/components/schemas/datum"}
- }
- },
- }
-
- def _failure_response(self, reason):
- """
- Return failure response reason as the description
- """
- return {
- "description": reason,
- "content": {
- "application/vnd.api+json": {
- "schema": {"$ref": "#/components/schemas/failure"}
- }
- },
- }
-
- def _add_generic_failure_responses(self, operation):
- """
- Add generic failure response(s) to operation
- """
- for code, reason in [
- ("400", "bad request"),
- ("401", "not authorized"),
- ("429", "too many requests"),
- ]:
- operation["responses"][code] = self._failure_response(reason)
-
- def _add_get_4xx_responses(self, operation):
- """
- Add generic 4xx GET responses to operation
- """
- self._add_generic_failure_responses(operation)
- for code, reason in [("404", "not found")]:
- operation["responses"][code] = self._failure_response(reason)
-
- def _add_post_4xx_responses(self, operation):
- """
- Add POST 4xx error responses to operation
- """
- self._add_generic_failure_responses(operation)
- for code, reason in [
- (
- "403",
- "[Forbidden](https://jsonapi.org/format/#crud-creating-responses-403)",
- ),
- (
- "404",
- "[Related resource does not exist]"
- "(https://jsonapi.org/format/#crud-creating-responses-404)",
- ),
- (
- "409",
- "[Conflict](https://jsonapi.org/format/#crud-creating-responses-409)",
- ),
- ]:
- operation["responses"][code] = self._failure_response(reason)
-
- def _add_patch_4xx_responses(self, operation):
- """
- Add PATCH 4xx error responses to operation
- """
- self._add_generic_failure_responses(operation)
- for code, reason in [
- (
- "403",
- "[Forbidden](https://jsonapi.org/format/#crud-updating-responses-403)",
- ),
- (
- "404",
- "[Related resource does not exist]"
- "(https://jsonapi.org/format/#crud-updating-responses-404)",
- ),
- (
- "409",
- "[Conflict]([Conflict]"
- "(https://jsonapi.org/format/#crud-updating-responses-409)",
- ),
- ]:
- operation["responses"][code] = self._failure_response(reason)
-
- def _add_delete_responses(self, operation):
- """
- Add generic DELETE responses to operation
- """
- # the 2xx statuses:
- operation["responses"] = {
- "200": {
- "description": "[OK](https://jsonapi.org/format/#crud-deleting-responses-200)",
- "content": {
- "application/vnd.api+json": {
- "schema": {"$ref": "#/components/schemas/onlymeta"}
- }
- },
- }
- }
- self._add_async_response(operation)
- operation["responses"]["204"] = {
- "description": "[no content](https://jsonapi.org/format/#crud-deleting-responses-204)", # noqa: B950
- }
- # the 4xx errors:
- self._add_generic_failure_responses(operation)
- for code, reason in [
- (
- "404",
- "[Resource does not exist]"
- "(https://jsonapi.org/format/#crud-deleting-responses-404)",
- ),
- ]:
- operation["responses"][code] = self._failure_response(reason)
diff --git a/setup.cfg b/setup.cfg
index 4230dcbb..92606700 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -63,9 +63,6 @@ DJANGO_SETTINGS_MODULE=example.settings.test
filterwarnings =
error::DeprecationWarning
error::PendingDeprecationWarning
- # Django filter schema generation. Can be removed once we remove
- # schema support
- ignore:Built-in schema generation is deprecated.
testpaths =
example
tests
diff --git a/setup.py b/setup.py
index de61b0d1..0b88f4c9 100755
--- a/setup.py
+++ b/setup.py
@@ -112,7 +112,6 @@ def get_package_data(package):
extras_require={
"django-polymorphic": ["django-polymorphic>=3.0"],
"django-filter": ["django-filter>=2.4"],
- "openapi": ["pyyaml>=5.4", "uritemplate>=3.0.1"],
},
setup_requires=wheel,
python_requires=">=3.9",
diff --git a/tests/schemas/test_openapi.py b/tests/schemas/test_openapi.py
deleted file mode 100644
index 427f18fc..00000000
--- a/tests/schemas/test_openapi.py
+++ /dev/null
@@ -1,11 +0,0 @@
-from rest_framework_json_api.schemas.openapi import AutoSchema
-from tests.serializers import CallableDefaultSerializer
-
-
-class TestAutoSchema:
- def test_schema_callable_default(self):
- inspector = AutoSchema()
- result = inspector.map_serializer(CallableDefaultSerializer())
- assert result["properties"]["attributes"]["properties"]["field"] == {
- "type": "string",
- }
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy