Add API docs for status updates.

Review Request #8548 — Created Nov. 20, 2016 and submitted

Information

Review Board
release-3.0.x
e5ea0f2...

Reviewers

This change adds the stub files and fixture data to generate API documentation
for the status updates resource. In doing this, I found that the examples for
this were showing 401 errors rather than the actual data, because of the new
required_features flag. I've added support for this to the API extension in a
couple ways. First, we temporarily enable the feature while doing the requests
to form the examples. Second, the required features are listed in the
documentation output.

Built HTML docs and verified the results.

Description From Last Updated

This can be: if getattr(resource, 'required_features', False):

chipx86chipx86

kwargs is {} so why do we need it here? Does create_fake_resource_path fill it?

brenniebrennie
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/_ext/webapidocs.py
    
    Ignored Files:
        docs/manual/webapi/2.0/resources/status-update.rst
        docs/manual/webapi/2.0/resources/status-update-list.rst
        docs/manual/fixtures/initial_data.json
        docs/manual/webapi/2.0/resources/index.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/_ext/webapidocs.py
    
    Ignored Files:
        docs/manual/webapi/2.0/resources/status-update.rst
        docs/manual/webapi/2.0/resources/status-update-list.rst
        docs/manual/fixtures/initial_data.json
        docs/manual/webapi/2.0/resources/index.rst
    
    
  2. 
      
brennie
  1. 
      
  2. docs/manual/_ext/webapidocs.py (Diff revision 1)
     
     
    Show all issues

    kwargs is {} so why do we need it here? Does create_fake_resource_path fill it?

    1. I'm not sure. Christian?

    2. OK, I actually looked at the code, and yes, create_fake_resource_path fills in kwargs to contain all the necessary IDs for parent resources and such.

  3. 
      
chipx86
  1. 
      
  2. docs/manual/_ext/webapidocs.py (Diff revision 1)
     
     
     
    Show all issues

    This can be:

    if getattr(resource, 'required_features', False):
    
  3. 
      
david
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (67a0278)
Loading...