Skip to content
This repository was archived by the owner on Jul 28, 2023. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions scribblings/github-api.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ Before you begin making requests to the GitHub api, you must create an identity.
@defstruct[github-identity ([type symbol?] [data list?])]{
This struct holds your GitHub identity.

@racket[type] must be one of the following symbols: @racket['password 'personal-token 'oauth]
@racket[type] must be one of the following symbols: @racket['password 'personal-token 'oauth2]

@racket['password] authentication
simply uses your GitHub username and password.

@racket['personal-token] authentication allows you
to send your GitHub username and a personal access token (created on your GitHub settings page.)

@racket['oauth] uses an OAuth token for authorization.
@racket['oauth2] uses an OAuth token for authorization.

For more information, see the @(hyperlink "https://developer.github.com/v3/auth/#basic-authentication"
"github api documentation")
Expand All @@ -37,7 +37,7 @@ Before you begin making requests to the GitHub api, you must create an identity.
your data will be of the form @racket[(list username password-or-token)],
where both @racket[username] & @racket[password-or-token] are strings.

For @racket['oauth], the data will simply be @racket[(list oauth-token)], where @racket[oauth-token]
For @racket['oauth2], the data will simply be @racket[(list oauth-token)], where @racket[oauth-token]
is a string.
}
@defproc[(github-api [id github-identity?]
Expand Down