Skip to content

Commit c2f8bfa

Browse files
stephenotalorastephenotalora
committed
Refactors project field specific method names to match the standardized naming convention introduced in #3761 for consistency across the client API.
1 parent 032e591 commit c2f8bfa

File tree

3 files changed

+28
-28
lines changed

3 files changed

+28
-28
lines changed

‎github/projects.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -189,12 +189,12 @@ func (s *ProjectsService) GetProjectForUser(ctx context.Context, username string
189189
return project, resp, nil
190190
}
191191

192-
// ListProjectFieldsForOrg lists Projects V2 for an organization.
192+
// ListOrganizationProjectFields lists Projects V2 for an organization.
193193
//
194194
// GitHub API docs: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization
195195
//
196196
//meta:operation GET /orgs/{org}/projectsV2/{project_number}/fields
197-
func (s *ProjectsService) ListProjectFieldsForOrg(ctx context.Context, org string, projectNumber int, opts *ListProjectsOptions) ([]*ProjectV2Field, *Response, error) {
197+
func (s *ProjectsService) ListOrganizationProjectFields(ctx context.Context, org string, projectNumber int, opts *ListProjectsOptions) ([]*ProjectV2Field, *Response, error) {
198198
u := fmt.Sprintf("orgs/%v/projectsV2/%v/fields", org, projectNumber)
199199
u, err := addOptions(u, opts)
200200
if err != nil {
@@ -214,12 +214,12 @@ func (s *ProjectsService) ListProjectFieldsForOrg(ctx context.Context, org strin
214214
return fields, resp, nil
215215
}
216216

217-
// ListProjectFieldsForUser lists Projects V2 for a user.
217+
// ListUserProjectFields lists Projects V2 for a user.
218218
//
219219
// GitHub API docs: https://docs.github.com/rest/projects/fields#list-project-fields-for-user
220220
//
221221
//meta:operation GET /users/{username}/projectsV2/{project_number}/fields
222-
func (s *ProjectsService) ListProjectFieldsForUser(ctx context.Context, user string, projectNumber int, opts *ListProjectsOptions) ([]*ProjectV2Field, *Response, error) {
222+
func (s *ProjectsService) ListUserProjectFields(ctx context.Context, user string, projectNumber int, opts *ListProjectsOptions) ([]*ProjectV2Field, *Response, error) {
223223
u := fmt.Sprintf("users/%v/projectsV2/%v/fields", user, projectNumber)
224224
u, err := addOptions(u, opts)
225225
if err != nil {
@@ -239,12 +239,12 @@ func (s *ProjectsService) ListProjectFieldsForUser(ctx context.Context, user str
239239
return fields, resp, nil
240240
}
241241

242-
// GetProjectFieldForOrg gets a single project field from an organization owned project.
242+
// GetOrganizationProjectField gets a single project field from an organization owned project.
243243
//
244244
// GitHub API docs: https://docs.github.com/rest/projects/fields#get-project-field-for-organization
245245
//
246246
//meta:operation GET /orgs/{org}/projectsV2/{project_number}/fields/{field_id}
247-
func (s *ProjectsService) GetProjectFieldForOrg(ctx context.Context, org string, projectNumber int, fieldID int64) (*ProjectV2Field, *Response, error) {
247+
func (s *ProjectsService) GetOrganizationProjectField(ctx context.Context, org string, projectNumber int, fieldID int64) (*ProjectV2Field, *Response, error) {
248248
u := fmt.Sprintf("orgs/%v/projectsV2/%v/fields/%v", org, projectNumber, fieldID)
249249
req, err := s.client.NewRequest("GET", u, nil)
250250
if err != nil {
@@ -259,12 +259,12 @@ func (s *ProjectsService) GetProjectFieldForOrg(ctx context.Context, org string,
259259
return field, resp, nil
260260
}
261261

262-
// GetProjectFieldForUser gets a single project field from a user owned project.
262+
// GetUserProjectField gets a single project field from a user owned project.
263263
//
264264
// GitHub API docs: https://docs.github.com/rest/projects/fields#get-project-field-for-user
265265
//
266266
//meta:operation GET /users/{username}/projectsV2/{project_number}/fields/{field_id}
267-
func (s *ProjectsService) GetProjectFieldForUser(ctx context.Context, user string, projectNumber int, fieldID int64) (*ProjectV2Field, *Response, error) {
267+
func (s *ProjectsService) GetUserProjectField(ctx context.Context, user string, projectNumber int, fieldID int64) (*ProjectV2Field, *Response, error) {
268268
u := fmt.Sprintf("users/%v/projectsV2/%v/fields/%v", user, projectNumber, fieldID)
269269
req, err := s.client.NewRequest("GET", u, nil)
270270
if err != nil {

‎github/projects_test.go‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ func TestProjectsService_ListProjectFieldsForOrg(t *testing.T) {
205205

206206
opts := &ListProjectsOptions{Query: Ptr("text"), ListProjectsPaginationOptions: ListProjectsPaginationOptions{After: Ptr("2"), Before: Ptr("1")}}
207207
ctx := t.Context()
208-
fields, _, err := client.Projects.ListProjectFieldsForOrg(ctx, "o", 1, opts)
208+
fields, _, err := client.Projects.ListOrganizationProjectFields(ctx, "o", 1, opts)
209209
if err != nil {
210210
t.Fatalf("Projects.ListProjectFieldsForOrg returned error: %v", err)
211211
}
@@ -218,23 +218,23 @@ func TestProjectsService_ListProjectFieldsForOrg(t *testing.T) {
218218

219219
const methodName = "ListProjectFieldsForOrg"
220220
testBadOptions(t, methodName, func() (err error) {
221-
_, _, err = client.Projects.ListProjectFieldsForOrg(ctx, "\n", 1, opts)
221+
_, _, err = client.Projects.ListOrganizationProjectFields(ctx, "\n", 1, opts)
222222
return err
223223
})
224224
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
225-
got, resp, err := client.Projects.ListProjectFieldsForOrg(ctx, "o", 1, opts)
225+
got, resp, err := client.Projects.ListOrganizationProjectFields(ctx, "o", 1, opts)
226226
if got != nil {
227227
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
228228
}
229229
return resp, err
230230
})
231231
ctxBypass := context.WithValue(ctx, BypassRateLimitCheck, true)
232-
if _, _, err = client.Projects.ListProjectFieldsForOrg(ctxBypass, "o", 1, &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("b"), After: Ptr("a")}}); err != nil {
232+
if _, _, err = client.Projects.ListOrganizationProjectFields(ctxBypass, "o", 1, &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("b"), After: Ptr("a")}}); err != nil {
233233
t.Fatalf("unexpected error when both before/after set: %v", err)
234234
}
235235
}
236236

237-
func TestProjectsService_ListProjectFieldsForUser(t *testing.T) {
237+
func TestProjectsService_ListUserProjectFields(t *testing.T) {
238238
t.Parallel()
239239
client, mux, _ := setup(t)
240240

@@ -274,7 +274,7 @@ func TestProjectsService_ListProjectFieldsForUser(t *testing.T) {
274274

275275
opts := &ListProjectsOptions{Query: Ptr("text"), ListProjectsPaginationOptions: ListProjectsPaginationOptions{After: Ptr("2"), Before: Ptr("1")}}
276276
ctx := t.Context()
277-
fields, _, err := client.Projects.ListProjectFieldsForUser(ctx, "u", 1, opts)
277+
fields, _, err := client.Projects.ListUserProjectFields(ctx, "u", 1, opts)
278278
if err != nil {
279279
t.Fatalf("Projects.ListProjectFieldsForUser returned error: %v", err)
280280
}
@@ -287,23 +287,23 @@ func TestProjectsService_ListProjectFieldsForUser(t *testing.T) {
287287

288288
const methodName = "ListProjectFieldsForUser"
289289
testBadOptions(t, methodName, func() (err error) {
290-
_, _, err = client.Projects.ListProjectFieldsForUser(ctx, "\n", 1, opts)
290+
_, _, err = client.Projects.ListUserProjectFields(ctx, "\n", 1, opts)
291291
return err
292292
})
293293
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
294-
got, resp, err := client.Projects.ListProjectFieldsForUser(ctx, "u", 1, opts)
294+
got, resp, err := client.Projects.ListUserProjectFields(ctx, "u", 1, opts)
295295
if got != nil {
296296
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
297297
}
298298
return resp, err
299299
})
300300
ctxBypass := context.WithValue(ctx, BypassRateLimitCheck, true)
301-
if _, _, err = client.Projects.ListProjectFieldsForUser(ctxBypass, "u", 1, &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("b"), After: Ptr("a")}}); err != nil {
301+
if _, _, err = client.Projects.ListUserProjectFields(ctxBypass, "u", 1, &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{Before: Ptr("b"), After: Ptr("a")}}); err != nil {
302302
t.Fatalf("unexpected error when both before/after set: %v", err)
303303
}
304304
}
305305

306-
func TestProjectsService_GetProjectFieldForOrg(t *testing.T) {
306+
func TestProjectsService_GetOrganizationProjectField(t *testing.T) {
307307
t.Parallel()
308308
client, mux, _ := setup(t)
309309

@@ -326,7 +326,7 @@ func TestProjectsService_GetProjectFieldForOrg(t *testing.T) {
326326
})
327327

328328
ctx := t.Context()
329-
field, _, err := client.Projects.GetProjectFieldForOrg(ctx, "o", 1, 1)
329+
field, _, err := client.Projects.GetOrganizationProjectField(ctx, "o", 1, 1)
330330
if err != nil {
331331
t.Fatalf("Projects.GetProjectFieldForOrg returned error: %v", err)
332332
}
@@ -336,15 +336,15 @@ func TestProjectsService_GetProjectFieldForOrg(t *testing.T) {
336336

337337
const methodName = "GetProjectFieldForOrg"
338338
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
339-
got, resp, err := client.Projects.GetProjectFieldForOrg(ctx, "o", 1, 1)
339+
got, resp, err := client.Projects.GetOrganizationProjectField(ctx, "o", 1, 1)
340340
if got != nil {
341341
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
342342
}
343343
return resp, err
344344
})
345345
}
346346

347-
func TestProjectsService_GetProjectFieldForUser(t *testing.T) {
347+
func TestProjectsService_GetUserProjectField(t *testing.T) {
348348
t.Parallel()
349349
client, mux, _ := setup(t)
350350

@@ -367,7 +367,7 @@ func TestProjectsService_GetProjectFieldForUser(t *testing.T) {
367367
})
368368

369369
ctx := t.Context()
370-
field, _, err := client.Projects.GetProjectFieldForUser(ctx, "u", 1, 3)
370+
field, _, err := client.Projects.GetUserProjectField(ctx, "u", 1, 3)
371371
if err != nil {
372372
t.Fatalf("Projects.GetProjectFieldForUser returned error: %v", err)
373373
}
@@ -377,7 +377,7 @@ func TestProjectsService_GetProjectFieldForUser(t *testing.T) {
377377

378378
const methodName = "GetProjectFieldForUser"
379379
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
380-
got, resp, err := client.Projects.GetProjectFieldForUser(ctx, "u", 1, 3)
380+
got, resp, err := client.Projects.GetUserProjectField(ctx, "u", 1, 3)
381381
if got != nil {
382382
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
383383
}
@@ -452,7 +452,7 @@ func TestProjectsService_ListProjectsForUser_error(t *testing.T) {
452452
})
453453
}
454454

455-
func TestProjectsService_ListProjectFieldsForOrg_pagination(t *testing.T) {
455+
func TestProjectsService_ListOrganizationProjectFields_pagination(t *testing.T) {
456456
t.Parallel()
457457
client, mux, _ := setup(t)
458458

@@ -478,7 +478,7 @@ func TestProjectsService_ListProjectFieldsForOrg_pagination(t *testing.T) {
478478
})
479479

480480
ctx := t.Context()
481-
first, resp, err := client.Projects.ListProjectFieldsForOrg(ctx, "o", 1, nil)
481+
first, resp, err := client.Projects.ListOrganizationProjectFields(ctx, "o", 1, nil)
482482
if err != nil {
483483
t.Fatalf("first page error: %v", err)
484484
}
@@ -490,7 +490,7 @@ func TestProjectsService_ListProjectFieldsForOrg_pagination(t *testing.T) {
490490
}
491491

492492
opts := &ListProjectsOptions{ListProjectsPaginationOptions: ListProjectsPaginationOptions{After: Ptr(resp.After)}}
493-
second, resp2, err := client.Projects.ListProjectFieldsForOrg(ctx, "o", 1, opts)
493+
second, resp2, err := client.Projects.ListOrganizationProjectFields(ctx, "o", 1, opts)
494494
if err != nil {
495495
t.Fatalf("second page error: %v", err)
496496
}

‎test/integration/projects_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ func TestProjectsV2_Org(t *testing.T) {
6666
t.Fatalf("GetProjectForOrg returned unexpected project number: got %+v want %d", proj.Number, projectNumber)
6767
}
6868

69-
_, _, err = client.Projects.ListProjectFieldsForOrg(ctx, org, projectNumber, nil)
69+
_, _, err = client.Projects.ListOrganizationProjectFields(ctx, org, projectNumber, nil)
7070
if err != nil {
71-
t.Fatalf("Projects.ListProjectFieldsForOrg returned error: %v. Fields listing might require extra permissions", err)
71+
t.Fatalf("Projects.ListOrganizationProjectFields returned error: %v. Fields listing might require extra permissions", err)
7272
}
7373
}
7474

0 commit comments

Comments
 (0)