Document response for getting symlink content

jasonrudolph · jasonrudolph · commit d79af7b38f2a · 2013-04-11T17:47:51.000-04:00
diff --git a/content/v3/repos/contents.md b/content/v3/repos/contents.md
@@ -53,6 +53,15 @@ ref
 <%= headers 200 %>
 <%= json :directory_content %>
 
+### Response if content is a symlink
+
+If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the [format shown above](#response-if-content-is-a-file)).
+
+Otherwise, the API responds with a hash describing the symlink itself:
+
+<%= headers 200 %>
+<%= json :symlink_content %>
+
 ## Get archive link
 
 This method will return a `302` to a URL to download a tarball
diff --git a/lib/resources.rb b/lib/resources.rb
@@ -1003,6 +1003,23 @@ def text_html(response, status, head = {})
       },
     }
 
+    SYMLINK_CONTENT = {
+      "type" => "symlink",
+      "target" => "/path/to/symlink/target",
+      "size" => 23,
+      "name" => "some-symlink",
+      "path" => "bin/some-symlink",
+      "sha" => "452a98979c88e093d682cab404a3ec82babebb48",
+      "url" => "https://api.github.com/repos/pengwynn/octokit/contents/bin/some-symlink",
+      "git_url" => "https://api.github.com/repos/pengwynn/octokit/git/blobs/452a98979c88e093d682cab404a3ec82babebb48",
+      "html_url" => "http://github.dev/pengwynn/octokit/blob/master/bin/some-symlink",
+      "_links" => {
+        "git" => "https://api.github.com/repos/pengwynn/octokit/git/blobs/452a98979c88e093d682cab404a3ec82babebb48",
+        "self" => "https://api.github.com/repos/pengwynn/octokit/contents/bin/some-symlink",
+        "html" => "http://github.dev/pengwynn/octokit/blob/master/bin/some-symlink"
+      },
+    }
+
     DIRECTORY_CONTENT = [
       {
         "type" => "file",
