Permalink
Browse files

allow comments in api docs

  • Loading branch information...
1 parent 05ce291 commit 10fc44a5f81e5ccf17e0c037e4b38ab1b3198691 @steffentchr steffentchr committed with steffentchr Mar 9, 2010
View
@@ -1,4 +1,5 @@
# Documentation for 23's Visualplatform API
+# flags=comments
* [The actual API documentation](http://community.23video.com/api/)
* [API documentation and samples on Github](http://github.com/23/DeveloperDocumentation)
View
@@ -1,4 +1,5 @@
# API METHOD: /api/album/create
+# flags=comments
Create a new album or channel.
View
@@ -1,4 +1,5 @@
# API Method: /api/album/delete
+# flags=comments
Delete an album or channel.
View
@@ -1,4 +1,5 @@
# API Method: /api/album/list
+# flags=comments
Get a list of albums or channels.
View
@@ -1,4 +1,5 @@
# API Method: /api/album/update
+# flags=comments
Update the meta data for a channels
View
@@ -1,4 +1,5 @@
# API: Browser-based uploads
+# flags=comments
Browser-based uploading consists of two API methods:
View
@@ -1,4 +1,5 @@
# API Method: /api/comment/list
+# flags=comments
Get a list of comments.
View
@@ -1,4 +1,5 @@
# API Method: /api/echo
+# flags=comments
Echo service which allows implementers to test authentication details and the connection to the API server.
View
@@ -1,4 +1,5 @@
# API: Error codes and descriptions
+# flags=comments
Whenever a request to the API fails, a response detailing the exception is returned. The response includes an error code and a detailed description of the error.
View
@@ -1,4 +1,5 @@
# The 23 API
+# flags=comments
This document describes the REST API for Visualplatform, [23 Video](http://www.23video.com) and [Visualblog](http://www.visualblog.net). Please note that access to the API depends on your product and subscription -- and that it may not be available to you. [Contact us](#any-questions) if you have questions in this regard.
View
@@ -1,4 +1,5 @@
# OAuth and the 23 API
+# flags=comments
[OAuth](http://oauth.net) is a secure, open protocol, which specifies a standard way to access protected data on different websites. Roughly, the protocol outlines 1) a method for letting users grant an application access to a web service API, and 2) how to communicate using these credentials.
@@ -248,8 +249,6 @@ We've created a set of samples on how to authenticate your application and commu
* [Python samples](http://github.com/23/DeveloperDocumentation/tree/master/lib/python/)
* [Ruby samples](http://github.com/23/DeveloperDocumentation/tree/master/lib/ruby/)
----
-
<script>createIndex('OAuth Flow', 'h2');</script>
View
@@ -1,4 +1,5 @@
# API Method: /api/photo/delete
+# flags=comments
Delete a photo or video.
@@ -1,4 +1,5 @@
# API Method: /api/photo/get-upload-token
+# flags=comments
Pre-authenticate an upload, allowing your client to upload directly to 23's servers from a web browser.
View
@@ -1,4 +1,5 @@
# API Method: /api/photo/list
+# flags=comments
Return a list of photos or videos.
@@ -1,4 +1,5 @@
# API Method: /api/photo/redeem-upload-token
+# flags=comments
Upload a photo or video using a [pre-authenticated upload token](photo-get-upload-token).
View
@@ -1,4 +1,5 @@
# API Method: /api/photo/replace
+# flags=comments
Replace a photo or update the thumbnail of a video.
View
@@ -1,4 +1,5 @@
# API Method: /api/photo/update
+# flags=comments
Update the meta data -- including title, description, tags, channel/album and publish status -- of a photo or video.
View
@@ -1,4 +1,5 @@
# API Method: /api/photo/upload
+# flags=comments
Upload a new file to the site.
View
@@ -1,4 +1,5 @@
# API Method: /api/session/get-token
+# flags=comments
Get a session access token, which can in turn be used to sign a user's session using [/api/session/redeem-token](session-redeem-token). The return must be used within 15 minutes.
View
@@ -1,4 +1,5 @@
# API Method: /api/session/redeem-token
+# flags=comments
Grant access to a site using a [pre-authenticated session access token](session-get-token).
View
@@ -1,4 +1,5 @@
# API Method: /api/site/get
+# flags=comments
Get information about the current site.
View
@@ -1,4 +1,5 @@
# API Method: /api/tag/list
+# flags=comments
Get a list of tags.
View
@@ -1,4 +1,5 @@
# API Method: /api/tag/related
+# flags=comments
Get a list of related tags.
View
@@ -1,4 +1,5 @@
# API Method: /api/user/create
+# flags=comments
Set up a new user in the site.
View
@@ -1,4 +1,5 @@
# API Method: /api/user/get-login-token
+# flags=comments
Get a login token, which can in turn be used to log a user in to your site. The token is valid for 15 minutes.
View
@@ -1,4 +1,5 @@
# API Method: /api/user/get
+# flags=comments
Get information about an existing user.
View
@@ -1,4 +1,5 @@
# API Method: /api/user/list
+# flags=comments
Get a list of users
@@ -1,4 +1,5 @@
# API Method: /api/user/redeem-login-token
+# flags=comments
Log in a user using a [pre-authenticated user login token](user-get-login-token).

0 comments on commit 10fc44a

Please sign in to comment.