Merge branch 'main' into fix/empty-data-in-response-using-rest-action

Author: ericinfins

.github/workflows/tests.yml

@@ -30,8 +30,9 @@ jobs:
       - name: Run tox targets for ${{ matrix.python-version }}
         run: tox run -f py$(echo ${{ matrix.python-version }} | tr -d .)
       - name: Upload coverage report
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v4
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
           env_vars: PYTHON
   check:
     name: Run check

CHANGELOG.md

@@ -12,6 +12,12 @@ any parts of the framework not mentioned in the documentation should generally b
 
 ### Added
 
+* Added `429 Too Many Requests` as a possible error response in the OpenAPI schema.
+
+## [7.0.0] - 2024-05-02
+
+### Added
+
 * Added support for Python 3.12
 * Added support for Django 5.0
 * Added support for Django REST framework 3.15
@@ -23,6 +29,8 @@ any parts of the framework not mentioned in the documentation should generally b
 * Avoided that an empty attributes dict is rendered in case serializer does not
   provide any attribute fields.
 * Avoided shadowing of exception when rendering errors (regression since 4.3.0).
+* Ensured that sparse fields only applies when rendering, not when parsing.
+* Adjusted that sparse fields properly removes meta fields when not defined.
 
 ### Removed
 

example/tests/__snapshots__/test_openapi.ambr

@@ -68,6 +68,16 @@
           }
         },
         "description": "[Resource does not exist](https://jsonapi.org/format/#crud-deleting-responses-404)"
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
       }
     },
     "tags": [
@@ -264,6 +274,16 @@
           }
         },
         "description": "[Conflict]([Conflict](https://jsonapi.org/format/#crud-updating-responses-409)"
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
       }
     },
     "tags": [
@@ -399,6 +419,16 @@
           }
         },
         "description": "not found"
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
       }
     },
     "tags": [
@@ -546,6 +576,16 @@
           }
         },
         "description": "not found"
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
       }
     },
     "tags": [
@@ -754,6 +794,16 @@
           }
         },
         "description": "[Conflict](https://jsonapi.org/format/#crud-creating-responses-409)"
+      },
+      "429": {
+        "content": {
+          "application/vnd.api+json": {
+            "schema": {
+              "$ref": "#/components/schemas/failure"
+            }
+          }
+        },
+        "description": "too many requests"
       }
     },
     "tags": [
@@ -1341,6 +1391,16 @@
                 }
               },
               "description": "not found"
+            },
+            "429": {
+              "content": {
+                "application/vnd.api+json": {
+                  "schema": {
+                    "$ref": "#/components/schemas/failure"
+                  }
+                }
+              },
+              "description": "too many requests"
             }
           },
           "tags": [

example/tests/integration/test_non_paginated_responses.py

@@ -14,7 +14,7 @@ def test_multiple_entries_no_pagination(multiple_entries, client):
     expected = {
         "data": [
             {
-                "type": "posts",
+                "type": "entries",
                 "id": "1",
                 "attributes": {
                     "headline": multiple_entries[0].headline,
@@ -70,7 +70,7 @@ def test_multiple_entries_no_pagination(multiple_entries, client):
                 },
             },
             {
-                "type": "posts",
+                "type": "entries",
                 "id": "2",
                 "attributes": {
                     "headline": multiple_entries[1].headline,

example/tests/integration/test_pagination.py

@@ -14,7 +14,7 @@ def test_pagination_with_single_entry(single_entry, client):
     expected = {
         "data": [
             {
-                "type": "posts",
+                "type": "entries",
                 "id": "1",
                 "attributes": {
                     "headline": single_entry.headline,

example/tests/integration/test_sparse_fieldsets.py

@@ -15,6 +15,7 @@ def test_sparse_fieldset_valid_fields(client, entry):
     entry = data[0]
     assert entry["attributes"].keys() == {"headline"}
     assert entry["relationships"].keys() == {"blog"}
+    assert "meta" not in entry
 
 
 @pytest.mark.parametrize(

example/tests/test_filters.py

@@ -470,7 +470,7 @@ def test_search_keywords(self):
         expected_result = {
             "data": [
                 {
-                    "type": "posts",
+                    "type": "entries",
                     "id": "7",
                     "attributes": {
                         "headline": "ANTH3868X",

example/tests/unit/test_renderer_class_methods.py

@@ -102,8 +102,8 @@ def test_extract_attributes():
     assert sorted(JSONRenderer.extract_attributes(fields, resource)) == sorted(
         expected
     ), "Regular fields should be extracted"
-    assert sorted(JSONRenderer.extract_attributes(fields, {})) == sorted(
-        {"username": ""}
+    assert (
+        JSONRenderer.extract_attributes(fields, {}) == {}
     ), "Should not extract read_only fields on empty serializer"
 
 

example/views.py

@@ -126,7 +126,10 @@ class BlogCustomViewSet(JsonApiViewSet):
 
 class EntryViewSet(ModelViewSet):
     queryset = Entry.objects.all()
-    resource_name = "posts"
+    # TODO it should not be supported to overwrite resource name
+    # of endpoints with serializers as includes and sparse fields
+    # cannot be aware of it
+    # resource_name = "posts"
 
     def get_serializer_class(self):
         return EntrySerializer

requirements/requirements-codestyle.txt

@@ -1,5 +1,5 @@
-black==24.4.0
+black==24.4.2
 flake8==7.0.0
-flake8-bugbear==24.2.6
+flake8-bugbear==24.4.26
 flake8-isort==6.1.1
 isort==5.13.2

requirements/requirements-documentation.txt

@@ -1,3 +1,3 @@
 recommonmark==0.7.1
-Sphinx==7.2.6
+Sphinx==7.3.7
 sphinx_rtd_theme==2.0.0

requirements/requirements-testing.txt

@@ -1,6 +1,6 @@
 factory-boy==3.3.0
-Faker==24.9.0
-pytest==8.1.1
+Faker==25.0.1
+pytest==8.2.0
 pytest-cov==5.0.0
 pytest-django==4.8.0
 pytest-factoryboy==2.7.0

rest_framework_json_api/__init__.py

@@ -1,5 +1,5 @@
 __title__ = "djangorestframework-jsonapi"
-__version__ = "6.1.0"
+__version__ = "7.0.0"
 __author__ = ""
 __license__ = "BSD"
 __copyright__ = ""