Improve close description support in the API.
Review Request #6412 — Created Oct. 6, 2014 and submitted
The review request resource now has a 'close_description' field that
will be set to the close description text, if provided and if closed.
This makes it easier to see the status of a review request without
digging into other resources.This also deprecates the 'description' field when closing a review
request through the API. The new argument is 'close_description', which
matches the returned value and doesn't conflict with the field.
Unit tests pass.
Verified the field through the API.
Profiled and saw that only 1 new query was added (for the changedescs
prefetch).
- Change Summary:
-
The returned close description will now be converted to the requested text format.
- Commit:
-
dbd18477420088d62a8ff00c5561fdd67a8c2861f1fd35b590989cef30d6b655abbf48f43eb2da4d
-
Tool: Pyflakes Processed Files: reviewboard/webapi/tests/test_review_request.py reviewboard/webapi/resources/review_request.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/resources/models/reviewRequestModel.js Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/tests/test_review_request.py reviewboard/webapi/resources/review_request.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/resources/models/reviewRequestModel.js
- Change Summary:
-
Fixed an issue where the old description would be returned when setting a new one, due to some caching.
- Commit:
-
f1fd35b590989cef30d6b655abbf48f43eb2da4de6e9e11fa0ce9f8635a7f98fcf104a2125ff97b0
-
Tool: Pyflakes Processed Files: reviewboard/webapi/tests/test_review_request.py reviewboard/webapi/resources/review_request.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/resources/models/reviewRequestModel.js Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/tests/test_review_request.py reviewboard/webapi/resources/review_request.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/resources/models/reviewRequestModel.js
Tool: Pyflakes Processed Files: reviewboard/webapi/tests/test_review_request.py reviewboard/webapi/resources/review_request.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/resources/models/reviewRequestModel.js Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/tests/test_review_request.py reviewboard/webapi/resources/review_request.py reviewboard/reviews/models/review_request.py Ignored Files: reviewboard/static/rb/js/resources/models/reviewRequestModel.js