Summary

Support including raw text fields in the API when using force-text-type.

Review Request #6436 — Created Oct. 14, 2014 and submitted Oct. 14, 2014, 1:55 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-2.0.x

Bugs

Depends On

Commit

1ce708b...

Reviewers

Groups

reviewboard

People

Description

The force-text-type= parameter in requests is useful for returning text
in a different format, but there are times when the client would need
the raw text along with this.

Now, the client can also send an include-raw-text-fields=1 parameter,
which will embed a raw_text_fields dictionary in the object's payload
containing an entry for each text field. Each entry provides the raw
version of the text. This is optional, in order to prevent the default
response from ballooning in size.

On an implementation level, this is done by removing all the custom
serializers, and instead adding some metadata to the resource's fields
list for each field that supports text types. MarkdownFieldsMixin's
serialize_object then handles embedding these raw fields in the payload
on request.

Testing Done

Tested manually wit and without the new parameter.

Unit tests pass.

Issues

Description	From	Last Updated
html isn't a valid option for POST/PUT.	david	Oct. 14, 2014, 1:44 p.m.

Tool: Pyflakes
Processed Files:
    reviewboard/webapi/resources/base_comment.py
    reviewboard/webapi/resources/review_request_draft.py
    reviewboard/webapi/tests/mixins_comment.py
    reviewboard/webapi/resources/change.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_review_request_draft.py
    reviewboard/webapi/tests/mixins_review.py
    reviewboard/webapi/resources/base_review.py
    reviewboard/webapi/mixins.py
    reviewboard/webapi/resources/review_reply.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/resources/base_comment.py
    reviewboard/webapi/resources/review_request_draft.py
    reviewboard/webapi/tests/mixins_comment.py
    reviewboard/webapi/resources/change.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_review_request_draft.py
    reviewboard/webapi/tests/mixins_review.py
    reviewboard/webapi/resources/base_review.py
    reviewboard/webapi/mixins.py
    reviewboard/webapi/resources/review_reply.py

Ship it!

reviewboard/webapi/mixins.py (Diff revision 1)

Show all issues

html isn't a valid option for POST/PUT.

chipx86 Oct. 14, 2014, 1:44 p.m.

This is just for type conversion for display. It doesn't actually post in these formats. That's what text_type= is for.

david Oct. 14, 2014, 1:47 p.m.

Maybe clarify by saying "... or ``html`` to return the given text fields in the payload using the requested format"?

Change Summary:

Clarified the wording for force-text-type to make it more clear what will happen to the fields.

Commit:

-	7f5d507312b61ba9f5065786f3b31082567b9527
+	1ce708ba4e112c96626247459dfd6d6858a7af79

Diff:

Revision 2 (+138 -56)

Show changes

	reviewboard/webapi/mixins.py
	reviewboard/webapi/resources/base_comment.py
	reviewboard/webapi/resources/base_review.py
	reviewboard/webapi/resources/change.py
	reviewboard/webapi/resources/review_reply.py
	reviewboard/webapi/resources/review_request.py
	reviewboard/webapi/resources/review_request_draft.py
	reviewboard/webapi/tests/mixins_comment.py
	2 more

Tool: Pyflakes
Processed Files:
    reviewboard/webapi/resources/base_comment.py
    reviewboard/webapi/resources/review_request_draft.py
    reviewboard/webapi/tests/mixins_comment.py
    reviewboard/webapi/resources/change.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_review_request_draft.py
    reviewboard/webapi/tests/mixins_review.py
    reviewboard/webapi/resources/base_review.py
    reviewboard/webapi/mixins.py
    reviewboard/webapi/resources/review_reply.py



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/resources/base_comment.py
    reviewboard/webapi/resources/review_request_draft.py
    reviewboard/webapi/tests/mixins_comment.py
    reviewboard/webapi/resources/change.py
    reviewboard/webapi/resources/review_request.py
    reviewboard/webapi/tests/test_review_request_draft.py
    reviewboard/webapi/tests/mixins_review.py
    reviewboard/webapi/resources/base_review.py
    reviewboard/webapi/mixins.py
    reviewboard/webapi/resources/review_reply.py

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-2.0.x (478363d)