misc-deps
/
inth-oauth2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add associated constant notes to Provider docs

This commit is contained in:
Curtis McEnroe 2016-01-25 20:28:56 -05:00
parent 0b3a52dba8
commit b70befc39d
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/provider.rs
View File

@ -13,18 +13,25 @@ pub trait Provider {
/// The authorization endpoint URI.
///
/// See [RFC 6749, section 3.1](http://tools.ietf.org/html/rfc6749#section-3.1).
///
/// Note: likely to become an associated constant.
fn auth_uri() -> &'static str;
/// The token endpoint URI.
///
/// See [RFC 6749, section 3.2](http://tools.ietf.org/html/rfc6749#section-3.2).
///
/// Note: likely to become an associated constant.
fn token_uri() -> &'static str;
/// Provider supports credentials via request body only.
/// Although not recommended by the RFC, some implementations accept client_id
/// and client_secret as a part of request only (most notable offender is vk.com).
/// Provider requires credentials via request body.
///
/// Although not recommended by the RFC, some providers require `client_id` and `client_secret`
/// as part of the request body.
///
/// See [RFC 6749, section 2.3.1](http://tools.ietf.org/html/rfc6749#section-2.3.1).
///
/// Note: likely to become an associated constant.
fn credentials_in_body() -> bool { false }
}