Skip to content

Commit bdfa430

Browse files
committed
Fix grammar
1 parent 60aba26 commit bdfa430

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/sparse_fieldsets.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Sparse fieldsets
55

66
.. currentmodule:: flask_rest_jsonapi
77

8-
You can restrict the fields returned by api with the querystring parameter called "fields". It is very useful for performance purpose because fields not returned are not resolved by api. You can use "fields" parameter on any kind of route (classical CRUD route or relationships route) and any kind of http methods as long as method return data.
8+
You can restrict the fields returned by your API using the query string parameter called "fields". It is very useful for performance purposes because fields not returned are not resolved by the API. You can use the "fields" parameter on any kind of route (classical CRUD route or relationships route) and any kind of HTTP methods as long as the method returns data.
99

1010
.. note::
1111

12-
Examples are not urlencoded for a better readability
12+
Examples are not URL encoded for better readability
1313

14-
The syntax of a fields is like that ::
14+
The syntax of the fields parameter is ::
1515

1616
?fields[<resource_type>]=<list of fields to return>
1717

@@ -22,20 +22,20 @@ Example:
2222
GET /persons?fields[person]=display_name HTTP/1.1
2323
Accept: application/vnd.api+json
2424

25-
In this example person's display_name is the only field returned by the api. No relationships links are returned so the response is very fast because api doesn't have to compute relationships link and it is a very costly work.
25+
In this example person's display_name is the only field returned by the API. No relationship links are returned so the response is very fast because the API doesn't have to do any expensive computation of relationship links.
2626

2727
You can manage returned fields for the entire response even for included objects
2828

2929
Example:
3030

31-
If you don't want to compute relationships links for included computers of a person you can do something like that
31+
If you don't want to compute relationship links for included computers of a person you can do something like this
3232

3333
.. sourcecode:: http
3434

3535
GET /persons/1?include=computers&fields[computer]=serial HTTP/1.1
3636
Accept: application/vnd.api+json
3737

38-
And of course you can combine both like that:
38+
And of course you can combine both like this:
3939

4040
Example:
4141

@@ -46,4 +46,4 @@ Example:
4646

4747
.. warning::
4848

49-
If you want to use both "fields" and "include" don't forget to specify the name of the relationship in fields; if you don't the include wont work.
49+
If you want to use both "fields" and "include", don't forget to specify the name of the relationship in "fields"; if you don't, the include wont work.

0 commit comments

Comments
 (0)