@@ -135,28 +135,47 @@ export default class Kitsu {
135135 * @returns {Object } JSON-parsed response
136136 * @example <caption>Getting a resource with JSON:API parameters</caption>
137137 * api.get('users', {
138- * fields: {
139- * users: 'name,birthday'
140- * },
141- * filter: {
142- * name: 'wopian'
138+ * params: {
139+ * fields: {
140+ * users: 'name,birthday'
141+ * },
142+ * filter: {
143+ * name: 'wopian'
144+ * }
143145 * }
144146 * })
145147 * @example <caption>Getting a collection of resources with their relationships</caption>
146148 * api.get('anime', {
147- * include: 'categories'
149+ * params: {
150+ * include: 'categories'
151+ * }
148152 * })
149153 * @example <caption>Getting a single resource by ID (method one)</caption>
150154 * api.get('anime/2', {
151- * include: 'categories'
155+ * params: {
156+ * include: 'categories'
157+ * }
152158 * })
153159 * @example <caption>Getting a single resource by ID (method two)</caption>
154160 * api.get('anime', {
155- * include: 'categories',
156- * filter: { id: '2' }
161+ * params: {
162+ * include: 'categories',
163+ * filter: { id: '2' }
164+ * }
157165 * })
158166 * @example <caption>Getting a resource's relationship data only</caption>
159167 * api.get('anime/2/categories')
168+ * @example <caption>Getting a resource with nested JSON:API filters (not supported by Kitsu.io's API)</caption>
169+ * // resource?filter[x][y]=value
170+ * api.get('resource', {
171+ * params: {
172+ * filter: {
173+ * x: {
174+ * y: 'value'
175+ * }
176+ * }
177+ * }
178+ * }
160179 * @example <caption>Handling errors (async/await)</caption>
161180 * try {
162181 * const { data } = await api.get('anime')
@@ -391,8 +410,10 @@ export default class Kitsu {
391410 * api.self()
392411 * @example <caption>Using JSON:API parameters</caption>
393412 * api.self({
394- * fields: {
395- * users: 'name,birthday'
413+ * params: {
414+ * fields: {
415+ * users: 'name,birthday'
416+ * }
396417 * }
397418 * })
398419 */
0 commit comments