| Subject: | Documentation on the token_scheme parameter |
I'm working now with the GitHub API, and it seen to want that the auth header will have the
'bearer' string inside, and in the terms of this module, I had to specify in
Net::OAuth2::Profile::WebServer->new:
token_scheme => 'auth-header:Bearer',
It probably should be documented that you chose to use the 'OAuth' string there, even if it is
not standard. Also document the different options. something like:
-----------
Specify the method to submit authenticated requests to the service. By default, add the access
token as a header, such as: "Authorization: OAuth TOKEN".
Some services require that the header will be different, i.e. "Authorization: Bearer TOKEN", for
which case specify token_scheme => 'auth-header:Bearer'.
To add the access token as a uri-parameter: 'uri-query:oauth_token' (in this case, the
parameter name will be oauth_token)
To add the access token inside a form body: 'form-body:oauth_token'
-----------
I'm sure that the it can be greatly improve, as English is not my first language...
Thanks for the module,
Shmuel.