Commitf18cb07

committed

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

Add documentation for the Pages API

2 parents843b4fb +c1a7aec commitf18cb07Copy full SHA for f18cb07

File tree

+61

-0

lines changed

+61

-0

lines changed

Lines changed: 35 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,35 @@`
	`1`	`+---`
	`2`	`+title:Pages \| GitHub API`
	`3`	`+---`
	`4`	`+`
	`5`	`+#Pages`
	`6`	`+`
	`7`	`+The Pages API retrieves information about your GitHub Pages configuration, and`
	`8`	`+the statuses of your builds. Information about the site and the builds can only be`
	`9`	`+accessed by authenticated owners, even thought the websites are public.`
	`10`	`+`
	`11`	`+* TOC`
	`12`	`+{:toc}`
	`13`	`+`
	`14`	`+##Get information about a Pages site`
	`15`	`+`
	`16`	`+GET /repos/:owner/:repo/pages`
	`17`	`+`
	`18`	`+###Response`
	`19`	`+`
	`20`	`+<%= headers 200 %>`
	`21`	`+<%= json(:pages) %>`
	`22`	`+`
	`23`	`+##List Pages builds`
	`24`	`+`
	`25`	`+GET /repos/:owner/:repo/pages/builds`
	`26`	`+`
	`27`	`+<%= headers 200 %>`
	`28`	`+<%= json(:pages_build) { \|h\|[h] } %>`
	`29`	`+`
	`30`	`+##List latest Pages build`
	`31`	`+`
	`32`	`+GET /repos/:owner/:repo/pages/builds/latest`
	`33`	`+`
	`34`	`+<%= headers 200 %>`
	`35`	`+<%= json(:pages_build) %>`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,7 @@ <h3><a href="#" class="js-expand-btn collapsed arrow-btn" data-proofer-ignore></`
`84`	`84`	`<li><ahref="/v3/repos/forks/">Forks</a></li>`
`85`	`85`	`<li><ahref="/v3/repos/hooks/">Hooks</a></li>`
`86`	`86`	`<li><ahref="/v3/repos/merging/">Merging</a></li>`
	`87`	`+<li><ahref="/v3/repos/pages/">Pages</a></li>`
`87`	`88`	`<li><ahref="/v3/repos/releases/">Releases</a></li>`
`88`	`89`	`<li><ahref="/v3/repos/statistics/">Statistics</a></li>`
`89`	`90`	`<li><ahref="/v3/repos/statuses/">Statuses</a></li>`

Lines changed: 20 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -631,6 +631,26 @@ def text_html(response, status, head = {})`
`631`	`631`	`"s3_url"=>"https://github.s3.amazonaws.com/"`
`632`	`632`	`})`
`633`	`633`
	`634`	`+PAGES={`
	`635`	`+"url"=>"https://api.github.com/repos/github/developer.github.com/pages",`
	`636`	`+"status"=>"built",`
	`637`	`+"cname"=>"developer.github.com",`
	`638`	`+"custom_404"=>false`
	`639`	`+}`
	`640`	`+`
	`641`	`+PAGES_BUILD={`
	`642`	`+"url"=>"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601",`
	`643`	`+"status"=>"built",`
	`644`	`+"error"=>{`
	`645`	`+"message"=>nil`
	`646`	`+},`
	`647`	`+"pusher"=>USER,`
	`648`	`+"commit"=>"351391cdcb88ffae71ec3028c91f375a8036a26b",`
	`649`	`+"duration"=>2104,`
	`650`	`+"created_at"=>"2014-02-10T19:00:49Z",`
	`651`	`+"updated_at"=>"2014-02-10T19:00:51Z"`
	`652`	`+}`
	`653`	`+`
`634`	`654`	`ORG={`
`635`	`655`	`"login"=>"github",`
`636`	`656`	`"id"=>1,`

Lines changed: 5 additions & 0 deletions

Comments

(0)