Skip to content

Commit faa2595

Browse files
committed
fix(docs): Add more info about using search parameters
Fixes #58
1 parent 918bd8c commit faa2595

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lib/create-cda-api.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export default function createCdaApi (http, resolveLinksGlobalSetting) {
8282
/**
8383
* Gets a collection of Content Types
8484
* @memberof CDAClient
85-
* @param {Entities.Query=} query - Query object
85+
* @param {Object=} query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
8686
* @return {Promise<Entities.ContentTypeCollection>} Promise for a collection of Content Types
8787
* @example
8888
* client.getContentTypes()
@@ -111,7 +111,7 @@ export default function createCdaApi (http, resolveLinksGlobalSetting) {
111111
/**
112112
* Gets a collection of Entries
113113
* @memberof CDAClient
114-
* @param {Object=} query - Object with search parameters. Check <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">Search Parameters</a> for more details.
114+
* @param {Object=} query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
115115
* @param {boolean=} query.resolveLinks - When true, links to other Entries or Assets are resolved. Default: true.
116116
* @return {Promise<Entities.EntryCollection>} Promise for a collection of Entries
117117
* @example
@@ -142,7 +142,7 @@ export default function createCdaApi (http, resolveLinksGlobalSetting) {
142142
/**
143143
* Gets a collection of Assets
144144
* @memberof CDAClient
145-
* @param {Object=} query - Object with search parameters. Check <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">Search Parameters</a> for more details.
145+
* @param {Object=} query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
146146
* @return {Promise<Entities.AssetCollection>} Promise for a collection of Assets
147147
* @example
148148
* client.getAssets()

0 commit comments

Comments
 (0)