diff options
Diffstat (limited to 'frontend/src/lib/apidocs.js')
| -rw-r--r-- | frontend/src/lib/apidocs.js | 276 |
1 files changed, 276 insertions, 0 deletions
diff --git a/frontend/src/lib/apidocs.js b/frontend/src/lib/apidocs.js new file mode 100644 index 0000000..9757501 --- /dev/null +++ b/frontend/src/lib/apidocs.js @@ -0,0 +1,276 @@ +export default { + "namespaces": { + "tweets": [ + { + "method": "GET", + "description": "Returns a single Tweet, specified by ID.", + "path": "tweets/show", + "params": { + "id": { + "required": true, + "description": "The numerical ID of the desired Tweet.", + "type": "Integer" + } + }, + "example_params": { + "id": 43341783446466560 + } + }, + { + "method": "GET", + "description": "Returns Tweets, specified by comma-separated IDs.", + "path": "tweets/lookup", + "params": { + "ids": { + "required": true, + "description": "A comma-separated list of Tweet IDs, up to 100 are allowed in a single request.", + "type": "String" + } + }, + "example_params": { + "ids": "43341783446466560,340640143058825216" + } + }, + { + "method": "GET", + "description": "Returns the best Tweets of a user, specified by username or user ID.", + "path": "tweets/user_best", + "params": { + "user_id": { + "required": false, + "description": "The numerical ID of the user for whom to return results for.", + "type": "Integer" + }, + "screen_name": { + "required": false, + "description": "The username of the user for whom to return results for.", + "type": "String" + }, + "count": { + "required": false, + "description": "The number of tweets to retrieve. Must be less than or equal to 100, defaults to 10.", + "type": "Integer" + }, + "page": { + "required": false, + "description": "The page number of results to retrieve.", + "type": "Integer" + }, + "recent": { + "required": false, + "description": "When specified, returns only recent tweets in the term. Format is: /^\\d+[dwmy]$/", + "type": "String" + } + }, + "example_params": { + "user_id": 15926668, + "count": 2, + "page": 3, + "recent": "1m" + } + }, + { + "method": "GET", + "description": "Returns the newest Tweets of a user, specified by username or user ID.", + "path": "tweets/user_timeline", + "params": { + "user_id": { + "required": false, + "description": "The numerical ID of the user for whom to return results for.", + "type": "Integer" + }, + "screen_name": { + "required": false, + "description": "The username of the user for whom to return results for.", + "type": "String" + }, + "count": { + "required": false, + "description": "The number of tweets to retrieve. Must be less than or equal to 100, defaults to 10.", + "type": "Integer" + }, + "page": { + "required": false, + "description": "The page number of results to retrieve.", + "type": "Integer" + }, + "since_id": { + "required": false, + "description": "Returns results with an ID greater than the specified ID.", + "type": "Integer" + }, + "max_id": { + "required": false, + "description": "Returns results with an ID less than or equal to the specified ID.", + "type": "Integer" + }, + "reactions": { + "required": false, + "description": "Returns Tweets which has received reactions more than (or equal to) the specified number of times.", + "type": "Integer" + } + }, + "example_params": { + "screen_name": "toshi_a", + "count": 3, + "max_id": 432112694871605250 + } + }, + { + "method": "GET", + "description": "Returns the Tweets which a user specified by username or user ID favorited.", + "path": "tweets/user_favorites", + "params": { + "user_id": { + "required": false, + "description": "The numerical ID of the user for whom to return results for.", + "type": "Integer" + }, + "screen_name": { + "required": false, + "description": "The username of the user for whom to return results for.", + "type": "String" + }, + "count": { + "required": false, + "description": "The number of tweets to retrieve. Must be less than or equal to 100, defaults to 10.", + "type": "Integer" + }, + "page": { + "required": false, + "description": "The page number of results to retrieve.", + "type": "Integer" + }, + "reactions": { + "required": false, + "description": "Returns Tweets which has received reactions more than (or equal to) the specified number of times.", + "type": "Integer" + } + }, + "example_params": { + "user_id": 120726371, + "count": 2 + } + }, + { + "method": "GET", + "description": "Returns the specified user's Tweets which another specified user favorited.", + "path": "tweets/user_favorited_by", + "params": { + "user_id": { + "required": false, + "description": "The numerical ID of the user for whom to return results for.", + "type": "Integer" + }, + "screen_name": { + "required": false, + "description": "The username of the user for whom to return results for.", + "type": "String" + }, + "source_user_id": { + "required": false, + "description": "The numerical ID of the user for whom to return results for.", + "type": "Integer" + }, + "source_screen_name": { + "required": false, + "description": "The username of the user for whom to return results for.", + "type": "String" + }, + "count": { + "required": false, + "description": "The number of tweets to retrieve. Must be less than or equal to 100, defaults to 10.", + "type": "Integer" + }, + "page": { + "required": false, + "description": "The page number of results to retrieve.", + "type": "Integer" + }, + "since_id": { + "required": false, + "description": "Returns results with an ID greater than the specified ID.", + "type": "Integer" + }, + "max_id": { + "required": false, + "description": "Returns results with an ID less than or equal to the specified ID.", + "type": "Integer" + }, + "reactions": { + "required": false, + "description": "Returns Tweets which has received reactions more than (or equal to) the specified number of times.", + "type": "Integer" + } + }, + "example_params": { + "user_id": 120726371, + "count": 2, + "source_screen_name": "haru067" + } + } + ], + "users": [ + { + "method": "GET", + "description": "Returns the stats of a user, specified by username or user ID.", + "path": "users/stats", + "params": { + "id": { + "required": false, + "description": "The numerical ID of the user for whom to return results for.", + "type": "Integer" + }, + "screen_name": { + "required": false, + "description": "The username of the user for whom to return results for.", + "type": "String" + } + }, + "example_params": { + "id": 15926668 + } + }, + { + "method": "GET", + "description": "Returns the list of the users who discovered the Tweets of a user, specified by username or user ID.", + "path": "users/discovered_by", + "params": { + "id": { + "required": false, + "description": "The numerical ID of the user for whom to return results for.", + "type": "Integer" + }, + "screen_name": { + "required": false, + "description": "The username of the user for whom to return results for.", + "type": "String" + } + }, + "example_params": { + "id": 15926668 + } + }, + { + "method": "GET", + "description": "Returns the list of the users discovered by a user, specified by username or user ID.", + "path": "users/discovered_users", + "params": { + "id": { + "required": false, + "description": "The numerical ID of the user for whom to return results for.", + "type": "Integer" + }, + "screen_name": { + "required": false, + "description": "The username of the user for whom to return results for.", + "type": "String" + } + }, + "example_params": { + "screen_name": "toshi_a" + } + } + ] + } +}; |