Skip to content

Commit 7dc9df0

Browse files
committed
Turned option list into a table
1 parent caefddb commit 7dc9df0

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

Readme.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -126,13 +126,16 @@ $options = array(
126126
### The api options
127127

128128
The third parameter of `LinkedIn::api` is an array with options. They will eventually be past to a Request client but
129-
before that we do some modifications. Below is a list of array keys that you may use.
130-
131-
* **body**: The body of a HTTP request. Put your xml string here.
132-
* **format**: Set this to 'json' or 'xml' to override the default value.
133-
* **headers**: This is HTTP headers to the request
134-
* **json**: This is an array with json data that will be encoded to a json string. Using this option you do need to specify a format.
135-
* **query**: This is an array with query parameters
129+
before that we do some modifications. Below is a table of array keys that you may use.
130+
131+
| Option name | Description
132+
| ----------- | -----------
133+
| body | The body of a HTTP request. Put your xml string here.
134+
| debug | This will echo the all the request and response headers. (Works with the Guzzle client only)
135+
| format | Set this to 'json', 'xml' or 'simple_xml' to override the default value.
136+
| headers | This is HTTP headers to the request
137+
| json | This is an array with json data that will be encoded to a json string. Using this option you do need to specify a format.
138+
| query | This is an array with query parameters
136139

137140
If you are using the `GuzzleRequest` (default) you may want to have a look at [its documentation](http://docs.guzzlephp.org/en/latest/clients.html?highlight=format#request-options)
138141
to find out what more options that are available.

0 commit comments

Comments
 (0)