Skip to content

Update GitHub Pages API to add new response parameters #2109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Dec 3, 2021
Merged

Update GitHub Pages API to add new response parameters #2109

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
88adba8
First pass at Pages struct update and test case updates
rreichel3 Sep 28, 2021
8078f1a
Add tests to the correct test case
rreichel3 Sep 28, 2021
7b1ec63
Run go fmt to make things beautiful
rreichel3 Sep 28, 2021
9d8e6e5
Run through the `Contributing` guidelines
rreichel3 Sep 28, 2021
69924bb
Changed type name to HTTPS and updated collateral
rreichel3 Sep 29, 2021
aea4a18
Also update HTTPSEnforced property
rreichel3 Sep 29, 2021
575bb81
Apply suggestions from code review
rreichel3 Sep 29, 2021
1506b98
Add comment explaining the use of string in lieu of Timestamp
rreichel3 Sep 29, 2021
fe7591a
Merge branch 'users/rreichel3/update-pages-api' of https://github.com…
rreichel3 Sep 29, 2021
62a1c35
Update github/repos_pages.go
gmlewis Sep 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions github/github-accessors.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

57 changes: 57 additions & 0 deletions github/github-accessors_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 17 additions & 6 deletions github/repos_pages.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@ import (

// Pages represents a GitHub Pages site configuration.
type Pages struct {
URL *string `json:"url,omitempty"`
Status *string `json:"status,omitempty"`
CNAME *string `json:"cname,omitempty"`
Custom404 *bool `json:"custom_404,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
Source *PagesSource `json:"source,omitempty"`
URL *string `json:"url,omitempty"`
Status *string `json:"status,omitempty"`
CNAME *string `json:"cname,omitempty"`
Custom404 *bool `json:"custom_404,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
Source *PagesSource `json:"source,omitempty"`
Public *bool `json:"public,omitempty"`
HttpsCertificate *PagesHttpsCertificate `json:"https_certificate,omitempty"`
HttpsEnforced *bool `json:"https_enforced,omitempty"`
}

// PagesSource represents a GitHub page's source.
Expand All @@ -43,6 +46,14 @@ type PagesBuild struct {
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
}

// PagesBuild represents the HTTPS Certificate information for a GitHub Pages site.
type PagesHttpsCertificate struct {
State *string `json:"state,omitempty"`
Description *string `json:"description,omitempty"`
Domains *[]*string `json:"domains,omitempty"`
ExpiresAt *string `json:"expires_at,omitempty"`
}

// createPagesRequest is a subset of Pages and is used internally
// by EnablePages to pass only the known fields for the endpoint.
type createPagesRequest struct {
Expand Down
4 changes: 2 additions & 2 deletions github/repos_pages_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ func TestRepositoriesService_GetPagesInfo(t *testing.T) {

mux.HandleFunc("/repos/o/r/pages", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
fmt.Fprint(w, `{"url":"u","status":"s","cname":"c","custom_404":false,"html_url":"h"}`)
fmt.Fprint(w, `{"url":"u","status":"s","cname":"c","custom_404":false,"html_url":"h","public":true, "https_certificate": {"state":"approved","description": "Certificate is approved","domains": ["developer.github.com"],"expires_at": "2021-05-22"},"https_enforced": true}`)
})

ctx := context.Background()
Expand All @@ -179,7 +179,7 @@ func TestRepositoriesService_GetPagesInfo(t *testing.T) {
t.Errorf("Repositories.GetPagesInfo returned error: %v", err)
}

want := &Pages{URL: String("u"), Status: String("s"), CNAME: String("c"), Custom404: Bool(false), HTMLURL: String("h")}
want := &Pages{URL: String("u"), Status: String("s"), CNAME: String("c"), Custom404: Bool(false), HTMLURL: String("h"), Public: Bool(true), HttpsCertificate: &PagesHttpsCertificate{State: String("approved"), Description: String("Certificate is approved"), Domains: &[]*string{String("developer.github.com")}, ExpiresAt: String("2021-05-22")}, HttpsEnforced: Bool(true)}
if !cmp.Equal(page, want) {
t.Errorf("Repositories.GetPagesInfo returned %+v, want %+v", page, want)
}
Expand Down