Omit id field from OpenAPI schema attributes (#1156)

Author: arttuperala

CHANGELOG.md

@@ -27,6 +27,7 @@ any parts of the framework not mentioned in the documentation should generally b
 
 * Refactored handling of the `sort` query parameter to fix duplicate declaration in the generated schema definition
 * Non-field serializer errors are given a source.pointer value of "/data".
+* Fixed "id" field being added to /data/attributes in the OpenAPI schema when it is not rendered there.
 
 ## [6.0.0] - 2022-09-24
 

example/tests/test_openapi.py

@@ -110,6 +110,21 @@ def test_schema_construction(snapshot):
     assert snapshot == json.dumps(schema, indent=2, sort_keys=True)
 
 
+def test_schema_id_field():
+    """ID field is only included in the root, not the attributes."""
+    patterns = [
+        re_path("^companies/?$", views.CompanyViewset.as_view({"get": "list"})),
+    ]
+    generator = SchemaGenerator(patterns=patterns)
+
+    request = create_request("/")
+    schema = generator.get_schema(request=request)
+
+    company_properties = schema["components"]["schemas"]["Company"]["properties"]
+    assert company_properties["id"] == {"$ref": "#/components/schemas/id"}
+    assert "id" not in company_properties["attributes"]["properties"]
+
+
 def test_schema_parameters_include():
     """Include paramater is only used when serializer defines included_serializers."""
     patterns = [

rest_framework_json_api/schemas/openapi.py

@@ -670,6 +670,10 @@ def map_serializer(self, serializer):
                     "$ref": "#/components/schemas/reltomany"
                 }
                 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))