postman-app-support icon indicating copy to clipboard operation
postman-app-support copied to clipboard

describing parameters is not complete enough

Open loicginoux opened this issue 5 years ago • 4 comments

The way postman let us describe all parameters is not complete enough. Only having a "description" fields to explain every details related to a parameter seems not enough.

I miss fields like "optional/mandatory", "restricted values", a "default value" field, and a "type" field. So because of that I didn't see another way than to create a markdown table in the endpoint description, see how it is displayed below:

Screenshot 2020-01-08 17 59 42

The problem with that solution is that for larger markdown table, the documentation displayed the markdown table truncated. See another example with more detailed parameters:

Screenshot 2020-01-08 17 48 01

Is there a way to display the whole markdown table ? How can I document parameters properly ? Thank you

loicginoux avatar Jan 08 '20 17:01 loicginoux