Skip to content
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

Implement Gist API #216

Closed
9 tasks done
SimonCropp opened this issue Nov 13, 2013 · 9 comments · Fixed by #794
Closed
9 tasks done

Implement Gist API #216

SimonCropp opened this issue Nov 13, 2013 · 9 comments · Fixed by #794
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone

Comments

@SimonCropp
Copy link
Contributor

There's a few here, so let's break it down and track the progress:

http://developer.github.com/v3/gists/

  • List gists
  • Get a single gist
  • Create a gist - covered in Create gists #239
  • Edit a gist
  • Star a gist
  • Unstar a gist
  • Check if a gist is starred
  • Fork a gist
  • Delete a gist
@xabikos
Copy link

xabikos commented Nov 30, 2013

I've start implement the gist API. Shall I also implement the comments API as a subclient of Gist or I have to open a new issue?

@shiftkey
Copy link
Member

@xabikos we're following the layout of the documentation site to be consistent with how users would explore it

screen shot 2013-11-30 at 11 34 46 am

In this case Comments are under Gists, so I'd expect Comments to be a subclient of Gist:

var comments = client.Gist.Comments.GetAll("id");

@shiftkey
Copy link
Member

@xabikos I've opened up #247 to track the Gists Comments API, which is somewhat different to the Gists API.

Feel free to leave a comment there if you've got any other questions.

@xabikos
Copy link

xabikos commented Nov 30, 2013

@shiftkey thanks for the reply. I'll continue implementing the gists API and maybe afterwards implement the comments API as well. Regarding the gists shall I make a pull request for every one of above check boxes or only when all of them are finished?

@shiftkey
Copy link
Member

Keep in mind that #239 is underway for creating gists

@xabikos
Copy link

xabikos commented Nov 30, 2013

Thanks @shiftkey for remind it to me 👍

@shiftkey
Copy link
Member

Regarding the gists shall I make a pull request for every one of above check boxes or only when all of them are finished?

Doing it incrementally makes for easier code reviews on my end, but up to you. The checkboxes are just there to ensure that duplication of work isn't happening

@xabikos
Copy link

xabikos commented Dec 21, 2013

I made a pull request for some of the methods related to gists. I created a topic branch (implement-gist-api) when I for the repository and worked on this branch. I made the pull request and didn't merge my topic branch to the master first. Is this correct? This is my first attempt for a pull request.

@xabikos
Copy link

xabikos commented Dec 21, 2013

Except the above comment I have a question regarding the check if a gist is stared method. We have to make a get request to /gists/:id/star url and based on the response code (204, 404) return true or false. I couldn't find an easy solution to access the response code through API connection. Any suggestions on how to implement this? Shall I add an extra method to API connection to access the request response?

haagenson added a commit to haagenson/octokit.net that referenced this issue Jul 21, 2014
- [ ] Finish Gists API Implementation
- [ ] [Add method to get gist
commits](https://developer.github.com/v3/gists/#list-gist-commits)
- [ ] [Add method to get gist
forks](https://developer.github.com/v3/gists/#list-gist-forks)

Fixes octokit#328, Fixes octokit#216

Added implementation for the remaining pieces of the Gists API.  The
others mentioned in octokit#328 and octokit#216 were completed through other PRs.
@shiftkey shiftkey mentioned this issue May 8, 2015
3 tasks
@nickfloyd nickfloyd added Status: Up for grabs Issues that are ready to be worked on by anyone and removed up-for-grabs labels Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone
Projects
None yet
4 participants