aboutsummaryrefslogtreecommitdiffhomepage
path: root/devel/schemata
Commit message (Collapse)AuthorAge
* search: Add stable queries to thread search resultsGravatar Austin Clements2013-11-08
| | | | | | | | | | | | | | These queries will match exactly the set of messages currently in the thread, even if more messages later arrive. Two queries are provided: one for matched messages and one for unmatched messages. This can be used to fix race conditions with tagging threads from search results. While tagging based on a thread: query can affect messages that arrived after the search, tagging based on stable queries affects only the messages the user was shown in the search UI. Since we want clients to be able to depend on the presence of these queries, this ushers in schema version 2.
* schemata: Disambiguate non-terminal namesGravatar Austin Clements2013-11-08
| | | | | | | | Previously, the show schema and the search schema used different "thread" non-terminals. While these schemata don't interact, this is still confusing, so rename search's "thread" to "thread_summary". To further limit confusion, prefix all top-level search non-terminals now begin with "search_".
* show: indicate length, encoding of omitted body contentGravatar Peter Wang2012-12-17
| | | | | | | | | | | If a leaf part's body content is omitted, return the encoded length and transfer encoding in --format=json output. This information may be used by the consumer, e.g. to decide whether to download a large attachment over a slow link. Returning the _encoded_ content length is more efficient than returning the _decoded_ content length. Returning the transfer encoding allows the consumer to estimate the decoded content length.
* cli: Framework for structured output versioningGravatar Austin Clements2012-12-16
| | | | | | | | | | | | | | | | | | | | | Currently there is a period of pain whenever we make backward-incompatible changes to the structured output format, which discourages not only backward-incompatible improvements to the format, but also backwards-compatible additions that may not be "perfect". In the end, these problems limit experimentation and innovation. This series of patches introduces a way for CLI callers to request a specific format version on the command line and to determine if the CLI does not supported the requested version (and perhaps present a useful diagnostic to the user). Since the caller requests a format version, it's also possible for the CLI to support multiple incompatible versions simultaneously, unlike the alternate approach of including version information in the output. This patch lays the groundwork by introducing a versioning convention, standard exit codes, and a utility function to check the requested version and produce standardized diagnostic messages and exit statuses.
* Use the S-Expression structured printer in notmuch-show, notmuch-reply and ↵Gravatar Peter Feigl2012-12-08
| | | | | | | notmuch-search. This patch uses the new S-Expression printer in the notmuch CLI (show, search and reply). You can now use --format=sexp for any of them.
* Rename the -json printer functions in notmuch-reply and notmuch-show to ↵Gravatar Peter Feigl2012-12-08
| | | | | | | | | generic -sprinter functions. All the structured output functions in notmuch-reply and notmuch-show are renamed to a generic name (as they do not contain any json-specific code anyway). This patch is a preparation to actually using the new S-Expression sprinter in notmuch-reply and notmuch-show.
* devel: Add Reply-to to the schemataGravatar Austin Clements2012-11-08
| | | | The code got out of sync with the documentation in 7d3c06dc.
* schemata: update for --body=true|false optionGravatar Mark Walters2012-07-24
| | | | | | Previously body: was a compulsory field in a message. The new --body=false option causes notmuch show to omit this field so update schemata to reflect this.
* Add missing "tags" field to search schemaGravatar Austin Clements2012-07-09
| | | | | This field is output by search, but it didn't make it into the documentation.
* Minor correction to devel/schemataGravatar Mark Walters2012-06-30
| | | | | | In id:"87sjdm12d1.fsf@awakening.csail.mit.edu" Austin pointed out that devel/schemata needs a slight correction with the new --entire-thread=false option. This is that correction.
* Update devel/schemata for --entire-thread=falseGravatar Mark Walters2012-06-29
| | | | Also remove the Json --entire-thread item from devel/TODO.
* Sync schemata with current code structureGravatar Austin Clements2012-04-15
| | | | | The schema itself hasn't changed, but many of the references to functions in notmuch-show.c were out of date.
* schemata: Add documentation for JSON reply format.Gravatar Adam Wolfe Gordon2012-03-19
|
* Document the JSON schemata used by show and searchGravatar Austin Clements2012-02-27