Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added example of good/bad responses.

	modified:   README.md
  • Loading branch information...
commit 5716cfb488f5b0ef78d271636346c8e6a42e294d 1 parent 3771f72
@bryanhirsch bryanhirsch authored
Showing with 21 additions and 4 deletions.
  1. +21 −4 README.md
View
25 README.md
@@ -85,11 +85,28 @@ These guidelines aim to support a truly RESTful API. Here are a few exceptions:
## Responses
-@todo Add good v. bad examples below for:
+* No values in keys
+* No internal-specific names (e.g. "node" and "taxonomy term")
+* Metadata should only contain direct properties of the response set, not properties of the members of the response set
-* no values in keys
-* no internal-specific names (e.g. "node" and "taxonomy term")
-* metadata should only contain direct properties of the response set, not properties of the members of the response set
+### Good examples
+
+No values in keys:
+
+ "tags": [
+ {"id": "125", "name": "Environment"},
+ {"id": "834", "name": "Water Quality"}
+ ],
+
+
+### Bad examples
+
+Values in keys:
+
+ "tags": [
+ {"125": "Environment"},
+ {"834": "Water Quality"}
+ ],
## Error handling
Please sign in to comment.
Something went wrong with that request. Please try again.