Commit 9bd914cd authored by Cédric Le Ninivin's avatar Cédric Le Ninivin

Crib Enable: Add proper interface

parent 9ee89bcb
<!DOCTYPE html>
<html>
<head>
<title>Crib Enable Interface</title>
</head>
<body>
<h1>Crib Enable Interface</h1>
<h3>Interface Needed to edit with CribJS</h3>
<dl>
<dt>get</dt>
<dd>Return a data url. Cannot return a blob as the data is transmitted through an iFrame</dd>
<dl>
<dt data-parameter-required="required" data-parameter-type="string">url</dt>
<dd>url of the document to retrieve</dd>
</dl>
<dt>put</dt>
<dd>Return a data url. Cannot provide a blob as the data is transmitted through an iFrame</dd>
<dl>
<dt data-parameter-required="required" data-parameter-type="string">url</dt>
<dd>url of the document to update</dd>
<dt data-parameter-required="required" data-parameter-type="data-uri">parameter</dt>
<dd>data url of the document to put, it will be transformed in a blob</dd>
</dl>
<dt>allDocs</dt>
<dd>return the list of document in the cache</dd>
<dl>
<dt data-parameter-required="optional" data-parameter-type="object">option_dict</dt>
<dd>XXX Not Taken into account at the moment</dd>
</dl>
<dt>remove</dt>
<dd>Remove an url from the cache</dd>
<dl>
<dt data-parameter-required="required" data-parameter-type="string">url</dt>
<dd>url of the document to update</dd>
</dl>
</dl>
</body>
</html>
\ No newline at end of file
......@@ -3,8 +3,8 @@
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width" />
<link rel="http://www.renderjs.org/rel/interface" href="crib-enable-interface.html">
<title>Jio Gadget</title>
<link rel="http://www.renderjs.org/rel/interface" href="interface_jio.html">
<!-- renderjs -->
<script src="rsvp.js" type="text/javascript"></script>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment