Skip to content

Commit 350d921

Browse files
committed
Add docs for indexes.list
1 parent 5999fe2 commit 350d921

16 files changed

+315
-10
lines changed

design/docs.go

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
package design
2+
3+
import . "goa.design/goa/dsl"
4+
5+
var _ = Service("docs", func() {
6+
HTTP(func() {
7+
Path("/docs")
8+
})
9+
Files("/pkgs", "docs/pkgs.html")
10+
})

docs/pkgs.html

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
<head>
5+
<title>Interactive docs for pkgs api</title>
6+
</head>
7+
8+
<body>
9+
<p>pkgs api manage the indexes and tools installed on the system.</p>
10+
11+
<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>
12+
13+
<p>index files are saved (with an urlencoded filename) in the folder ~/.arduino-create/indexes</p>
14+
15+
<textarea cols="100" id="indexesGet">
16+
fetch('http://localhost:8991/v2/pkgs/indexes')
17+
</textarea><br>
18+
<textarea cols="100" rows="10" id="indexesGetRes">
19+
20+
</textarea><br>
21+
<button onclick="tryCode('indexesGet', 'indexesGetRes');">Try</button>
22+
</body>
23+
24+
<script>
25+
function tryCode(code, target) {
26+
code = document.getElementById(code).textContent;
27+
target = document.getElementById(target);
28+
29+
var result = eval(code);
30+
result.then(function (res) {
31+
target.innerHTML = res.statusText + "\n";
32+
return res.json();
33+
}).then(function (body) {
34+
debugger
35+
target.innerHTML = target.innerHTML + JSON.stringify(body, " ", " ");
36+
return;
37+
})
38+
.catch(function (err) {
39+
40+
console.log(err)
41+
42+
target.innerText = JSON.stringify(err);
43+
})
44+
45+
console.debug(code, target, result)
46+
}
47+
</script>
48+
49+
</html>

gen/docs/client.go

+21
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/docs/endpoints.go

+25
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/docs/service.go

+22
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/docs/client/client.go

+44
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/docs/client/encode_decode.go

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/docs/client/paths.go

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/docs/client/types.go

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/docs/server/encode_decode.go

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/docs/server/paths.go

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/docs/server/server.go

+73
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/http/docs/server/types.go

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)