From: Stephen Finucane <stephen@that.guru>
Date: Wed, 15 Apr 2020 23:43:40 +0000 (+0100)
Subject: docs: Resolve issues with 'projects'
X-Git-Tag: v3.0.0~62
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=48f27d587874414df95a03f7ab338f0f029de7db;p=thirdparty%2Fpatchwork.git

docs: Resolve issues with 'projects'

Two issues here:

- The ID in '/projects/{id}' can be either an integer or a string.
- We were attempting to validate an invalid request.

Signed-off-by: Stephen Finucane <stephen@that.guru>
---

diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index e0054b92..dbfa0aab 100644
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/patchwork.yaml
@@ -865,7 +865,8 @@ paths:
         required: true
         schema:
           title: ID
-          type: integer
+          # TODO: Add regex?
+          type: string
     get:
       description: Show a project.
       operationId: projects_read
diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index 66904d03..f4628ee2 100644
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -886,7 +886,8 @@ paths:
         required: true
         schema:
           title: ID
-          type: integer
+          # TODO: Add regex?
+          type: string
     get:
       description: Show a project.
       operationId: projects_read
diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml
index 9205c4f0..a2b1b858 100644
--- a/docs/api/schemas/v1.0/patchwork.yaml
+++ b/docs/api/schemas/v1.0/patchwork.yaml
@@ -726,7 +726,8 @@ paths:
         required: true
         schema:
           title: ID
-          type: integer
+          # TODO: Add regex?
+          type: string
     get:
       description: Show a project.
       operationId: projects_read
diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml
index 993bf51f..dcec32ef 100644
--- a/docs/api/schemas/v1.1/patchwork.yaml
+++ b/docs/api/schemas/v1.1/patchwork.yaml
@@ -726,7 +726,8 @@ paths:
         required: true
         schema:
           title: ID
-          type: integer
+          # TODO: Add regex?
+          type: string
     get:
       description: Show a project.
       operationId: projects_read
diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index aac70321..1b692290 100644
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -865,7 +865,8 @@ paths:
         required: true
         schema:
           title: ID
-          type: integer
+          # TODO: Add regex?
+          type: string
     get:
       description: Show a project.
       operationId: projects_read
diff --git a/patchwork/tests/api/test_project.py b/patchwork/tests/api/test_project.py
index 5a767674..bf87a563 100644
--- a/patchwork/tests/api/test_project.py
+++ b/patchwork/tests/api/test_project.py
@@ -196,8 +196,11 @@ class TestProjectAPI(utils.APITestCase):
 
         user = create_maintainer(project)
         self.client.force_authenticate(user=user)
-        resp = self.client.patch(self.api_url(project.id), {
-            'link_name': 'test'})
+        resp = self.client.patch(
+            self.api_url(project.id),
+            {'link_name': 'test'},
+            validate_request=False,
+        )
         # NOTE(stephenfin): This actually returns HTTP 200 due to
         # https://github.com/encode/django-rest-framework/issues/1655
         self.assertEqual(status.HTTP_200_OK, resp.status_code)