[Feature request] Allow comments in JSON body

See original GitHub issue

The body of requests often contain IDs which may be hard to distinguish between. Being able to append a comment with a description to a row would often be of practical value.

Example:

{
  "command": "refresh",
  "user_ids": [
    9842509438, // username steve74
    4581013095, // username nyancat
    609582939   // username wegetitnow
  ]
}

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Reactions:16
  • Comments:16 (4 by maintainers)

github_iconTop GitHub Comments

26reactions
gschiercommented, Dec 5, 2017

You can use Nunjucks (the template language Insomnia uses) comments for this.

{
  "command": "refresh",
  "userIds": [
    9842509438, {# username steve74 #}
    4581013095, {# username nyancat #}
    609582939   {# username wegetitnow #}
  ]
}
21reactions
gschiercommented, Dec 5, 2017

Don’t worry. It’s not really documented anywhere. Hopefully other people will find this issue, though 👍 😄

Read more comments on GitHub >

github_iconTop Results From Across the Web

Can comments be used in JSON? - Stack Overflow
No. JSON is data-only. If you include a comment, then it must be data too. You could have a designated data element called...
Read more >
Request body should be able to be commented - Help
I think it's easier if request body can be commented. ... JSON, the format used, does not allow comments.
Read more >
How can I add comments in JSON? - O'Reilly
The first option presented is an external tool, JSMin. By stripping the code before publishing for production, comments are removed with the ...
Read more >
REST API - Defining a Comment in the Request Body
How to define a comment in the request body using the Blueprint REST API. ... </Comment>. Here is an example of a request...
Read more >
Add comments to JSON body in Postman - YouTube
It is not possible to add comments to the JSON body directly, but there is an indirect way to do this in Postman....
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found