Skip to content

Update rest.md arguments table to be current. #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thecodepixi merged 1 commit into from
Aug 9, 2021
Merged

Update rest.md arguments table to be current. #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/usage/rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ REST Admin API endpoints are organized by [resource](https://shopify.dev/docs/ad

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

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

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

Expand Down