chipx86 got a fish trophy!

Summary

Add support for returning only certain fields or links in the API.

Review Request #6776 — Created Jan. 15, 2015 and submitted Feb. 3, 2015, 1:32 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

master

Bugs

Depends On

Commit

d5d0062...

Reviewers

Groups

djblets

People

Description

API resources now support a couple new query arguments for limiting the
results in a payload, in order to reduce database queries and payload
sizes.

The ?only-fields= query argument limits the returned fields in the
payload to the comma-separated list of field names. If the value is
blank, then no fields will be returned, leaving only links.

Likewise, the ?only-links= query argument limits the returned links in the
payload. It behaves exactly like ?only-fields=.

Resources that inject custom fields into the payload outside of
serialize_object() can call get_only_fields() and get_only_links() to
determine whether to include specific fields.

Testing Done

Unit tests pass.

Tested this pretty extensively with changes to rbt post and with custom
curl commands on several resources in Review Board.

Issues

Description	From	Last Updated
list comprehension redefines 'value' from line 1051	reviewbot	Jan. 15, 2015, 2:16 a.m.

Tool: Pyflakes
Processed Files:
    djblets/webapi/decorators.py
    djblets/webapi/resources.py
    djblets/webapi/tests.py



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/decorators.py
    djblets/webapi/resources.py
    djblets/webapi/tests.py

djblets/webapi/resources.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 list comprehension redefines 'value' from line 1051
```

Change Summary:

Fixed a reused variable in a list comprehension.

Commit:

-	711ed271c7e26b898e6a78cf886c2d05c3ca3ee6
+	8645e7929528fe737c2ea5c685c5a0b1f4d72dcb

Diff:

Revision 2 (+303 -25)

Show changes

	djblets/webapi/decorators.py
	djblets/webapi/resources.py
	djblets/webapi/tests.py

Tool: Pyflakes
Processed Files:
    djblets/webapi/decorators.py
    djblets/webapi/resources.py
    djblets/webapi/tests.py



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/decorators.py
    djblets/webapi/resources.py
    djblets/webapi/tests.py

```
Should this include docs?
```

Change Summary:

Added some docs on limiting payload contents.

Branch:

-	release-0.8.x
+	master

Commit:

-	8645e7929528fe737c2ea5c685c5a0b1f4d72dcb
+	d5d00623691fbd9885fc2badca103d54b0bd0599

Diff:

Revision 3 (+324 -25)

Show changes

	djblets/webapi/decorators.py
	djblets/webapi/resources.py
	djblets/webapi/tests.py

Tool: Pyflakes
Processed Files:
    djblets/webapi/decorators.py
    djblets/webapi/resources.py
    djblets/webapi/tests.py



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/decorators.py
    djblets/webapi/resources.py
    djblets/webapi/tests.py

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to master (bc08cbf)

djblets/webapi/resources.py (Diff revision 1)