Skip to content

Commit 3875849

Browse files
authored
fix: Use stable media type in Starring API (#3590)
1 parent 8878e69 commit 3875849

File tree

3 files changed

+6
-10
lines changed

3 files changed

+6
-10
lines changed

github/activity_star.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ func (s *ActivityService) ListStargazers(ctx context.Context, owner, repo string
4040
return nil, nil, err
4141
}
4242

43-
// TODO: remove custom Accept header when this API fully launches
44-
req.Header.Set("Accept", mediaTypeStarringPreview)
43+
req.Header.Set("Accept", mediaTypeStarring)
4544

4645
var stargazers []*Stargazer
4746
resp, err := s.client.Do(ctx, req, &stargazers)
@@ -91,8 +90,7 @@ func (s *ActivityService) ListStarred(ctx context.Context, user string, opts *Ac
9190
return nil, nil, err
9291
}
9392

94-
// TODO: remove custom Accept header when APIs fully launch
95-
acceptHeaders := []string{mediaTypeStarringPreview, mediaTypeTopicsPreview}
93+
acceptHeaders := []string{mediaTypeStarring, mediaTypeTopicsPreview}
9694
req.Header.Set("Accept", strings.Join(acceptHeaders, ", "))
9795

9896
var repos []*StarredRepository

github/activity_star_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ func TestActivityService_ListStargazers(t *testing.T) {
2222

2323
mux.HandleFunc("/repos/o/r/stargazers", func(w http.ResponseWriter, r *http.Request) {
2424
testMethod(t, r, "GET")
25-
testHeader(t, r, "Accept", mediaTypeStarringPreview)
25+
testHeader(t, r, "Accept", mediaTypeStarring)
2626
testFormValues(t, r, values{
2727
"page": "2",
2828
})
@@ -62,7 +62,7 @@ func TestActivityService_ListStarred_authenticatedUser(t *testing.T) {
6262

6363
mux.HandleFunc("/user/starred", func(w http.ResponseWriter, r *http.Request) {
6464
testMethod(t, r, "GET")
65-
testHeader(t, r, "Accept", strings.Join([]string{mediaTypeStarringPreview, mediaTypeTopicsPreview}, ", "))
65+
testHeader(t, r, "Accept", strings.Join([]string{mediaTypeStarring, mediaTypeTopicsPreview}, ", "))
6666
fmt.Fprint(w, `[{"starred_at":"2002-02-10T15:30:00Z","repo":{"id":1}}]`)
6767
})
6868

@@ -98,7 +98,7 @@ func TestActivityService_ListStarred_specifiedUser(t *testing.T) {
9898

9999
mux.HandleFunc("/users/u/starred", func(w http.ResponseWriter, r *http.Request) {
100100
testMethod(t, r, "GET")
101-
testHeader(t, r, "Accept", strings.Join([]string{mediaTypeStarringPreview, mediaTypeTopicsPreview}, ", "))
101+
testHeader(t, r, "Accept", strings.Join([]string{mediaTypeStarring, mediaTypeTopicsPreview}, ", "))
102102
testFormValues(t, r, values{
103103
"sort": "created",
104104
"direction": "asc",

github/github.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ const (
5454
mediaTypeV3Patch = "application/vnd.github.v3.patch"
5555
mediaTypeOrgPermissionRepo = "application/vnd.github.v3.repository+json"
5656
mediaTypeIssueImportAPI = "application/vnd.github.golden-comet-preview+json"
57+
mediaTypeStarring = "application/vnd.github.star+json"
5758

5859
// Media Type values to access preview APIs
5960
// These media types will be added to the API request as headers
@@ -72,9 +73,6 @@ const (
7273
//
7374
// See https://github.com/google/go-github/pull/2125 for full context.
7475

75-
// https://developer.github.com/changes/2014-12-09-new-attributes-for-stars-api/
76-
mediaTypeStarringPreview = "application/vnd.github.v3.star+json"
77-
7876
// https://help.github.com/enterprise/2.4/admin/guides/migrations/exporting-the-github-com-organization-s-repositories/
7977
mediaTypeMigrationsPreview = "application/vnd.github.wyandotte-preview+json"
8078

0 commit comments

Comments
 (0)