Add docs for indexes.list

arduino · matteosuppo · Apr 3, 2019 · Jan 17, 2019 · Jan 17, 2019 · Jan 17, 2019
commit 350d921e949bb2031b61ea8c7221659805570653
diff --git a/design/docs.go b/design/docs.go
@@ -0,0 +1,10 @@
+package design
+
+import . "goa.design/goa/dsl"
+
+var _ = Service("docs", func() {
+	HTTP(func() {
+		Path("/docs")
+	})
+	Files("/pkgs", "docs/pkgs.html")
+})
diff --git a/docs/pkgs.html b/docs/pkgs.html
@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+    <title>Interactive docs for pkgs api</title>
+</head>
+
+<body>
+    <p>pkgs api manage the indexes and tools installed on the system.</p>
+
+    <p>An index file contains the info about a core and its tools. You can see an example at <a href="" target="_blank">https://downloads.arduino.cc/packages/package_index.json</a></p>
+
+    <p>index files are saved (with an urlencoded filename) in the folder ~/.arduino-create/indexes</p>
+
+    <textarea cols="100" id="indexesGet">
+fetch('http://localhost:8991/v2/pkgs/indexes')
+    </textarea><br>
+    <textarea cols="100" rows="10" id="indexesGetRes">
+
+    </textarea><br>
+    <button onclick="tryCode('indexesGet', 'indexesGetRes');">Try</button>
+</body>
+
+<script>
+function tryCode(code, target) {
+    code = document.getElementById(code).textContent;
+    target = document.getElementById(target);
+
+    var result = eval(code);
+    result.then(function (res) {
+        target.innerHTML = res.statusText + "\n";
+        return res.json();
+    }).then(function (body) {
+        debugger
+        target.innerHTML = target.innerHTML + JSON.stringify(body, " ", "  ");
+        return;
+    })
+    .catch(function (err) {
+
+        console.log(err)
+
+        target.innerText = JSON.stringify(err);
+    })
+
+    console.debug(code, target, result)
+}
+</script>
+
+</html>
diff --git a/gen/docs/client.go b/gen/docs/client.go
diff --git a/gen/docs/endpoints.go b/gen/docs/endpoints.go
diff --git a/gen/docs/service.go b/gen/docs/service.go
diff --git a/gen/http/docs/client/client.go b/gen/http/docs/client/client.go
diff --git a/gen/http/docs/client/encode_decode.go b/gen/http/docs/client/encode_decode.go
diff --git a/gen/http/docs/client/paths.go b/gen/http/docs/client/paths.go
diff --git a/gen/http/docs/client/types.go b/gen/http/docs/client/types.go
diff --git a/gen/http/docs/server/encode_decode.go b/gen/http/docs/server/encode_decode.go
diff --git a/gen/http/docs/server/paths.go b/gen/http/docs/server/paths.go
diff --git a/gen/http/docs/server/server.go b/gen/http/docs/server/server.go
diff --git a/gen/http/docs/server/types.go b/gen/http/docs/server/types.go