From df857d3a84e0c07efc7d4dbca59ec37a716004f5 Mon Sep 17 00:00:00 2001 From: Kohsuke Kawaguchi Date: Tue, 16 Apr 2013 12:14:06 -0700 Subject: [PATCH] doc improvement --- .../java/org/kohsuke/github/GHAuthorization.java | 4 ++++ src/main/java/org/kohsuke/github/GitHub.java | 13 ++++++++++--- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/kohsuke/github/GHAuthorization.java b/src/main/java/org/kohsuke/github/GHAuthorization.java index 711be454c..dae2c7411 100644 --- a/src/main/java/org/kohsuke/github/GHAuthorization.java +++ b/src/main/java/org/kohsuke/github/GHAuthorization.java @@ -1,12 +1,16 @@ package org.kohsuke.github; import java.net.URL; +import java.util.Collection; import java.util.Date; import java.util.List; /** + * Generated OAuth token * * @author janinko + * @see GitHub#createToken(Collection, String, String) + * @see http://developer.github.com/v3/oauth/#create-a-new-authorization */ public class GHAuthorization { public static final String USER = "user"; diff --git a/src/main/java/org/kohsuke/github/GitHub.java b/src/main/java/org/kohsuke/github/GitHub.java index 889a5e93e..6c7999492 100644 --- a/src/main/java/org/kohsuke/github/GitHub.java +++ b/src/main/java/org/kohsuke/github/GitHub.java @@ -306,11 +306,18 @@ public class GitHub { return requester.method("POST").to("/user/repos", GHRepository.class).wrap(this); } + /** + * Creates a new authorization. + * + * The token created can be then used for {@link GitHub#connectUsingOAuth(String)} in the future. + * + * @see http://developer.github.com/v3/oauth/#create-a-new-authorization + */ public GHAuthorization createToken(Collection scope, String note, String noteUrl) throws IOException{ Requester requester = new Requester(this) - .with("scopes",scope) - .with("note",note) - .with("note_url",noteUrl); + .with("scopes", scope) + .with("note", note) + .with("note_url", noteUrl); return requester.method("POST").to("/authorizations", GHAuthorization.class).wrap(this); }