Skip to content

Commit 172e514

Browse files
committed
Readme formatting
1 parent d8e2862 commit 172e514

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -102,34 +102,34 @@ composer require pelmered/laravel-http-client-auth-helper
102102

103103
## Options reference
104104

105-
#### scopes - `array`
105+
### scopes - `array`
106106
Scopes to send when requesting an access token.
107107
Typically only used for OAuth2 flows.\
108108
**Possible options:** array with strings
109109
**Default:** `[]`
110110

111-
#### authType - `string`
111+
### authType - `string`
112112
The type of authorization for the refresh token request.\
113113
**Possible options:** `Credentials::AUTH_TYPE_BEARER`, `Credentials::AUTH_TYPE_BODY`, `Credentials::AUTH_TYPE_QUERY`, `Credentials::AUTH_TYPE_BASIC`, `Credentials::AUTH_TYPE_CUSTOM`,\
114114
**Default:** `Credentials::AUTH_TYPE_BEARER` (=`'Bearer'`)
115115

116-
#### grantType - `string`
116+
### grantType - `string`
117117
Grant type for OAuth2 flows.
118118
**Possible options:** `Credentials::GRANT_TYPE_CLIENT_CREDENTIALS`, `Credentials::GRANT_TYPE_PASSWORD_CREDENTIALS` (authorization_code and implicit grants are not yet supported. See [issue #3](https://github.com/pelmered/laravel-http-client-auth-helper/issues/3))
119119
**Default:** `Credentials::GRANT_TYPE_CLIENT_CREDENTIALS` (=`'client_credentials'`)
120120

121-
#### tokenType - `string`
121+
### tokenType - `string`
122122
How the access token should be applied to all subsequent requests.
123123

124124
**Possible options:** `AccessToken::TOKEN_TYPE_BEARER`,`AccessToken::TOKEN_TYPE_QUERY`,`AccessToken::TOKEN_TYPE_CUSTOM`,
125125
**Default:** `AccessToken::TOKEN_TYPE_BEARER` (=`'Bearer'`)
126126

127-
#### tokenName - `string`
127+
### tokenName - `string`
128128
The name of the token field. This only applies for when the token is applied as a query parameter or to the body of the request.
129129
**Possible options:** Any string
130130
**Default:** `'token'`
131131

132-
#### expires - `int|string|Closure|Carbon`
132+
### expires - `int|string|Closure|Carbon`
133133
This determines when the access token expires.\
134134
**Possible options:** \
135135
integer - for how long until expiry in seconds)\
@@ -138,26 +138,26 @@ Closure - A closure that receives the refresh response and can return any other
138138
Carbon - A Carbon object with the time of the expiry.\
139139
**Default:** 3600
140140

141-
#### accessToken - `string|Closure`
141+
### accessToken - `string|Closure`
142142
This is where the access token can be found on the refresh response.\
143143
**Possible options:**\
144144
string - The key of the access token in the refresh response.\
145145
Closure - A closure that receives the refresh response and should return the token as a string.\
146146
**Default:** `'access_token'`
147147

148-
#### tokenTypeCustomCallback - `?Closure`
148+
### tokenTypeCustomCallback - `?Closure`
149149
A callback for giving dull control of how the authentication should be applied.
150150
The closure receives the Http client and should return a new Http Client where the auth information has been appended.\
151151
**Possible options:**\ Any closure that returns a Http Client (`Illuminate\Http\Client\PendingRequest`).\
152152
**Default:** `null`
153153

154-
#### cacheKey - `?string`
154+
### cacheKey - `?string`
155155
The cache key that should be used to save the access tokens.
156156
If left empty, it will be generated based on the refresh URL.\
157157
**Possible options:**\
158158
**Default:** `null`
159159

160-
#### cacheDriver - `?string`
160+
### cacheDriver - `?string`
161161
The cache driver/store that should be used for storing the access tokens.
162162
If left empty, the Laravel default will be used.\
163163
**Possible options:**\

0 commit comments

Comments
 (0)