Skip to content
This repository has been archived by the owner on Feb 21, 2023. It is now read-only.

Commit

Permalink
added user.id to all examples showing users.
Browse files Browse the repository at this point in the history
  • Loading branch information
@leihog
leihog committed Oct 8, 2013
1 parent 27804aa commit 1df113a
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 4 deletions.
6 changes: 6 additions & 0 deletions api/resources/flattrs/index.html
View file
Expand Up @@ -100,13 +100,15 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/gnuproject&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/user/gnuproject&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;7voY9V&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;gnuproject&quot;</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">&quot;owner&quot;</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/qzio&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/user/qzio&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;bWeerl&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;qzio&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;created_at&quot;</span><span class="o">:</span> <span class="mi">1316697578</span>
Expand Down Expand Up @@ -151,13 +153,15 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/gnuproject&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/user/gnuproject&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;7voY9V&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;gnuproject&quot;</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">&quot;owner&quot;</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/qzio&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/user/qzio&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;bWeerl&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;qzio&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;created_at&quot;</span><span class="o">:</span> <span class="mi">1316697578</span>
Expand Down Expand Up @@ -200,13 +204,15 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/gnuproject&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/user/gnuproject&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;7voY9V&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;gnuproject&quot;</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">&quot;owner&quot;</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/qzio&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/user/qzio&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;bWeerl&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;qzio&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;created_at&quot;</span><span class="o">:</span> <span class="mi">1316697578</span>
Expand Down
1 change: 1 addition & 0 deletions api/resources/subscriptions/index.html
View file
Expand Up @@ -88,6 +88,7 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
Expand Down
8 changes: 8 additions & 0 deletions api/resources/things/index.html
View file
Expand Up @@ -129,6 +129,7 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
Expand Down Expand Up @@ -180,6 +181,7 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
Expand Down Expand Up @@ -226,6 +228,7 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
Expand Down Expand Up @@ -264,6 +267,7 @@ <h5 >Example response when resource owner don&#39;t own the thing</h5>
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
Expand Down Expand Up @@ -300,6 +304,7 @@ <h5 >Example response when resource owner owns the thing</h5>
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
Expand Down Expand Up @@ -346,6 +351,7 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
Expand All @@ -370,6 +376,7 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.dev/rest/v2/users/smgt&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.dev/profile/smgt&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;l8ENA7&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;smgt&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
Expand Down Expand Up @@ -633,6 +640,7 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span>
<span class="p">},</span>
<span class="s2">&quot;hidden&quot;</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span>
Expand Down
8 changes: 4 additions & 4 deletions api/resources/users/index.html
View file
Expand Up @@ -83,10 +83,10 @@ <h4 id="the-mini-user-object">The Mini User object</h4>
<p><table>
<thead><tr><th>Field</th><th>Type</th><th>Permission</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="mono">id</td><td class="mono">string</td><td></td><td>A unique identifier.</td></tr>
<tr><td class="mono">type</td><td class="mono">string</td><td></td><td>Object type, set to <code>user</code>.</td></tr>
<tr><td class="mono">resource</td><td class="mono">string</td><td></td><td>URL to the API resource</td></tr>
<tr><td class="mono">link</td><td class="mono">string</td><td></td><td>URL to user on Flattr.com website</td></tr>
<tr><td class="mono">id</td><td class="mono">string</td><td></td><td>A unique identifier.</td></tr>
<tr><td class="mono">username</td><td class="mono">string</td><td></td><td>Username on Flattr</td></tr>
</tbody></table></p>
<h4 id="get-a-user">Get a user</h4><h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2/users/:username
Expand All @@ -99,10 +99,10 @@ <h4 id="get-a-user">Get a user</h4><h5 >Request</h5><pre class="highlight"><code
X-RateLimit-Reset: 1342521939</code></pre>

<div class="highlight"><pre><span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;6lGWjl&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span><span class="p">,</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;firstname&quot;</span><span class="o">:</span> <span class="s2">&quot;Flattr.com&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastname&quot;</span><span class="o">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
Expand Down Expand Up @@ -131,10 +131,10 @@ <h5 >Request</h5><pre class="highlight"><code>GET https://api.flattr.com/rest/v2
X-RateLimit-Reset: 1342521939</code></pre>

<div class="highlight"><pre><span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;6lGWjl&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span><span class="p">,</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;firstname&quot;</span><span class="o">:</span> <span class="s2">&quot;Flattr.com&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastname&quot;</span><span class="o">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
Expand All @@ -160,10 +160,10 @@ <h5 >Response with scope <code>extendedread</code></h5>
X-RateLimit-Reset: 1342521939</code></pre>

<div class="highlight"><pre><span class="p">{</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;6lGWjl&quot;</span><span class="p">,</span>
<span class="s2">&quot;type&quot;</span><span class="o">:</span> <span class="s2">&quot;user&quot;</span><span class="p">,</span>
<span class="s2">&quot;resource&quot;</span><span class="o">:</span> <span class="s2">&quot;https://api.flattr.com/rest/v2/users/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;link&quot;</span><span class="o">:</span> <span class="s2">&quot;https://flattr.com/profile/flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="o">:</span> <span class="s2">&quot;3bpQBK&quot;</span><span class="p">,</span>
<span class="s2">&quot;username&quot;</span><span class="o">:</span> <span class="s2">&quot;flattr&quot;</span><span class="p">,</span>
<span class="s2">&quot;firstname&quot;</span><span class="o">:</span> <span class="s2">&quot;Flattr.com&quot;</span><span class="p">,</span>
<span class="s2">&quot;lastname&quot;</span><span class="o">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
Expand Down

0 comments on commit 1df113a

Please sign in to comment.