Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    text
    copied!<p>I defined a <a href="https://github.com/tavis-software/Status" rel="nofollow">media type</a> to address this issue. Here is a copy of the readme..</p> <hr> <p>A status document might look like:</p> <pre><code>&lt;status state="busy" progress="2/75" message="This is a message"/&gt; </code></pre> <p>It consists of a root node named status and has the properties: state, progress and message. </p> <p>Only the state property is required, and should be one of the following values : <code>{waiting, busy, warning, error, ok, cancelled}</code></p> <p>The progress property is a fraction that can be optionally used to indicate to a user how much longer we expect the resource to remain in a particular state.</p> <p>The message property is a human readable string intended to qualify the resource state.</p> <p>Additional information can be provided by embedding links within the status node.</p> <pre><code>&lt;status state="ok" message="Finshed generating report"&gt; &lt;link rel="related" href="http://example.org/report/99/output"/&gt; &lt;/status&gt; </code></pre> <p>the JSON equivalent of this would be</p> <pre><code>{ "status" : { "state" : "ok", "message" : "Finished generating report", "links" : { "related" : { "href" : "http://example.org/report/99/output"} } } } </code></pre> <p>The syntax of the links object in the JSON format follows the convention of HAL except that there is no leading underscore for the links object. The underscore is unncessary as this media type does encourage embedding arbitrary additional content, therefore no naming conflicts should occur. </p> <p>The specification does not prohibit extensions to the content, however it defines no rules for extensions beyond the constraints of the underlying JSON/XML format. </p> <p><strong>Media Type Identifiers</strong></p> <p>The intent is to submit this specifcation as a proposal to IANA for registration using the following identifiers:</p> <ul> <li>application/status+xml</li> <li>application/status+json</li> </ul>
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload