Merge pull request #1024 from STRd6/patch-1

keavy · keavy · commit a9e7d7dc4f39 · 2016-03-14T06:11:10.000-06:00
Update refs.md
diff --git a/content/v3/git/refs.md b/content/v3/git/refs.md
@@ -14,11 +14,26 @@ The `ref` in the URL must be formatted as `heads/branch`, not just `branch`. For
 
     GET /repos/:owner/:repo/git/refs/heads/skunkworkz/featureA
 
-### Response
-
 <%= headers 200 %>
 <%= json :ref %>
 
+If the `ref` doesn't exist in the repository, but existing refs start with `ref`
+they will be returned as an array. For example, a call to get the data for a
+branch named `feature`, which doesn't exist, would return head refs
+including `featureA` and `featureB` which do.
+
+    GET /repos/:owner/:repo/git/refs/heads/feature
+
+<%= headers 200 %>
+<%= json :refs_matching %>
+
+If the `ref` doesn't match an existing ref or any prefixes a 404 will be returned.
+
+    GET /repos/:owner/:repo/git/refs/heads/feature-branch-that-no-longer-exists
+
+<%= headers 404 %>
+<%= json :refs_not_found %>
+
 ## Get all References
 
     GET /repos/:owner/:repo/git/refs
diff --git a/lib/responses/git.rb b/lib/responses/git.rb
@@ -422,6 +422,32 @@ module Responses
           }
         }
       ]
+
+      REFS_MATCHING ||= [
+        {
+          "ref" => "refs/heads/feature-a",
+          "url" => "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a",
+          "object" => {
+            "type" => "commit",
+            "sha" => "aa218f56b14c9653891f9e74264a383fa43fefbd",
+            "url" => "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
+          }
+        },
+        {
+          "ref" => "refs/heads/feature-b",
+          "url" => "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b",
+          "object" => {
+            "type" => "commit",
+            "sha" => "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac",
+            "url" => "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac"
+          }
+        }
+      ]
+
+      REFS_NOT_FOUND ||= {
+        "message" => "Not Found",
+        "documentation_url" => "https://developer.github.com/v3"
+      }
     end
   end
 end
