[#351] Update OAS documentation

maykinmedia · Dec 12, 2023 · 7fa548c · 7fa548c
1 parent 7481d91
commit 7fa548c
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/src/objects/api/serializers.py b/src/objects/api/serializers.py
@@ -9,8 +9,8 @@
 from objects.utils.serializers import DynamicFieldsMixin
 
 from .fields import ObjectSlugRelatedField, ObjectTypeField, ObjectUrlField
-from .validators import GeometryValidator, IsImmutableValidator, JsonSchemaValidator
 from .utils import merge_patch
+from .validators import GeometryValidator, IsImmutableValidator, JsonSchemaValidator
 
 
 class ObjectRecordSerializer(serializers.ModelSerializer):

diff --git a/src/objects/api/v2/openapi.yaml b/src/objects/api/v2/openapi.yaml
@@ -377,6 +377,8 @@ paths:
     patch:
       operationId: object_partial_update
       description: Update the OBJECT by creating a new RECORD with the updates values.
+        The provided `record.data` value will be merged with the existing record data,
+        according to [RFC7396](https://datatracker.ietf.org/doc/html/rfc7396).
       parameters:
       - in: header
         name: Accept-Crs

diff --git a/src/objects/api/v2/views.py b/src/objects/api/v2/views.py
@@ -42,7 +42,9 @@
         description="Update the OBJECT by creating a new RECORD with the updates values."
     ),
     partial_update=extend_schema(
-        description="Update the OBJECT by creating a new RECORD with the updates values."
+        description="Update the OBJECT by creating a new RECORD with the updates values. "
+        "The provided `record.data` value will be merged with the existing record data, according "
+        "to [RFC7396](https://datatracker.ietf.org/doc/html/rfc7396)."
     ),
     destroy=extend_schema(
         description="Delete an OBJECT and all RECORDs belonging to it.",