Skip to content

Commit f2cbb44

Browse files
committed
fix(docs): Fix sync docs
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
1 parent ffa6a10 commit f2cbb44

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lib/create-contentful-api.js

+3
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,9 @@ export default function createContentfulApi ({
178178
/**
179179
* Synchronizes either all the content or only new content since last sync
180180
* See <a href="https://www.contentful.com/developers/docs/concepts/sync/">Synchronization</a> for more information.
181+
* <strong> Important note: </strong> The the sync api endpoint does not support include or link resolution.
182+
* However contentful.js is doing link resolution client side if you only make an initial sync.
183+
* 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.
181184
* @memberof ContentfulClientAPI
182185
* @param {Object} query - Query object for the sync call. One of initial or nextSyncToken always needs to be specified, but not both.
183186
* @param {boolean?} query.initial - Indicates if this is the first sync. Use it if you don't have a sync token.

0 commit comments

Comments
 (0)