Changelog
2.0.0
Updated on Tue Mar 16, 2021.
New Features
- Nested
metadataprops are now possible without limit. See examples of nested props. - No depth limit for Object relationships. The only limit is the prevention of infinite recursion.
- We now offer a Postman collection to review and demo all REST API methods.
- You can now use the
afterparam for Object pagination (experimental). - We now have endpoints for
MetafieldsandMedia Foldersto do CRUD operations directly.
Improvements
- Lighter codebase, faster endpoints. In some cases, endpoint response times are up to 50% faster (non-cached).
- Better endpoint structures that follow standard REST conventions such as
POST /resources,GET /resources/:resource_id, etc. - Consistent error responses with verbose messages.
- The Select Dropdown Metafield now includes both
keyandvaluein the API response.
Changes
_idhas been changed toid.type_slughas been changed totype.statuscan now either bepublishedorany(which returns latest Object version draft or published).queryis now the primary method for fetching and filtering Objects (Advanced Queries from v1). See Queries and Logic for examples.- Single Objects must now be fetched using
id. To fetch byslug, you will need to usequery. write_keywill now be required in the request header asAuthorization Bearer.metafieldsare hidden by default.- Stricter user input requirements. No additional fields are possible in the body for
POSTandPATCHrequests. - There is a new, more secure token authentication strategy.