-
Notifications
You must be signed in to change notification settings - Fork 839
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
FR: Ability to have Required or Optional request parameters #2847
Comments
I would love this as well |
I would love to have this too. Discriminating between optional and required is a must when writing documentation. |
I'm surprised that this doesn't exists. |
You can use parameter level descriptions to indicate whether they are required or optional in the docs. You can also use request level descriptions to document other metadata. |
@a85 This what I do at the moment and if I feel like something is too confusing I'm saving another example request with appropriate description. I would be nice if they can provide an article or document to guide us on how to better use their app in such cases. |
Agreed. Working on making this better along with documentation and best practices. Will update the thread when we have something new. :) |
+1 for this ask, please. |
+1 |
The biggest issue that is disabled params dont show up in the Documentation, and if you enable all of the params you have docs that look like complete junk. At the very least, lets show the disabled params in the documentation |
Same issue here, we have optional params that we would like to appear in the documentation but not have included by default in the "Example Request” or in the Url |
I like this idea and might be an easy way to denote a required param and an optional one. If a param is "disabled" it doesn't show in the example query string but would be in the param table of the generated documentation. |
+1 |
1 similar comment
+1 |
I just noticed another reason for having optional/required. If you export your postman collection and then import it into something openapi-ish, such as apimatic, it marks all the params as required. |
+1 |
Would be good to have this. |
+1 |
1 similar comment
+1 |
+10086 |
+1 |
+1 in 2019 :) |
+1 |
4 similar comments
+1 |
+1 |
+1 |
+1 |
😕Does the postman team not think that this is important? It's been nearly 2 years since this issue was opened |
Ayn news? My enterprise is about to release some new products and will only purchase the postman enterprise if the documentation can show the request properties without append then to the url, it's so simple.. Required/Optional it's just a way to do that |
So basically I made a script for my company that populates some datas in the Postman collection. I'll try to make it available quickly, as I'm working to release a skeleton project for our API architecture (AWS Lambda + API Gateway + OpenAPI 3.0 + Postman). I'm working on the Docker for local development as it is a priority for now, and I'll be updating you with the skeleton here ASAP. The only solution I found for required fields right now is to insert them in the
This is only a quick example, supporting nested objects description would be really nice too ! |
+1 |
1 similar comment
+1 |
Please avoid "me too" or "+1" comments. Instead, use a thumbs up reaction on enhancement requests. Maintainers will often prioritize work based on the number of thumbs on an issue. |
Hi Postman! It's really bad that you don't have this feature. (And examples reordering, people asking for that from 2015). The new API module is a good idea, but I can't use it, I don't know why should I use it. Params Examples, required / optional params, response format, enum, custom schemas, and other Openapi specs are just ignored by the postman, and not showing in documentation or requests. All the things, that I need to be transferred from Openapi spec to beautiful API documentation just missed. First of all, I need good documentation for my API. I expect there to be an example of params, Look at your own API best example Imgur. They need to write all the things manually. As a result, I open it with Postman and see NOTHING! Because of all the things described in Markdown. Is it ok, that I get absolutely empty Postman-request set of Imgur or Travefy collections when I open it? I can't see response formats, params, their types, and my "source of truth" is Markdowns in descriptions. Postman is a great project, but please, add some absolutely basic stuff instead of new beta features to your project and it will be perfect. |
+1 |
Glad I came across this page. I assumed I was missing something. |
Big +1 . Would be super helpful. |
+1 |
Nothing yet? Forced to use schemas just for something simple but as important as optional/required parameters in JSON data? |
Yes, we are still waiting ;) |
This is implemented or Still OPEN from 2017? |
Does adding a +1 help here? |
Hey everyone, This is only the first step and we have further improvements planned. Request everyone to give the feature a spin and share your thoughts and feedback. Please highlight and explain which of your use cases are not solved and we will try to address them. |
+1 2023 |
@Raja-Simha - This feature is still not available when posting your API documentation as documentation and not as a Workspace. |
I'd like this! |
+1 I would like that very much too. |
+1 |
1 similar comment
+1 |
+1 2024 |
+1 |
Hi All, We're actively working on this issue and would like to understand your workflow better to design the right solution. If you want to discuss this, please drop me a note at shashank.awasthi@postman.com or set up a call with me using this link. @YouMixx @dave4jr @the-white-cat @helderrscorreia @martinezpl @elizatlawy |
This is similar to #1155, but I thought it'd be worth expanding on the idea.
Many APIs have request parameters that are optional or required. It would be very beneficial to be able to mark these in such a way that the request won't be sent if the param is required and not provided.
Additionally, if a param is optional, is using a variable, and isn't provided, it could be removed.
Normally, I would handle these via the
request.data
object in a pre-request script, but unfortunately that object is read-only. This also makes it difficult to use variables since if an environment variable isn't provided the actual{{}}
syntax is sent instead of a blank string unless I manually clear out the variable.I'm still fairly new to Postman, so I could be missing something.
Let me know if you have any questions, and please keep up the great work on Postman!
The text was updated successfully, but these errors were encountered: