Remove the obligation to provide an assignee in REST API context #345

Signed-off-by: tdruez <[email protected]>

Author: tdruez

docs/integrations-rest-api.rst

@@ -126,11 +126,11 @@ Required fields:
 
 - **title** (string): A short, descriptive title of the request.
 - **request_template** (string): URI of the template to use.
-- **assignee** (string): Username of the person assigned.
 
 Optional fields:
 
 - **status** (string): ``open``, ``closed``, or ``draft``. Default is ``open``.
+- **assignee** (string): Username of the person assigned.
 - **priority** (string|null): Priority level.
 - **product_context** (string|null): URI of a product context.
 - **notes** (string): Notes related to the request.
@@ -150,8 +150,7 @@ Example of minimal JSON payload::
 
     {
         "title": "New vulnerability found",
-        "request_template": "Address Vulnerabilities in Product Packages",
-        "assignee": "username"
+        "request_template": "Address Vulnerabilities in Product Packages"
     }
 
 Example using cURL::
@@ -160,8 +159,7 @@ Example using cURL::
     headers="Authorization: Token abcdef123456"
     data='{
         "title": "New vulnerability found",
-        "request_template": "Address Vulnerabilities in Product Packages",
-        "assignee": "username"
+        "request_template": "Address Vulnerabilities in Product Packages"
     }'
 
     curl -X POST "$api_url" -H "$headers" -d "$data"

workflow/api.py

@@ -165,7 +165,12 @@ class RequestSerializer(DataspacedSerializer):
     )
     request_template_name = serializers.StringRelatedField(source="request_template.name")
     requester = serializers.StringRelatedField()
-    assignee = DataspacedSlugRelatedField(slug_field="username")
+    assignee = DataspacedSlugRelatedField(
+        slug_field="username",
+        # Not required in the REST API context to simplify external integrations.
+        allow_null=True,
+        required=False,
+    )
     priority = DataspacedSlugRelatedField(
         slug_field="label",
         allow_null=True,

workflow/tests/test_api.py

@@ -361,10 +361,16 @@ def test_api_request_endpoint_create(self):
         expected = {
             "title": ["This field is required."],
             "request_template": ["This field may not be null."],
-            "assignee": ["This field may not be null."],
         }
         self.assertEqual(expected, response.json())
 
+        data = {
+            "title": "Title",
+            "request_template": self.request_template1_detail_url,
+        }
+        response = self.client.post(self.request_list_url, data)
+        self.assertEqual(status.HTTP_201_CREATED, response.status_code)
+
         data = {
             "title": "Title",
             "request_template": self.request_template1_detail_url,