Skip to content
This repository was archived by the owner on Mar 18, 2019. It is now read-only.

Descriptions of path fields and form fields default same value #145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ajant
Copy link

@ajant ajant commented Aug 11, 2017

… 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.

… 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.
@draskomikic
Copy link

Hi, please merge this pull request, I ran into same issue.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy