Skip to content

Instantly share code, notes, and snippets.

@codeslinger
Created July 23, 2008 03:42
Show Gist options
  • Save codeslinger/1513 to your computer and use it in GitHub Desktop.
Save codeslinger/1513 to your computer and use it in GitHub Desktop.
YAML layout of Twitter API
---
host: twitter.com
scheme: http
auth: httpbasic
version: 2008-07-07T00:00:00-0800
parameters:
id:
type: id
required: False
id_num:
type: int
required: True
label: id
count:
type: int
required: False
since:
type: datetime
required: False
since_id:
type: int
required: False
page:
type: int
required: False
status:
type: string
required: True
maxlength: 140
lite:
type: string
required: False
valid:
- true
email:
type: string
required: False
user:
type: string
required: True
text:
type: string
required: True
maxlength: 140
user_a:
type: id
required: True
user_b:
type: id
required: True
location:
type: string
required: True
device:
type: string
required: True
valid:
- sms
- im
- none
endpoints:
status:
public_timeline:
url: statuses/public_timeline.${format}
formats:
- xml
- json
- rss
- atom
friends_timeline:
url: statuses/friends_timeline.${format}
formats:
- xml
- json
- rss
- atom
parameters:
- since
- since_id
- count
- page
user_timeline:
url: statuses/user_timeline.${format}
formats:
- xml
- json
- rss
- atom
parameters:
- id
- count
- since
- since_id
- page
show:
url: statuses/show/${id_num}.${format}
formats:
- xml
- json
update:
url: statuses/update.${format}
formats:
- xml
- json
parameters:
- status
method:
- POST
replies:
url: statuses/replies.${format}
formats:
- xml
- json
- rss
- atom
parameters:
- page
- since
- since_id
destroy:
url: statuses/destroy/${id_num}.${format}
formats:
- xml
- json
user:
friends:
url: statuses/friends.${format}
formats:
- xml
- json
parameters:
- id
- page
- lite
- since
followers:
url: statuses/followers.${format}
formats:
- xml
- json
parameters:
- id
- page
- lite
featured:
url: statuses/featured.${format}
formats:
- xml
- json
show:
url: users/show/${id}.${format}
formats:
- xml
- json
parameters:
- id
show_via_email:
url: users/show.${format}
formats:
- xml
- json
parameters:
- email
direct_message:
list:
url: direct_messages.${format}
formats:
- xml
- json
- rss
- atom
parameters:
- since
- since_id
- page
sent:
url: direct_messages/sent.${format}
formats:
- xml
- json
parameters:
- since
- since_id
- page
new:
url: direct_messages/new.${format}
formats:
- xml
- json
parameters:
- user
- text
method:
- POST
destroy:
url: direct_messages/destroy/${id_num}.${format}
formats:
- xml
- json
friendship:
create:
url: friendships/create/${id}.${format}
formats:
- xml
- json
destroy:
url: friendships/destroy/${id}.${format}
formats:
- xml
- json
exists:
url: friendships/exists.${format}
formats:
- xml
- json
- none
parameters:
- user_a
- user_b
account:
verify_credentials:
url: account/verify_credentials.${format}
formats:
- xml
- json
- none
end_session:
url: account/end_session
update_location:
url: account/update_location.${format}
formats:
- xml
- json
parameters:
- location
method:
- GET
- POST
update_delivery_device:
url: account/update_delivery_device.${format}
formats:
- xml
- json
parameters:
- device
rate_limit_status:
url: account/rate_limit_status.${format}
formats:
- xml
- json
favorites:
list:
url: favorites.${format}
formats:
- xml
- json
- rss
- atom
parameters:
- id
- page
create:
url: favorites/create/${id_num}.${format}
formats:
- xml
- json
destroy:
url: favorites/destroy/${id_num}.${format}
formats:
- xml
- json
notification:
follow:
url: notifications/follow/${id}.${format}
formats:
- xml
- json
leave:
url: notifications/leave/${id}.${format}
formats:
- xml
- json
block:
create:
url: blocks/create/${id}.${format}
formats:
- xml
- json
destroy:
url: blocks/destroy/${id}.${format}
formats:
- xml
- json
help:
test:
url: help/test.${format}
formats:
- xml
- json
downtime_schedule:
url: help/downtime_schedule.${format}
formats:
- xml
- json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment