cjminions
February 4, 2020, 4:43pm
1
It would be helpful to include the content type column in the documentation. It would serve as a good field to let the viewer know what data types are accepted for those parameters.
Also +1 on a required vs optional field in the docs
arlem
February 5, 2020, 9:50am
2
Hi @cjminions ,
We’re taking all feature requests on GitHub now. I think both yours have already been made, please subscribe to these to be kept up to date on whether we’ll be implementing it or not:
opened 05:13PM - 08 Jan 20 UTC
feature
product/documentation
The way postman let us describe all parameters is not complete enough. Only havi… ng 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:
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:
Is there a way to display the whole markdown table ?
How can I document parameters properly ?
Thank you
opened 10:38AM - 05 Nov 19 UTC
closed 12:20AM - 08 Feb 20 UTC
feature
product/documentation
**Is your feature request related to a problem? Please describe.**
When documen… ting a request, there is no way of stating whether a request param is optional or required other than specifying that in the description.
Validating all the required params for the specific request are filled in would also be very helpful with a warning when trying to send the request without the required values.
**Describe the solution you'd like**
Either use the checkboxes next to the request params to identify whether a parameter is optional or required or have another designated check box that would also allow you to validate those params have values before being able to send the request.
**Describe alternatives you've considered**
In Swagger docs, you are able to specify when a request param is required.
**Additional context**
Add any other context or screenshots about the feature request here.