Re: JSON Output Documentation

2023-05-03 Thread Tim Culverhouse
On Wed May 3, 2023 at 2:35 PM CDT, David Bremner wrote:
> > We have had some discussions on the pros and cons of more publically
> > documenting this interface, but for now you can find the documentation
> > in the source, in devel/schemata.
>
> See attached.

Perfect! Thanks!

-- 
Tim


signature.asc
Description: PGP signature
___
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-le...@notmuchmail.org


Re: JSON Output Documentation

2023-05-03 Thread David Bremner
David Bremner  writes:

> "Tim Culverhouse"  writes:
>
>> Hey everyone -
>>
>> I've scoured the manpages and website for some documentation on the JSON
>> output format, but haven't found what I'm looking for. For the most
>> part, the commands are easy to figure out, but `notmuch show` has me
>> confused on the array nesting. Does anyone know if there is
>> documentation on this structure?
>>
>> It seems to be something like:
>>
>> [ (Array of results)
>>   [ (Array of thread)
>> [  (Another array of thread?)
>>   {Thread parent object},
>>   [ (array of thread children objects)]
>> ]
>>   ]
>> ]
>
> We have had some discussions on the pros and cons of more publically
> documenting this interface, but for now you can find the documentation
> in the source, in devel/schemata.

See attached.



schemata
Description: Binary data
___
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-le...@notmuchmail.org


Re: JSON Output Documentation

2023-05-03 Thread David Bremner
"Tim Culverhouse"  writes:

> Hey everyone -
>
> I've scoured the manpages and website for some documentation on the JSON
> output format, but haven't found what I'm looking for. For the most
> part, the commands are easy to figure out, but `notmuch show` has me
> confused on the array nesting. Does anyone know if there is
> documentation on this structure?
>
> It seems to be something like:
>
> [ (Array of results)
>   [ (Array of thread)
> [  (Another array of thread?)
>   {Thread parent object},
>   [ (array of thread children objects)]
> ]
>   ]
> ]

We have had some discussions on the pros and cons of more publically
documenting this interface, but for now you can find the documentation
in the source, in devel/schemata.

At this point I'm open to people who either want to convert that
document to rst and integrate it with the published docs, or convince me
it's a bad idea. I think the idea was that we wanted to avoid commiting
to that interface, but since we already version it like a C library, I'm
a bit fuzzy on why that's a problem.

d
___
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-le...@notmuchmail.org


JSON Output Documentation

2023-05-03 Thread Tim Culverhouse
Hey everyone -

I've scoured the manpages and website for some documentation on the JSON
output format, but haven't found what I'm looking for. For the most
part, the commands are easy to figure out, but `notmuch show` has me
confused on the array nesting. Does anyone know if there is
documentation on this structure?

It seems to be something like:

[ (Array of results)
  [ (Array of thread)
[  (Another array of thread?)
  {Thread parent object},
  [ (array of thread children objects)]
]
  ]
]

I just can't figure out why there are two arrays wrapping the thread?

Thanks!

-- 
Tim


signature.asc
Description: PGP signature
___
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-le...@notmuchmail.org