Permalink
Browse files

Clarify examples

Note that the felds[] typo is intentional (see #942), and use felds[people] rather than felds[author] since "people" is much more likely to be a type name than "author" (and, given the discussion on discuss, we want to make it clear that `fields` refers to type names and not relationship paths).
  • Loading branch information...
1 parent ea33697 commit 880834a4e70678deb2370964e7bbd51b58b20859 @ethanresnick ethanresnick committed Dec 9, 2015
Showing with 3 additions and 3 deletions.
  1. +3 −3 examples/index.md
View
@@ -414,6 +414,6 @@ ignore an invalid parameter and have the request succeed, rather than respond wi
an error. [API-specific query parameters must contain one non a-z
character.](http://jsonapi.org/format/#query-parameters)
-Other examples of invalid parameters include: `?felds[author]=` (invalid parameter name)
-and `?redirect_to=http%3A%2F%2Fwww.owasp.org` (invalid parameter, in this case,
-a phishing attack), etc.
+Other examples of invalid parameters include: `?felds[people]=` (invalid parameter name;
+should be `fields[people]`) and `?redirect_to=http%3A%2F%2Fwww.owasp.org` (invalid parameter,
+in this case, a phishing attack), etc.

0 comments on commit 880834a

Please sign in to comment.