Skip to content

Commit

Permalink
fix(docs): Add more info about using search parameters
Browse files Browse the repository at this point in the history
Fixes #58
  • Loading branch information
trodrigues committed Apr 5, 2016
1 parent 918bd8c commit faa2595
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lib/create-cda-api.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export default function createCdaApi (http, resolveLinksGlobalSetting) {
/**
* Gets a collection of Content Types
* @memberof CDAClient
* @param {Entities.Query=} query - Query object
* @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.
* @return {Promise<Entities.ContentTypeCollection>} Promise for a collection of Content Types
* @example
* client.getContentTypes()
Expand Down Expand Up @@ -111,7 +111,7 @@ export default function createCdaApi (http, resolveLinksGlobalSetting) {
/**
* Gets a collection of Entries
* @memberof CDAClient
* @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.
* @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.
* @param {boolean=} query.resolveLinks - When true, links to other Entries or Assets are resolved. Default: true.
* @return {Promise<Entities.EntryCollection>} Promise for a collection of Entries
* @example
Expand Down Expand Up @@ -142,7 +142,7 @@ export default function createCdaApi (http, resolveLinksGlobalSetting) {
/**
* Gets a collection of Assets
* @memberof CDAClient
* @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.
* @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.
* @return {Promise<Entities.AssetCollection>} Promise for a collection of Assets
* @example
* client.getAssets()
Expand Down

0 comments on commit faa2595

Please sign in to comment.