Crib Enable: Add proper interface

2f634e9e · Cédric Le Ninivin · 15750e76 · 2f634e9e · 2f634e9e
Commit 2f634e9e authored Sep 24, 2020 by Cédric Le Ninivin
Hide whitespace changes
Inline Side-by-side

Showing with 39 additions and 1 deletion

crib-enable-interface.html crib-enable-interface.html +38 -0

crib-enable.html crib-enable.html +1 -1

No files found.
--- a/crib-enable-interface.html
+++ b/crib-enable-interface.html
+<!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
--- a/crib-enable.html
+++ b/crib-enable.html
@@ -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="lib/rsvp.js" type="text/javascript"></script>