aboutsummaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorrr-2016-06-11 18:02:40 +0200
committerrr-2016-06-11 22:33:33 +0200
commite9fb93d5c8b5c56381efedf1a5572da4c96b2f45 (patch)
treeb2506e06e57cf07cb2f3c02064d93af9cb2d1b9b /API.md
parent9e13c055178e1a43bba85f49b393473ce8017085 (diff)
server/general: rename _fields to fields
Diffstat (limited to 'API.md')
-rw-r--r--API.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/API.md b/API.md
index 6a4ed37..e1f1ae7 100644
--- a/API.md
+++ b/API.md
@@ -129,14 +129,14 @@ For performance considerations, sometimes the client might want to choose the
fields the server sends to it in order to improve the query speed. This
customization is available for top-level fields of most of the
[resources](#resources). To choose the fields, the client should pass
-`?_fields=field1,field2,...` suffix to the query. This works regardless of the
+`?fields=field1,field2,...` suffix to the query. This works regardless of the
requesttype (`GET`, `PUT` etc.).
For example, to list posts while getting only their IDs and tags, the client
should send a `GET` query like this:
```
-GET /posts/?_fields=id,tags
+GET /posts/?fields=id,tags
```

© 2015 - 2026 Jakob L. Kreuze