Add documentation to /repos

This documents what @drogus mentioned here:
https://github.com/travis-ci/travis-ci/issues/503#issuecomment-10447864
This commit is contained in:
Henrik Hodne 2012-11-16 10:44:45 -06:00
parent e2894d9ce1
commit eaf28bec33

View File

@ -3,6 +3,11 @@ require 'travis/api/app'
class Travis::Api::App
class Endpoint
class Repos < Endpoint
# Endpoint for getting all repositories.
#
# You can filter the repositories by adding parameters to the request. For example, you can get all repositories
# owned by johndoe by adding `owner_name=johndoe`, or all repositories that johndoe has access to by adding
# `member=johndoe`. The parameter names correspond to the keys of the response hash.
get '/' do
respond_with service(:repositories, :find_all, params)
end