Skip to content

Commit

Permalink
Began working on documentation. Made Node.JS script to automatically …
Browse files Browse the repository at this point in the history 
…generate documentaion templates for each API plugin.
  • Loading branch information
@meltingice
meltingice committed Oct 22, 2010
1 parent bff675f commit 0a8ddb1
Show file tree
Hide file tree
Showing 20 changed files with 779 additions and 18 deletions.
147 changes: 147 additions & 0 deletions docs/api_def/flickr.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<?xml version="1.0" encoding="UTF-8"?>

<category name="blogs">
<endpoint name="getServices"></endpoint>
</category>

<category name="collections">
<endpoint name="getTree"></endpoint>
</category>

<category name="commons">
<endpoint name="getInstitutions"></endpoint>
</category>

<category name="contacts">
<endpoint name="getPublicList"></endpoint>
</category>

<category name="favorites">
<endpoint name="getPublicList"></endpoint>
</category>

<category name="galleries">
<endpoint name="getInfo"></endpoint>
<endpoint name="getList"></endpoint>
<endpoint name="getListForPhoto"></endpoint>
<endpoint name="getPhotos"></endpoint>
</category>

<category name="groups">
<endpoint name="getInfo"></endpoint>
<endpoint name="search"></endpoint>
<category name="pools">
<endpoint name="getContext"></endpoint>
<endpoint name="getPhotos"></endpoint>
</category>

</category>

<category name="interestingness">
<endpoint name="getList"></endpoint>
</category>

<category name="machinetags">
<endpoint name="getNamespaces"></endpoint>
<endpoint name="getPairs"></endpoint>
<endpoint name="getPredicates"></endpoint>
<endpoint name="getRecentValues"></endpoint>
<endpoint name="getValues"></endpoint>
</category>

<category name="panda">
<endpoint name="getList"></endpoint>
<endpoint name="getPhotos"></endpoint>
</category>

<category name="people">
<endpoint name="findByEmail"></endpoint>
<endpoint name="findByUsername"></endpoint>
<endpoint name="getInfo"></endpoint>
<endpoint name="getPhotosOf"></endpoint>
<endpoint name="getPublicGroups"></endpoint>
<endpoint name="getPublicPhotos"></endpoint>
</category>

<category name="photos">
<endpoint name="getAllContexts"></endpoint>
<endpoint name="getContactsPublicPhotos"></endpoint>
<endpoint name="getContext"></endpoint>
<endpoint name="getExif"></endpoint>
<endpoint name="getFavorites"></endpoint>
<endpoint name="getInfo"></endpoint>
<endpoint name="getRecent"></endpoint>
<endpoint name="getSizes"></endpoint>
<endpoint name="search"></endpoint>
<category name="comments">
<endpoint name="getList"></endpoint>
</category>

<category name="get">
<endpoint name="getLocation"></endpoint>
</category>

<category name="licenses">
<endpoint name="getInfo"></endpoint>
</category>

<category name="people">
<endpoint name="getList"></endpoint>
</category>

</category>

<category name="photosets">
<endpoint name="getContext"></endpoint>
<endpoint name="getInfo"></endpoint>
<endpoint name="getList"></endpoint>
<endpoint name="getPhotos"></endpoint>
<category name="comments">
<endpoint name="getList"></endpoint>
</category>

</category>

<category name="places">
<endpoint name="find"></endpoint>
<endpoint name="findByLatLon"></endpoint>
<endpoint name="getChildrenWithPhotosPublic"></endpoint>
<endpoint name="getInfo"></endpoint>
<endpoint name="getInfoByUrl"></endpoint>
<endpoint name="getPlaceTypes"></endpoint>
<endpoint name="getShapeHistory"></endpoint>
<endpoint name="getTopPlacesList"></endpoint>
<endpoint name="placesForBoundingBox"></endpoint>
<endpoint name="placesForTags"></endpoint>
<endpoint name="resolvePlaceId"></endpoint>
<endpoint name="tagsForPlace"></endpoint>
</category>

<category name="reflection">
<endpoint name="getMethodInfo"></endpoint>
<endpoint name="getMethods"></endpoint>
</category>

<category name="tags">
<endpoint name="getClusterPhotos"></endpoint>
<endpoint name="getClusters"></endpoint>
<endpoint name="getHotList"></endpoint>
<endpoint name="getListPhoto"></endpoint>
<endpoint name="getListUser"></endpoint>
<endpoint name="getListUserPopular"></endpoint>
<endpoint name="getListUserRaw"></endpoint>
<endpoint name="getRelated"></endpoint>
</category>

<category name="urls">
<endpoint name="getGroup"></endpoint>
<endpoint name="getUserPhotos"></endpoint>
<endpoint name="getUserProfile"></endpoint>
<endpoint name="lookupGallery"></endpoint>
<endpoint name="lookupGroup"></endpoint>
<endpoint name="lookupUser"></endpoint>
</category>

<category name="util">
<endpoint name="getPhotoUrl"></endpoint>
</category>
46 changes: 46 additions & 0 deletions docs/api_def/github.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8"?>

<category name="user">
<endpoint name="search"></endpoint>
<endpoint name="show"></endpoint>
<endpoint name="following"></endpoint>
<endpoint name="followers"></endpoint>
</category>

<category name="repos">
<endpoint name="watched"></endpoint>
<endpoint name="search"></endpoint>
<endpoint name="show"></endpoint>
<endpoint name="user"></endpoint>
<endpoint name="collaborators"></endpoint>
<endpoint name="contributors"></endpoint>
<endpoint name="watchers"></endpoint>
<endpoint name="network"></endpoint>
<endpoint name="languages"></endpoint>
<endpoint name="tags"></endpoint>
<endpoint name="branches"></endpoint>
</category>

<category name="issues">
<endpoint name="search"></endpoint>
<endpoint name="list"></endpoint>
<endpoint name="show"></endpoint>
<endpoint name="comments"></endpoint>
</category>

<category name="commits">
<endpoint name="list"></endpoint>
<endpoint name="file"></endpoint>
<endpoint name="show"></endpoint>
</category>

<category name="tree">
<endpoint name="show"></endpoint>
<endpoint name="blob"></endpoint>
<endpoint name="blobs"></endpoint>
</category>

<category name="gist">
<endpoint name="meta"></endpoint>
<endpoint name="gists"></endpoint>
</category>
45 changes: 45 additions & 0 deletions docs/api_def/plixi.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>

<category name="user">
<endpoint name="show"></endpoint>
<endpoint name="comments"></endpoint>
<endpoint name="friends"></endpoint>
<endpoint name="favorites"></endpoint>
<endpoint name="photos"></endpoint>
<category name="photo_iterator">
<endpoint name="next"></endpoint>
<endpoint name="previous"></endpoint>
</category>

<endpoint name="has_favorited"></endpoint>
<endpoint name="feed"></endpoint>
</category>

<category name="photo">
<endpoint name="show"></endpoint>
<endpoint name="comments"></endpoint>
<endpoint name="favorizers"></endpoint>
<endpoint name="tags"></endpoint>
<endpoint name="viewers"></endpoint>
<endpoint name="meta_from_url"></endpoint>
</category>

<category name="photos">
<category name="iterator">
<endpoint name="next"></endpoint>
<endpoint name="previous"></endpoint>
</category>

<endpoint name="by_location"></endpoint>
<endpoint name="by_venue"></endpoint>
<endpoint name="list"></endpoint>
<endpoint name="query_count"></endpoint>
</category>

<category name="leaderboard">
<endpoint name="viewed"></endpoint>
<endpoint name="commented"></endpoint>
<endpoint name="voted"></endpoint>
</category>

<endpoint name="socialfeed"></endpoint>
32 changes: 32 additions & 0 deletions docs/api_def/reddit.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>

<category name="front_page">
<endpoint name="hot"></endpoint>
<endpoint name="show_new"></endpoint>
<endpoint name="controversial"></endpoint>
<endpoint name="top"></endpoint>
</category>

<category name="subreddit">
<endpoint name="hot"></endpoint>
<endpoint name="show_new"></endpoint>
<endpoint name="controversial"></endpoint>
<endpoint name="top"></endpoint>
</category>

<endpoint name="r"></endpoint>
<category name="post">
<endpoint name="show"></endpoint>
</category>

<endpoint name="url"></endpoint>
<category name="user">
<endpoint name="overview"></endpoint>
<endpoint name="comments"></endpoint>
<endpoint name="submitted"></endpoint>
<endpoint name="liked"></endpoint>
<endpoint name="disliked"></endpoint>
<endpoint name="hidden"></endpoint>
</category>

<endpoint name="search"></endpoint>
5 changes: 5 additions & 0 deletions docs/api_def/tumblr.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>

<category name="posts">
<endpoint name="show"></endpoint>
</category>
37 changes: 37 additions & 0 deletions docs/api_def/twitpic.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>

<category name="media">
<endpoint name="show"></endpoint>
</category>

<category name="users">
<endpoint name="show"></endpoint>
</category>

<category name="comments">
<endpoint name="show"></endpoint>
</category>

<category name="place">
<endpoint name="show"></endpoint>
</category>

<category name="places">
<endpoint name="show"></endpoint>
</category>

<category name="events">
<endpoint name="show"></endpoint>
</category>

<category name="event">
<endpoint name="show"></endpoint>
</category>

<category name="tags">
<endpoint name="show"></endpoint>
</category>

<category name="util">
<endpoint name="getPhotoUrl"></endpoint>
</category>
50 changes: 50 additions & 0 deletions docs/api_def/twitter.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>

<category name="statuses">
<endpoint name="public_timeline"></endpoint>
<endpoint name="user_timeline"></endpoint>
<endpoint name="show"></endpoint>
<endpoint name="retweets"></endpoint>
<endpoint name="friends"></endpoint>
<endpoint name="followers"></endpoint>
</category>

<category name="users">
<endpoint name="show"></endpoint>
<endpoint name="suggestions"></endpoint>
</category>

<category name="trends">
<endpoint name="show"></endpoint>
<endpoint name="current"></endpoint>
<endpoint name="daily"></endpoint>
<endpoint name="weekly"></endpoint>
<endpoint name="available"></endpoint>
</category>

<category name="lists">
<endpoint name="statuses"></endpoint>
</category>

<category name="friendships">
<endpoint name="exists"></endpoint>
<endpoint name="show"></endpoint>
</category>

<category name="friends">
<endpoint name="ids"></endpoint>
</category>

<category name="followers">
<endpoint name="ids"></endpoint>
</category>

<category name="geo">
<endpoint name="nearby_places"></endpoint>
<endpoint name="search"></endpoint>
<endpoint name="similar_places"></endpoint>
<endpoint name="reverse_geocode"></endpoint>
<endpoint name="show"></endpoint>
</category>

<endpoint name="search"></endpoint>
Loading

0 comments on commit 0a8ddb1

Please sign in to comment.