Managing comments within a jsonfile

Helpdesk + feature requests
1

Hi All,
As we may handle a collection of requests, we have to keep comprehensive documentation about each json request…
Yes the name of json file can be part of the documentation…
My question is: Does the astro-colibri request language provide Dummy structures that could be used by users to comment their equests?

" The primary reason why JSON does not support comments is that its creator, Douglas Crockford, deliberately removed them from the format to prevent misuse and keep it as a pure data-only format."

2

Dear @jean.paul.astro,

we do not provide a dedicated structure for comments in the search requests. But I believe you can simply add additional fields that are not part of the filter structure to the JSON content. These will simply be ignored by the parsing in our API…
Is this sufficient for your documentation purpose?

3

Hi all,
Sorry for this late answer…
I added something like “comment”: “this a test for comment”
and it worked…
Should be sufficient for our needs…
Thanks!

1 Like