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

GPG Key Administration API Preview #1252

Closed
shiftkey opened this issue Apr 7, 2016 · 4 comments
Closed

GPG Key Administration API Preview #1252

shiftkey opened this issue Apr 7, 2016 · 4 comments
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone

Comments

@shiftkey
Copy link
Member

shiftkey commented Apr 7, 2016

Summary

Recently announced on this blog post the User API has some enhancements that are now in preview mode.

Notes on Octokit Implementation

This should be similar to our IUserKeysClient

GPG Keys API

Reminder that like all functionality in "preview mode" a custom accepts header needs to be specified (see AcceptHeaders.cs)

To access the API during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.cryptographer-preview

Naming Things

So now we have two different sorts of keys to manage - Git SSH Keys (what we previously referred to as "Keys") and GPG Keys. This client should be named GpgKeys (or whatever naming style we're using for acronyms) and I'll open a separate task to rename IUserClient.Keys.

Testing Things

Testing with generated GPG keys may be tricky, but I'm open to ideas around this.

Working on this issue

As this issue follows issue has been flagged as up-for-grabs as it is a reasonably easy issue for a new contributor to pick up, and be guided through the process of contributing to octokit
(that said, if an existing contributor wants to work on this, by all means go for it!)

Please comment here if you want to take this issue.

Please read and follow the CONTRIBUTING guide guide and if you need any help, just ask! Don't be afraid to open a [WIP] (work in progress) Pull Request once you've started implementing the changes.

@hnrkndrssn
Copy link
Contributor

If no-one else has already picked this one up, I'll jump on it.

@hnrkndrssn
Copy link
Contributor

OK, so the blog post specifies the preview header as application/vnd.github.cryptographer-preview while the GPG Keys doco specifies the preview header as application/vnd.github.cryptographer-preview+sha...so the question is, which one is correct?

I'm going to go with the one from the doco for now to get started.

@hnrkndrssn hnrkndrssn mentioned this issue Jun 4, 2016
11 tasks
@shiftkey
Copy link
Member Author

shiftkey commented Jun 7, 2016

@alfhenrik both worked for me, but given History™ I'd recommend using application/vnd.github.cryptographer-preview here.

I'll speak to the team to confirm this is right and get the docs addressed.

@hnrkndrssn
Copy link
Contributor

@shiftkey cheers, I'll update my PR later tonight

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
Development

No branches or pull requests

3 participants