summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2020-04-16 00:43:40 +0100
committerStephen Finucane <stephen@that.guru>2020-04-18 11:57:28 +0100
commit48f27d587874414df95a03f7ab338f0f029de7db (patch)
tree00656b58ce156f9ee90b29c28a013b2183a727d9
parent2047107468a1d78daf2e917ddce1253b38ea23ea (diff)
downloadpatchwork-48f27d587874414df95a03f7ab338f0f029de7db.tar
patchwork-48f27d587874414df95a03f7ab338f0f029de7db.tar.gz
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>
-rw-r--r--docs/api/schemas/latest/patchwork.yaml3
-rw-r--r--docs/api/schemas/patchwork.j23
-rw-r--r--docs/api/schemas/v1.0/patchwork.yaml3
-rw-r--r--docs/api/schemas/v1.1/patchwork.yaml3
-rw-r--r--docs/api/schemas/v1.2/patchwork.yaml3
-rw-r--r--patchwork/tests/api/test_project.py7
6 files changed, 15 insertions, 7 deletions
diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index e0054b9..dbfa0aa 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 66904d0..f4628ee 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 9205c4f..a2b1b85 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 993bf51..dcec32e 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 aac7032..1b69229 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 5a76767..bf87a56 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)