Skip to content

Commit a93ba91

Browse files
authored
Merge pull request #90 from Shopify/thecodepixi/correct_rest_args_table
Update rest.md arguments table to be current.
2 parents 79b4784 + e623c95 commit a93ba91

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/usage/rest.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ REST Admin API endpoints are organized by [resource](https://shopify.dev/docs/ad
1010

1111
REST uses `get`, `post`, `put`, and `delete` requests to retrieve, create, update, and delete resources respectively.
1212

13-
| Parameter | Type | Required? | Default Value | Notes |
14-
|:----------|:----------------|:---------:|:-------------:|:-------------------------------------------------|
15-
| path | string | Yes | | The URL path to request |
16-
| headers | array | No | [] | Any extra headers to send along with the request |
17-
| tries | int | No | null | How many times to attempt the request |
18-
| query | array | No | [] | Query parameters as an associative array |
19-
| body | string or array | Yes | | Only `Post`, and `put` methods can have body |
20-
| dataType | No | Yes | | Only `Post`, and `put` methods can have body |
13+
| Parameter | Type | Required? | Default Value | Notes |
14+
|:----------|:----------------|:---------:|:----------------:|:-------------------------------------------------|
15+
| path | string | Yes | | The URL path to request |
16+
| body | string or array | No | null | Only `Post`, and `put` methods can have body |
17+
| headers | array | No | [] | Any extra headers to send along with the request |
18+
| query | array | No | [] | Query parameters as an associative array |
19+
| tries | int | No | null | How many times to attempt the request |
20+
| dataType | No | No | `DATA_TYPE_JSON` | Only `Post`, and `put` methods can have body |
2121

2222
In the following example we will retrieve a list of products from a shop using `Shopify\Clients\Rest` class.
2323

0 commit comments

Comments
 (0)