Permalink
Browse files

Merge branch 'master' of github.com:appdotnet/api-spec

  • Loading branch information...
2 parents 90a09c0 + 1098148 commit 422ce12aebc11d2709746138bc1405d1280ca729 @berg berg committed Aug 21, 2012
Showing with 21 additions and 12 deletions.
  1. +5 −1 auth.md
  2. +7 −2 objects.md
  3. +2 −2 resources/posts.md
  4. +7 −7 resources/users.md
View
@@ -10,7 +10,7 @@ Once you have signed up as a developer, you will be able to create an app from t
Once you have created an application, you will be assigned a **client ID** and **client secret**. You will use these in the authenticaion flow. The client ID may be publicly shared (e.g., included in a compiled binary or in the source code of a web page), but the client secret **must** be kept confidential.
-You authenticate to our API by use of an **access token**. There are two types of access tokens—client tokens and user tokens. **Client tokens** represent access to API resources on behalf of the application and **user tokens** represent access to API resources on behalf of a specific user.
+You authenticate to our API by use of an **access token**. There are two types of access tokens—client tokens and user tokens. **Client tokens** represent access to API resources on behalf of the application and **user tokens** represent access to API resources on behalf of a specific user. **Client tokens** are not enabled yet.
It should go without saying, but for the sake of user privacy and security, please ensure that your App.net account has a **strong password**.
@@ -42,6 +42,8 @@ You must keep your client_secret confidential. That means that you may not inclu
> To avoid cross-site scripting attacks, we also support the **state** paramater. If you include a state parameter, we will append it to the query parameters when redirecting the user to your **Redirection URI**.
+ > To comply with Apple's App Store Guidelines, you can add the query string parameter ```adnview=appstore``` to hide all signup links on the authentication pages.
+
We'll request that the user log in to App.net and show them a permissions dialog allowing them to choose whether to authorize your application.
1. If the user decides to authorize your application, they will be redirected to:
@@ -85,6 +87,8 @@ If you're building a client-side Javascript app or a mobile app that doesn't hav
> To avoid cross-site scripting attacks, we also support the **state** paramater. If you include a state parameter, we will append it to the query parameters when redirecting the user to your **Redirection URI**.
+ > To comply with Apple's App Store Guidelines, you can add the query string parameter ```adnview=appstore``` to hide all signup links on the authentication pages.
+
We'll request that the user log in to App.net and show them a permissions dialog allowing them to choose whether to authorize your application.
1. If the user decides to authorize your application, they will be redirected to:
View
@@ -196,6 +196,10 @@ A user is the central object utilized by the App.net Stream API. They have usern
</tr>
</table>
+#### Deprecations
+
+* ```is_following```, ```is_follower```, and ```is_muted``` have all been deprecated and replaced with ```follows_you```, ```you_follow```, and ```you_muted```. These keys should not be used and will be removed from the User object soon.
+
### Images
Images are objects so that app developers can more easily pick the appropriated sized image for different contexts.
@@ -348,8 +352,9 @@ A Post is the other central object utilized by the App.net Stream API. It has ri
</tr>
</table>
-* TODOs
- * Reply model
+#### Deprecations
+
+* ```deleted``` has been deprecated and replaced with ```is_deleted```. This key should not be used and will be removed from the Post object soon.
### Post Annotations
Post annotations are attributes (key, value pairs) that describe the entire post. There will be globally defined annotation formats (like geo above) but each application can also define annotations in their own namespace (like the Rdio song).
View
@@ -414,7 +414,7 @@ Get the most recent <a href="/appdotnet/api-spec/blob/master/objects.md#post">Po
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The user id. If the user id is <code>me</code> the current authenticated user will be used.</td>
+ <td>The user id. If the user id is <code>me</code> the current authenticated user will be used. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>
@@ -493,7 +493,7 @@ Get the most recent <a href="/appdotnet/api-spec/blob/master/objects.md#post">Po
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The user id. If the user id is <code>me</code> the current authenticated user will be used.</td>
+ <td>The user id. If the user id is <code>me</code> the current authenticated user will be used. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>
View
@@ -23,7 +23,7 @@ Returns a specific <a href="/appdotnet/api-spec/blob/master/objects.md#user">Use
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The user id. If the user id is <code>me</code> the current authenticated user will be used.</td>
+ <td>The user id. If the user id is <code>me</code> the current authenticated user will be used. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>
@@ -115,7 +115,7 @@ Returns the <a href="/appdotnet/api-spec/blob/master/objects.md#user">User</a> o
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The user id to be followed.</td>
+ <td>The user id to be followed. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>
@@ -209,7 +209,7 @@ Returns the <a href="/appdotnet/api-spec/blob/master/objects.md#user">User</a> o
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The user id to stop following.</td>
+ <td>The user id to stop following. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>
@@ -298,7 +298,7 @@ Returns an array of <a href="/appdotnet/api-spec/blob/master/objects.md#user">Us
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The user id. If the user id is <code>me</code> the current authenticated user will be used.</td>
+ <td>The user id. If the user id is <code>me</code> the current authenticated user will be used. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>
@@ -389,7 +389,7 @@ Returns an array of <a href="/appdotnet/api-spec/blob/master/objects.md#user">Us
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The user id. If the user id is <code>me</code> the current authenticated user will be used.</td>
+ <td>The user id. If the user id is <code>me</code> the current authenticated user will be used. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>
@@ -484,7 +484,7 @@ Hide all posts for a User in all streams. *Note: if you still explicitly request
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The id of the User to mute.</td>
+ <td>The id of the User to mute. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>
@@ -578,7 +578,7 @@ Stop hiding all posts for a given user.
<td><code>user_id</code></td>
<td>Required</td>
<td>string</td>
- <td>The id of the User to unmute.</td>
+ <td>The id of the User to unmute. You can also specify <code>@username</code> as a <code>user_id</code>.</td>
</tr>
</tbody>
</table>

0 comments on commit 422ce12

Please sign in to comment.