From f464b75e12f1e4a4b4adb71ad071ce9930381ac0 Mon Sep 17 00:00:00 2001 From: Vagrant Default User Date: Fri, 11 Aug 2017 08:57:46 +0000 Subject: [PATCH] Description of path fields defaults to None while description of form fields defaults to "". This results in inconsistent presentation. This commit changes path fields default to "". Example before change: "/example-movies/v1/{id}/": {"put": {"description": "Updates the movie with passed movie id.", "parameters": [{"description": null, "required": true, "type": "string", "name": "id", "in": "path"}, {"description": "", "required": true, "type": "string", "name": "title", "in": "formData"}, {"description": "", "required": true, "type": "integer", "name": "rating", "in": "formData"}], "tags": ["example-movies"], "summary": "Updates the movie with passed movie id.", "operationId": "example-movies_v1_update", "consumes": ["application/x-www-form-urlencoded"], "responses": {"200": {"description": ""}}}, Example after change: "/example-movies/v1/{id}/": {"put": {"description": "Updates the movie with passed movie id.", "parameters": [{"description": "", "required": true, "type": "string", "name": "id", "in": "path"}, {"description": "", "required": true, "type": "string", "name": "title", "in": "formData"}, {"description": "", "required": true, "type": "integer", "name": "rating", "in": "formData"}], "tags": ["example-movies"], "summary": "Updates the movie with passed movie id.", "operationId": "example-movies_v1_update", "consumes": ["application/x-www-form-urlencoded"], "responses": {"200": {"description": ""}}} Description of id field changed to be consistent with title and rating fields' descriptions. --- coreapi/document.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/coreapi/document.py b/coreapi/document.py index c6c9ceb..f98bd6b 100644 --- a/coreapi/document.py +++ b/coreapi/document.py @@ -47,7 +47,7 @@ def _key_sorting(item): # NOTE: 'type', 'description' and 'example' are now deprecated, # in favor of 'schema'. Field = namedtuple('Field', ['name', 'required', 'location', 'schema', 'description', 'type', 'example']) -Field.__new__.__defaults__ = (False, '', None, None, None, None) +Field.__new__.__defaults__ = (False, '', None, '', None, None) # The Core API primitives: