Skip to content

Commit

Permalink
fix(docs): Fix sync docs
Browse files Browse the repository at this point in the history
contentful.js is doing link resolution client side if you only make an initial sync, for the second
sync it is not possible since the sdk wont have access to all the data to make such an operation.

closes #79
  • Loading branch information
Khaledgarbaya committed Jun 24, 2016
1 parent ffa6a10 commit f2cbb44
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions lib/create-contentful-api.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,9 @@ export default function createContentfulApi ({
/**
* Synchronizes either all the content or only new content since last sync
* See <a href="https://www.contentful.com/developers/docs/concepts/sync/">Synchronization</a> for more information.
* <strong> Important note: </strong> The the sync api endpoint does not support include or link resolution.
* However contentful.js is doing link resolution client side if you only make an initial sync.
* For the delta sync (using nextSyncToken) it is not possible since the sdk wont have access to all the data to make such an operation.
* @memberof ContentfulClientAPI
* @param {Object} query - Query object for the sync call. One of initial or nextSyncToken always needs to be specified, but not both.
* @param {boolean?} query.initial - Indicates if this is the first sync. Use it if you don't have a sync token.
Expand Down

0 comments on commit f2cbb44

Please sign in to comment.