Add documentation for the new webhook resource.

Review Request #7524 — Created July 14, 2015 and submitted

Information

Review Board
release-2.5.x
f7e9425...

Reviewers

This change adds the pieces needed to generate docs for the new webhook
resource. Specifically, it adds new doc entries for webhook-list and webhook,
links in the index, and a fixture to auto-generate examples from.

While I was doing this, I encountered lots of trouble because the types for the
apply_to, encoding, and type fields weren't correct (they were lists of
specific strings rather than just being a generic six.text_type). This was
causing the docs to fail to build in a cryptic way as the webapi-resource
sphinx class tried to import "a.ll"

Build docs and looked at the results.

Description From Last Updated

It was actually correct before, except that it should have been a tuple, not a list. Tuples define possible choices, …

chipx86chipx86

Same here.

chipx86chipx86

And here, and the others like this.

chipx86chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        reviewboard/webapi/resources/webhook.py
    
    Ignored Files:
        docs/manual/webapi/2.0/resources/webhook.rst
        docs/manual/fixtures/initial_data.json
        docs/manual/webapi/2.0/resources/index.rst
        docs/manual/webapi/2.0/resources/webhook-list.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        reviewboard/webapi/resources/webhook.py
    
    Ignored Files:
        docs/manual/webapi/2.0/resources/webhook.rst
        docs/manual/fixtures/initial_data.json
        docs/manual/webapi/2.0/resources/index.rst
        docs/manual/webapi/2.0/resources/webhook-list.rst
    
    
  2. 
      
chipx86
  1. 
      
  2. reviewboard/webapi/resources/webhook.py (Diff revision 1)
     
     
    Show all issues

    It was actually correct before, except that it should have been a tuple, not a list. Tuples define possible choices, and validation will take those into account.

  3. reviewboard/webapi/resources/webhook.py (Diff revision 1)
     
     
    Show all issues

    Same here.

  4. reviewboard/webapi/resources/webhook.py (Diff revision 1)
     
     
    Show all issues

    And here, and the others like this.

  5. 
      
david
reviewbot
  1. Tool: PEP8 Style Checker
    Processed Files:
        reviewboard/notifications/models.py
        reviewboard/webapi/resources/webhook.py
    
    Ignored Files:
        docs/manual/webapi/2.0/resources/web-hook.rst
        docs/manual/fixtures/initial_data.json
        docs/manual/webapi/2.0/resources/index.rst
        docs/manual/webapi/2.0/resources/web-hook-list.rst
    
    
    
    Tool: Pyflakes
    Processed Files:
        reviewboard/notifications/models.py
        reviewboard/webapi/resources/webhook.py
    
    Ignored Files:
        docs/manual/webapi/2.0/resources/web-hook.rst
        docs/manual/fixtures/initial_data.json
        docs/manual/webapi/2.0/resources/index.rst
        docs/manual/webapi/2.0/resources/web-hook-list.rst
    
    
  2. 
      
chipx86
  1. Ship It!
  2. 
      
david
Review request changed
Status:
Completed
Change Summary:
Pushed to release-2.5.x (c6ac08b)