From 70e5414b87a1f3738c8ec7612355fb01b55251b0 Mon Sep 17 00:00:00 2001 From: Konstantin Haase Date: Sat, 22 Sep 2012 19:22:43 +0200 Subject: [PATCH] more documentation --- docs/00_overview.md | 10 ++++++++-- lib/travis/api/app/endpoint/artifacts.rb | 5 +++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/00_overview.md b/docs/00_overview.md index 7d041592..2dbeedd3 100644 --- a/docs/00_overview.md +++ b/docs/00_overview.md @@ -1,7 +1,13 @@ # 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 -The API is currently [JSON](http://en.wikipedia.org/wiki/JSON) only. \ No newline at end of file +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/). \ No newline at end of file diff --git a/lib/travis/api/app/endpoint/artifacts.rb b/lib/travis/api/app/endpoint/artifacts.rb index 2a1d51b4..78fbe3cc 100644 --- a/lib/travis/api/app/endpoint/artifacts.rb +++ b/lib/travis/api/app/endpoint/artifacts.rb @@ -2,9 +2,10 @@ require 'travis/api/app' class Travis::Api::App class Endpoint - # TODO: Add documentation. + # Artifacts are generated by builds. Currently we only expose logs as + # artifacts class Artifacts < Endpoint - # TODO: Add documentation. + # Fetches an artifact by it's *id*. get('/:id') do |id| body service(:artifacts).find_one(params) end