forked from beakerbrowser/unwalled.garden
-
Notifications
You must be signed in to change notification settings - Fork 0
/
follows.html
132 lines (132 loc) · 4.59 KB
/
follows.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<!doctype html>
<html>
<head>
<title>Follows (unwalled.garden/follows) | Unwalled.Garden</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/assets/styles.css">
<link rel="stylesheet" href="/assets/syntax.css">
</head>
<body>
<h1><a href="/">Unwalled.Garden</a></h1>
<a class="nav-open"><img src="/assets/hamburger.svg"></a>
<div class="notice">Status: DRAFT. Part of the upcoming <a href="https://beakerbrowser.com">Beaker Browser</a> 0.9 release.</div>
<div class="page">
<nav>
<a class="nav-close"><img src="/assets/hamburger.svg"></a>
<ul>
<li>Docs
<ul>
<li><a href="/docs/how-does-it-work">How it works</a></li>
<li><a href="/docs/dat-primer">Dat protocol</a><ul>
<li><a href="/docs/metadata">Metadata</a></li>
<li><a href="/docs/mounts">Mounts</a></li>
</ul></li>
<li><a href="/docs/browser-integration">Browser integration</a></li>
<li><a href="/docs/common-fields">Common fields</a></li>
<li><a href="/docs/why-not-rdf">Why not RDF?</a></li>
</ul>
</li>
</ul>
<ul>
<li>APIs
<ul>
<li><a href="/docs/api/bookmarks">Bookmarks</a></li>
<li><a href="/docs/api/follows">Follows</a></li>
<li><a href="/docs/api/posts">Posts</a></li>
<li><a href="/docs/api/profiles">Profiles</a></li>
<li><a href="/docs/api/reactions">Reactions</a></li>
</ul>
</li>
</ul>
<ul>
<li>Schemas
<ul>
<li><a href="/bookmark">Bookmark</a></li>
<li><a href="/comment">Comment</a></li>
<li><a href="/follows">Follows</a></li>
<li><a href="/person">Person</a></li>
<li><a href="/post">Post</a></li>
<li><a href="/reaction">Reaction</a></li>
<li>dir<ul>
<li><a href="/dir/data">Data</a></li>
<li><a href="/dir/refs">Refs</a></li>
</ul></li>
</ul>
</li>
</ul>
<ul>
<li>Links
<ul>
<li><a href="https://github.com/beakerbrowser/unwalled.garden">Github Repo</a></li>
<li><a href="https://beakerbrowser.com">Beaker Browser</a></li>
<li><a href="https://dat.foundation">Dat protocol</a></li>
</ul>
</li>
</ul>
</nav>
<main><h2>Follows <code>unwalled.garden/follows</code></h2>
<hr>
<ul>
<li>File type</li>
<li><strong>Description</strong>: A list of data subscriptions.</li>
<li><strong>Path</strong>: <code>/.data/unwalled.garden/follows.json</code></li>
</ul>
<hr>
<h4>Notes</h4>
<p>Followed sites MUST not use DNS shortnames. They should be listed by their public key domain.</p>
<p>All followed sites MUST be mounted in the <a href="/dir/refs">refs directory</a> to enable quick metadata lookups.</p>
<h4>Metadata</h4>
<table>
<thead>
<tr>
<th>Key</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>type</code></td>
<td><code>unwalled.garden/follows</code></td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<pre><code class="language-json">{
<span class="hljs-attr">"urls"</span>: [<span class="hljs-string">"dat://43dfc9f23fdded8cc7c01c71c0702a0529130af0258e7fb30bf5a0a3f73d69b3"</span>]
}
</code></pre>
<h4>Schema</h4>
<pre><code class="language-json">{
<span class="hljs-attr">"$schema"</span>: <span class="hljs-string">"http://json-schema.org/draft-07/schema#"</span>,
<span class="hljs-attr">"$id"</span>: <span class="hljs-string">"dat://unwalled.garden/follows.json"</span>,
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"object"</span>,
<span class="hljs-attr">"title"</span>: <span class="hljs-string">"Follows"</span>,
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"A list of data subscriptions."</span>,
<span class="hljs-attr">"required"</span>: [
<span class="hljs-string">"urls"</span>
],
<span class="hljs-attr">"properties"</span>: {
<span class="hljs-attr">"urls"</span>: {
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"array"</span>,
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"The followed URLs"</span>,
<span class="hljs-attr">"items"</span>: {
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"format"</span>: <span class="hljs-string">"uri"</span>
}
}
}
}
</code></pre>
</main>
</div>
</body>
<script type="module" src="/assets/admin.js"></script>
<script>
document.querySelector('.nav-open').addEventListener('click', e => {
document.querySelector('nav').classList.add('show')
})
document.querySelector('.nav-close').addEventListener('click', e => {
document.querySelector('nav').classList.remove('show')
})
</script>
</html>