• 
      

    Add documentation on API tokens.

    Review Request #6155 — Created July 28, 2014 and submitted

    Information

    Review Board
    master
    f5533a3...

    Reviewers

    This adds documentation on authenticating with API tokens and writing
    custom API policies.

    The authentication docs now cover how to log in with either API tokens
    or a username/password. Some of the existing docs here are also fleshed
    out to create better examples.

    The new API token policy docs cover the structure of policies, the
    various sections of the policy, how they affect access, and some tips.
    This will complement the UI for editing tokens, which is currently in
    development.

    All API resource pages now also contain the policy IDs for use in the
    policies.

    Built the docs and read through them. Didn't see any errors from these pages.

    Checked the resource docs and saw the payload IDs.

    Description From Last Updated

    "handy" is a bit colloquial. How about "useful"?

    daviddavid
    reviewbot
    1. Tool: Pyflakes
      Processed Files:
          docs/manual/_ext/webapidocs.py
      
      Ignored Files:
          docs/manual/webapi/2.0/api-token-policy.rst
          docs/manual/webapi/2.0/authenticating.rst
          docs/manual/webapi/2.0/index.rst
      
      
      
      Tool: PEP8 Style Checker
      Processed Files:
          docs/manual/_ext/webapidocs.py
      
      Ignored Files:
          docs/manual/webapi/2.0/api-token-policy.rst
          docs/manual/webapi/2.0/authenticating.rst
          docs/manual/webapi/2.0/index.rst
      
      
    2. 
        
    david
    1. 
        
    2. Show all issues

      "handy" is a bit colloquial. How about "useful"?

    3. 
        
    chipx86
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to master (e625b89)