I have spent hours adding some response documentation for requests in a collection. After creating quite a few requests with very large response bodies in JSON I have found that going back to the documentation shows that my changes are not being saved. I have lost a lot of time on this issue. The general steps I have been following:
- Create a new request and configure the parameters, url, body, etc.
- Go to the Documentation tab and put in a description.
- Save the request.
- Now use VSCode to create the formatted JSON body of the response that I expect. (It’s easier than using Postman)
- Go back to the documentation section of the request and start the code block.
- Select JSON as the language.
- Paste in the JSON from VSCode.
- Close the documentation .
- Open the documentation back up and notice it didn’t save it.
- Repeat the process of adding the JSON response sample.
- This time click outside the code block after pasting.
- Now close the documentation tab.
- Open and it generally has saved it but I cannot confirm that it does in all cases.
