Summary

Fix import path of WebAPIResource in extension documentation.

Review Request #10319 — Created Nov. 11, 2018 and submitted Nov. 29, 2018, 1:25 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Commit

a51b593...

Reviewers

Groups

reviewboard

People

Description

We had a bad import path in the sample code for implementing a new

API resource in an extension. This change fixes it.

Testing Done

Built HTML.

Issues

Description	From	Last Updated
This is also incorrect. "Request" -> "request", but more importantly, it should be: from reviewboard.webapi.resources import resources ... resources.review_request In …	chipx86	Nov. 13, 2018, 11:28 p.m.
Swap these.	chipx86	Nov. 24, 2018, 12:18 p.m.
resources.review_request	chipx86	Nov. 24, 2018, 12:19 p.m.

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/webapi.rst (Diff revision 1)

The issue has been resolved. Show all issues

This is also incorrect. "Request" -> "request", but more importantly, it should be:

from reviewboard.webapi.resources import resources

...

resources.review_request


In fact, the original import (WebAPIResource) from this module was actually valid. .base is what the other resources use in order to avoid circular import issues, and no doubt we'll support both going forward, but probably we'd want to standardize on importing this from .resources.