Skip to content

Commit

Permalink
docs(kitsu): add JSON:API query parameters to Quick Start
Browse files Browse the repository at this point in the history
  • Loading branch information
wopian committed May 7, 2020
1 parent b6ca7b2 commit a5c501a
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion packages/kitsu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md>Migration guide</a> for v9 and previous major releases</p>

#
#

## Features

Expand Down Expand Up @@ -155,6 +155,22 @@ api.update('post', {

// Deleting resources
api.remove('post', 1)

// JSON:API parameters
api.get('users', {
include: 'followers,waifu.character',
fields: {
users: 'slug,followers,waifu'
}
filter: {
slug: 'wopian'
}
sort: '-id',
page: {
limit: 5,
offset: 0
}
})
```

[More Examples]
Expand Down

0 comments on commit a5c501a

Please sign in to comment.