RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #573 from jcrombez/patch-1

Browse Source 
[doc] missing "sandbox:" in the authentication yaml examples
This commit is contained in:
William Durand 2015-02-06 16:04:01 +01:00
commit e23a7d7d66
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Resources/doc/index.md
View File

@ -397,21 +397,24 @@ You can choose between different authentication methods:
```yaml
# app/config/config.yml
nelmio_api_doc:
authentication:
delivery: header
name: X-Custom
sandbox:
authentication:
delivery: header
name: X-Custom
# app/config/config.yml
nelmio_api_doc:
authentication:
delivery: query
name: param
sandbox:
authentication:
delivery: query
name: param
# app/config/config.yml
nelmio_api_doc:
authentication:
delivery: http
type: basic # or bearer
sandbox:
authentication:
delivery: http
type: basic # or bearer
```
When choosing an `http` delivery, `name` defaults to `Authorization`,
and the header value will automatically be prefixed by the corresponding type (ie. `Basic` or `Bearer`).