Summary

Add API docs for status updates.

Review Request #8548 — Created Nov. 20, 2016 and submitted Nov. 23, 2016, 12:22 a.m.

Information

Owner

david

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Commit

e5ea0f2...

Reviewers

Groups

reviewboard

People

Description

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.

Testing Done

Built HTML docs and verified the results.

Issues

Description	From	Last Updated
This can be: if getattr(resource, 'required_features', False):	chipx86	Nov. 23, 2016, 12:15 a.m.
kwargs is {} so why do we need it here? Does create_fake_resource_path fill it?	brennie	Nov. 21, 2016, 9:59 p.m.

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

docs/manual/_ext/webapidocs.py (Diff revision 1)

The issue has been dropped. Show all issues

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

david Nov. 21, 2016, 9:32 p.m.
```
I'm not sure. Christian?
```

david Nov. 21, 2016, 9:58 p.m.

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.

Ship it!

docs/manual/_ext/webapidocs.py (Diff revision 1)

The issue has been resolved. Show all issues

This can be:

if getattr(resource, 'required_features', False):

Status:: Completed
Change Summary:: Pushed to release-3.0.x (67a0278)