Merge pull request #436 from github/add-pages-api

gjtorikian · gjtorikian · commit f18cb07bc70c · 2014-02-12T11:41:47.000-08:00
Add documentation for the Pages API
diff --git a/content/v3/repos/pages.md b/content/v3/repos/pages.md
@@ -0,0 +1,35 @@
+---
+title: Pages | GitHub API
+---
+
+# Pages
+
+The Pages API retrieves information about your GitHub Pages configuration, and
+the statuses of your builds. Information about the site and the builds can only be
+accessed by authenticated owners, even thought the websites are public.
+
+* TOC
+{:toc}
+
+## Get information about a Pages site
+
+    GET /repos/:owner/:repo/pages
+
+### Response
+
+<%= headers 200 %>
+<%= json(:pages) %>
+
+## List Pages builds
+
+    GET /repos/:owner/:repo/pages/builds
+
+<%= headers 200 %>
+<%= json(:pages_build) { |h| [h] } %>
+
+## List latest Pages build
+
+    GET /repos/:owner/:repo/pages/builds/latest
+
+<%= headers 200 %>
+<%= json(:pages_build) %>
diff --git a/layouts/sidebar.html b/layouts/sidebar.html
@@ -84,6 +84,7 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></
           <li><a href="/v3/repos/forks/">Forks</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/pages/">Pages</a></li>
           <li><a href="/v3/repos/releases/">Releases</a></li>
           <li><a href="/v3/repos/statistics/">Statistics</a></li>
           <li><a href="/v3/repos/statuses/">Statuses</a></li>
diff --git a/lib/resources.rb b/lib/resources.rb
@@ -631,6 +631,26 @@ def text_html(response, status, head = {})
       "s3_url"         => "https://github.s3.amazonaws.com/"
     })
 
+    PAGES = {
+      "url" => "https://api.github.com/repos/github/developer.github.com/pages",
+      "status" => "built",
+      "cname" => "developer.github.com",
+      "custom_404" => false
+    }
+
+    PAGES_BUILD = {
+      "url" => "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601",
+      "status" => "built",
+      "error" => {
+        "message" => nil
+      },
+      "pusher" => USER,
+      "commit" => "351391cdcb88ffae71ec3028c91f375a8036a26b",
+      "duration" => 2104,
+      "created_at" => "2014-02-10T19:00:49Z",
+      "updated_at" => "2014-02-10T19:00:51Z"
+    }
+
     ORG = {
       "login"      => "github",
       "id"         => 1,
diff --git a/static/search-index.json b/static/search-index.json
@@ -240,6 +240,11 @@
       "title": "Merging",
       "section": "API/Repositories"
     },
+    {
+      "url": "/v3/repos/pages/",
+      "title": "Pages",
+      "section": "API/Repositories"
+    },
     {
       "url": "/v3/repos/releases/",
       "title": "Releases",
