Add documentation on working with extra_data in the API.

Review Request #9381 — Created Nov. 16, 2017 and submitted

Information

Review Board
release-3.0.x
98fc90e...

Reviewers

This adds a new page that covers how to store extra_data on resources
using the old assignment method and the newer merging/patching methods.
It covers usage in detail and links to the specs for more information.
It also talks about access restrictions, including the prefix for
private keys and the impact of APIExtraDataAccessHook.

All resources that use extra_data now link to the new docs. Some of the
older resources that talked about assignment have now had that
information removed in favor of the new page.

Built and read through the new docs. Checked for build issues, spelling
mistakes, and all links.

Description From Last Updated

"dictionary objects" is redundant, since this is JSON. Should just be "objects"

daviddavid

Should use the word "objects" instead of "dictionaries", since this is JSON.

daviddavid

dictionary -> object. Same throughout.

daviddavid
david
  1. 
      
  2. docs/manual/webapi/2.0/extra-data.rst (Diff revision 1)
     
     
    Show all issues

    "dictionary objects" is redundant, since this is JSON. Should just be "objects"

  3. docs/manual/webapi/2.0/extra-data.rst (Diff revision 1)
     
     
    Show all issues

    Should use the word "objects" instead of "dictionaries", since this is JSON.

  4. docs/manual/webapi/2.0/extra-data.rst (Diff revision 1)
     
     
    Show all issues

    dictionary -> object. Same throughout.

  5. 
      
chipx86
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (14e354d)
Loading...