Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
dev:web_api:v3:changes_from_v2 [2014/07/02 13:31] dstillmandev:web_api:v3:changes_from_v2 [2017/11/27 04:12] bwiernik
Line 8: Line 8:
     * ''meta'' contains non-editable system-generated properties like ''createdByUser''/ ''lastModifiedByUser'' (for group items), ''creatorSummary'', and ''numChildren''.     * ''meta'' contains non-editable system-generated properties like ''createdByUser''/ ''lastModifiedByUser'' (for group items), ''creatorSummary'', and ''numChildren''.
     * Other Atom-specific feed properties (''title'', ''author'', ''published'', ''updated'') have been removed.     * Other Atom-specific feed properties (''title'', ''author'', ''published'', ''updated'') have been removed.
 +    * Clients sending ''application/atom+xml'' in the ''Accept'' header will continue to receive Atom responses if no other format is requested
   * For ''format=json'', ''include=data'' has replaced Atom's ''content=json'' and is now the default mode, with a top-level ''data'' object containing the editable fields. As with ''content'', additional comma-separated types can be requested (e.g., ''include=data,bib''). The requested types are provided as top-level properties. ''content=html'' remains the default in Atom.   * For ''format=json'', ''include=data'' has replaced Atom's ''content=json'' and is now the default mode, with a top-level ''data'' object containing the editable fields. As with ''content'', additional comma-separated types can be requested (e.g., ''include=data,bib''). The requested types are provided as top-level properties. ''content=html'' remains the default in Atom.
   * Multi-object writes now take an array of JSON objects directly, rather than an object with an ''items''/''collections''/''searches'' property containing an array.   * Multi-object writes now take an array of JSON objects directly, rather than an object with an ''items''/''collections''/''searches'' property containing an array.
Line 33: Line 34:
 ==== tl;dr for existing Atom consumers ==== ==== tl;dr for existing Atom consumers ====
  
 +  * Request ''format=atom'' explicitly, or send ''application/atom+xml'' in the ''Accept'' header
   * Use ''zapi:parsedDate'' instead of ''zapi:year''   * Use ''zapi:parsedDate'' instead of ''zapi:year''
   * Use ''Total-Results'' HTTP header instead of ''zapi:totalResults''   * Use ''Total-Results'' HTTP header instead of ''zapi:totalResults''
dev/web_api/v3/changes_from_v2.txt · Last modified: 2022/06/23 15:54 by dstillman