Skip to content

Commit

Permalink
Turned option list into a table
Browse files Browse the repository at this point in the history
  • Loading branch information
Nyholm committed May 6, 2015
1 parent caefddb commit 7dc9df0
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,16 @@ $options = array(
### The api options

The third parameter of `LinkedIn::api` is an array with options. They will eventually be past to a Request client but
before that we do some modifications. Below is a list of array keys that you may use.

* **body**: The body of a HTTP request. Put your xml string here.
* **format**: Set this to 'json' or 'xml' to override the default value.
* **headers**: This is HTTP headers to the request
* **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.
* **query**: This is an array with query parameters
before that we do some modifications. Below is a table of array keys that you may use.

| Option name | Description
| ----------- | -----------
| body | The body of a HTTP request. Put your xml string here.
| debug | This will echo the all the request and response headers. (Works with the Guzzle client only)
| format | Set this to 'json', 'xml' or 'simple_xml' to override the default value.
| headers | This is HTTP headers to the request
| 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.
| query | This is an array with query parameters

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)
to find out what more options that are available.
Expand Down

0 comments on commit 7dc9df0

Please sign in to comment.