Skip to content

/ go-github

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.

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

Jump to bottom

Remove some fields of IssueListCommentsOptions #1583

Open
you06 opened this issue Jul 22, 2020 · 5 comments
Open

Remove some fields of IssueListCommentsOptions #1583

you06 opened this issue Jul 22, 2020 · 5 comments
Assignees
@juanri0s
Labels
Breaking API Change good first issue

Comments

@you06
Copy link

@you06 you06 commented Jul 22, 2020

Sort and Direction not work since GitHub changed its API.

https://developer.github.com/v3/repos/commits/#list-commits

go-github/github/issues_comments.go

Lines 37 to 48 in e881974

type IssueListCommentsOptions struct {
// Sort specifies how to sort comments. Possible values are: created, updated.
Sort *string `url:"sort,omitempty"`
// Direction in which to sort comments. Possible values are: asc, desc.
Direction *string `url:"direction,omitempty"`
// Since filters comments by time.
Since *time.Time `url:"since,omitempty"`
ListOptions
}

@gmlewis
Copy link
Collaborator

@gmlewis gmlewis commented Jul 23, 2020

Thank you, @you06 !
The Sort and Direction fields need to be removed. Although these apparently no longer are supported, this change is still a breaking API change, so I will mark it that way.

This would be a great PR for any new contributor to this repo or a new Go developer.
All contributions are greatly appreciated!

Feel free to volunteer for any issue and the issue can be assigned to you so that others don't attempt to duplicate the work.

Please check out our CONTRIBUTING.md guide to get started.

Thank you!
@juanri0s
Copy link
Contributor

@juanri0s juanri0s commented Jul 23, 2020

I can work on this! 😁
@gmlewis
Copy link
Collaborator

@gmlewis gmlewis commented Jul 23, 2020

Thank you, @juanri0s ! It is yours.
@juanri0s
Copy link
Contributor

@juanri0s juanri0s commented Jul 23, 2020

@gmlewis I have removed the fields from the struct and the fields in the tests as well. Are we expecting this change in any other area other than issues_comments.go? Or do I need to go through the GH API docs and check myself?
@juanri0s juanri0s mentioned this issue Jul 23, 2020
Merged
2 of 2 tasks complete
@gmlewis
Copy link
Collaborator

@gmlewis gmlewis commented Jul 23, 2020

These fields were identified in the issue. You are welcome to look through the docs for other discrepancies.
@you06 you06 mentioned this issue Jul 23, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@juanri0s juanri0s

Labels
Breaking API Change good first issue
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@gmlewis @juanri0s @you06
You can’t perform that action at this time.