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

[doc] fix sandbox doc

Browse Source
This commit is contained in:
William DURAND 2014-01-10 11:29:10 +01:00
parent eca2eb6d80
commit 5e1bf1fbda
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Resources/doc/index.md
View File

@ -299,13 +299,12 @@ configure this sandbox using the following parameters:
# app/config/config.yml # app/config/config.yml
nelmio_api_doc: nelmio_api_doc:
sandbox: sandbox:
authentication: # default is `~` (`null`), if set, the value of the api authentication: # default is `~` (`null`), if set, the sandbox automatically
# key is read from the query string and appended to every # send authenticated requests using the configured `delivery`
# sandbox api call.
name: access_token # access token name, or query parameter name, or header name name: access_token # access token name or query parameter name or header name
delivery: query # query, http_basic, and header are supported delivery: query # `query`, `http_basic`, and `header` are supported
custom_endpoint: true # default is `false`, if `true`, your user will be able to custom_endpoint: true # default is `false`, if `true`, your user will be able to
# specify its own endpoint # specify its own endpoint
@ -320,13 +319,15 @@ configure this sandbox using the following parameters:
# automatically populated as the `Accept` header # automatically populated as the `Accept` header
body_format: form # default is `form`, determines whether to send body_format: form # default is `form`, determines whether to send
# `x-www-form-urlencoded` data or json-encoded data # `x-www-form-urlencoded` data or json-encoded
# in sandbox requests # data (by setting this parameter to `json`) in
# sandbox requests
request_format: request_format:
method: format_param # default format_param, alternately accept_header, method: format_param # default `format_param`, alternately `accept_header`,
# decides how to request the response format # decides how to request the response format
default_format: json # default json, alternately xml, determines which default_format: json # default `json`, alternately `xml`, determines which
# content format to request back by default # content format to request back by default
### Command ### Command