-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for items-feed endpoint #84
Labels
Comments
+1 this is sorely missed from the delivery SDK. any indication of when this might be looked at? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Motivation
Allow developers to fetch all content item variants from the new
\items-feed
endpoint. This offers developers a way to export an entire project no matter the size.Proposed solution
The content is is provided in small chunks together with a continuation token for the next chunk. The continuation token is sent in
X-Continuation
header both for request and response. Should the response from Delivery API contain the token, there are additional items to fetch. If the request does not contain the continuation header, Delivery API will return the first chunk.Filtering parameters are same as for
items
endpoint but paging and depth are not supported.The response has also the similar structure to
items
endpoint but paging object is missing andmodular_content
contains only components.Implementation details for consistency: (name casing should be adapted according to the rest of SDK)
Add a new method to
DeliveryClient
with a nameGetItemsFeed()
. The method should support the same filtering parameters asGetItems()
except for depth, skip and limit and return a content items variants feed.The feed contains a bool property
HasMoreResults
that is true if the first batch was not yet fetched or there are more items to fetch (indicated by a continuation header in the previous response). The feed also contains a methodFetchNextBatch()
that would retrieve the next response from\items-feed
endpoint.Additional context
See .NET SDK for reference code
The text was updated successfully, but these errors were encountered: