Merge branch 'master' into watcher-changes

technoweenie · technoweenie · commit a9eea7414855 · 2012-09-04T17:13:53.000-06:00
diff --git a/Gemfile b/Gemfile
@@ -12,4 +12,5 @@ gem 'builder'
 
 group :development do
   gem 'adsf'
+  gem 'fssm'
 end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -10,6 +10,7 @@ GEM
     cri (2.3.0)
       colored (>= 1.2)
     ffi (1.0.11)
+    fssm (0.2.9)
     kramdown (0.13.7)
     mime-types (1.18)
     nanoc (3.3.7)
@@ -31,6 +32,7 @@ DEPENDENCIES
   adsf
   builder
   coderay
+  fssm
   kramdown (~> 0.13.2)
   mime-types (~> 1.16)
   nanoc (~> 3.3.7)
diff --git a/content/index.md b/content/index.md
@@ -48,6 +48,10 @@ The API is expected to be finalized Real Soon Now.
 
 ### Breaking Beta Changes
 
+##### August 30, 2012
+* Added `repo:status` scope
+* Added Status API
+
 ##### August 7, 2012
 * Clarified watching/stargazing
 
diff --git a/content/v3/markdown.md b/content/v3/markdown.md
@@ -4,7 +4,7 @@ title: Markdown Rendering | GitHub API
 
 # Markdown Rendering API
 
-## Render an arbritrary Markdown document
+## Render an arbitrary Markdown document
 
 	POST /markdown
 
diff --git a/content/v3/oauth.md b/content/v3/oauth.md
@@ -146,6 +146,10 @@ public\_repo
 repo
 : Read/write access to public and private repos and organizations.
 
+repo:status
+: Read/write access to public and private repo statuses.  Does **not**
+include access to code - use `repo` for that.
+
 delete\_repo
 : Delete access to adminable repositories.
 
diff --git a/content/v3/orgs/teams.md b/content/v3/orgs/teams.md
@@ -187,7 +187,7 @@ NOTE: This does not delete the user, it just remove them from the team.
 
 In order to add a repo to a team, the authenticated user must be an
 owner of the org that the team is associated with.  Also, the repo must
-be owned by the organization, or a direct for of a repo owned by the
+be owned by the organization, or a direct form of a repo owned by the
 organization.
 
     PUT /teams/:id/repos/:user/:repo
diff --git a/content/v3/repos/commits.md b/content/v3/repos/commits.md
@@ -24,6 +24,10 @@ path
 : _Optional_ **string** - Only commits containing this file path
 will be returned.
 
+author
+: _Optional_ **string** - GitHub login, name, or email by which to filter by
+commit author
+
 ### Response
 
 <%= headers 200 %>
diff --git a/content/v3/repos/statuses.md b/content/v3/repos/statuses.md
@@ -0,0 +1,66 @@
+---
+title: Statuses | GitHub API
+---
+
+# Repo Statuses API
+
+The Status API allows external services to mark commits with a success,
+failure, error, or pending `state`, which is then reflected in pull requests
+involving those commits.
+
+Statuses can also include an optional `description` and `url`, and
+we highly recommend providing them as they make statuses much more
+useful in the GitHub UI.
+
+As an example, one common use is for continuous integration
+services to mark commits as passing or failing builds using Status.  The
+`target_url` would be the full url to the build output, and the
+description would be the high level summary of what happened with the
+build.
+
+Note that the `repo:status` [OAuth scope](/v3/oauth/#scopes) grants targeted
+access to Statuses **without** also granting access to repo code, while the
+`repo` scope grants permission to code as well as statuses.
+
+## List Statuses for a specific SHA
+
+    GET /repos/:user/:repo/statuses/:sha
+
+### Parameters
+
+sha
+: _Required_ **string** - Sha to list the statuses from
+
+### Response
+
+<%= headers 200 %>
+<%= json(:status) { |h| [h] } %>
+
+## Create a Status
+
+    POST /repos/:user/:repo/statuses/:sha
+
+### Parameters
+
+state
+: _Required_ **string** State of the status - can be one of `pending`,
+`success`, `error`, or `failure`.
+
+target_url
+: _Optional_ **string** Target url to associate with this status.  This
+URL will be linked from the GitHub UI to allow users to easily see the
+'source' of the Status.
+
+: For example, if your Continuous Integration system is posting build
+status, you would want to provide the deep link for the build output for
+this specific sha - `http://ci.example.com/johndoe/my-repo/builds/sha`.
+
+description
+: _Optional_ **string** Short description of the status
+
+### Response
+
+<%= headers 201,
+      :Location =>
+'https://api.github.com/repos/octocat/example/statuses/1' %>
+<%= json :status %>
diff --git a/layouts/default.html b/layouts/default.html
@@ -94,9 +94,10 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/repos/">R
               <li><a href="/v3/repos/downloads/">Downloads</a></li>
               <li><a href="/v3/repos/forks/">Forks</a></li>
               <li><a href="/v3/repos/keys/">Keys</a></li>
-              <li><a href="/v3/repos/watching/">Watching</a></li>
               <li><a href="/v3/repos/hooks/">Hooks</a></li>
               <li><a href="/v3/repos/merging/">Merging</a></li>
+              <li><a href="/v3/repos/statuses/">Statuses</a></li>
+              <li><a href="/v3/repos/watching/">Watching</a></li>
             </ul>
           </li>
           <li class="js-topic">
diff --git a/lib/resources.rb b/lib/resources.rb
@@ -935,6 +935,17 @@ def text_html(response, status, head = {})
       "sha" =>  "3d21ec53a331a6f037a91c368710b99387d012c1"
     }
 
+    STATUS = {
+      "created_at" => "2012-07-20T01:19:13Z",
+      "updated_at" => "2012-07-20T01:19:13Z",
+      "state" => "success",
+      "target_url" => "https://ci.example.com/1000/output",
+      "description" => "Build has completed successfully",
+      "id" => 1,
+      "url" => "https://api.github.com/repos/octocat/example/statuses/1",
+      "creator" => USER
+    }
+
     BLOB = {
       :content => "Content of the blob",
       :encoding => "utf-8",
