suzanne.soy/travis-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more documentation

Browse Source
This commit is contained in:
Konstantin Haase 2012-09-22 19:22:43 +02:00
parent 9e98c3b1f0
commit 70e5414b87
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/00_overview.md
View File

@ -1,7 +1,13 @@
# Overview # Overview
... some general docs here ... Welcome to the Travis API documentation. This is the API used by the official
[Travis CI](https://next.travis-ci.org) web interface, so everything the web
interface is able to do is also accomplishable via the API.
## Media Types ## Media Types
The API is currently [JSON](http://en.wikipedia.org/wiki/JSON) only. The API is currently [JSON](http://en.wikipedia.org/wiki/JSON) only.
## Clients and Libraries
* **[Travis Ember](https://github.com/travis-ci/travis-ember)**: The official Travis CI client, using [Ember.js](http://emberjs.com/).

5
lib/travis/api/app/endpoint/artifacts.rb
View File

@ -2,9 +2,10 @@ require 'travis/api/app'
class Travis::Api::App class Travis::Api::App
class Endpoint class Endpoint
# TODO: Add documentation. # Artifacts are generated by builds. Currently we only expose logs as
# artifacts
class Artifacts < Endpoint class Artifacts < Endpoint
# TODO: Add documentation. # Fetches an artifact by it's *id*.
get('/:id') do |id| get('/:id') do |id|
body service(:artifacts).find_one(params) body service(:artifacts).find_one(params)
end end