additional request examples

Author: jaredcnance

docs/request-examples/001-CREATE_Article.sh

@@ -5,7 +5,7 @@ curl -vs http://localhost:5001/api/articles         \
             "data": {
                 "type": "articles",
                 "attributes": {
-                    "title": "test"
+                    "title": "Moby"
                 },
                 "relationships": {
                     "author": {

docs/request-examples/005-PATCH_Article.sh

@@ -0,0 +1,12 @@
+curl -vs http://localhost:5001/api/people/1       \
+    -H "Accept: application/vnd.api+json"           \
+    -H "Content-Type: application/vnd.api+json"     \
+    -X PATCH                                        \
+    -d '{
+            "data": {
+                "type": "people",
+                "attributes": {
+                    "name": "Bob"
+                }
+            }
+        }'

docs/request-examples/006-DELETE_Article.sh

@@ -0,0 +1,3 @@
+curl -vs http://localhost:5001/api/articles/1     \
+    -H "Accept: application/vnd.api+json"           \
+    -X DELETE

docs/request-examples/007-__SEED__.sh

@@ -0,0 +1,31 @@
+curl -vs http://localhost:5001/api/people           \
+    -H "Accept: application/vnd.api+json"           \
+    -H "Content-Type: application/vnd.api+json"     \
+    -d '{
+            "data": {
+                "type": "people",
+                "attributes": {
+                    "name": "Alice"
+                }
+            }
+        }'
+
+curl -vs http://localhost:5001/api/articles         \
+    -H "Accept: application/vnd.api+json"           \
+    -H "Content-Type: application/vnd.api+json"     \
+    -d '{
+            "data": {
+                "type": "articles",
+                "attributes": {
+                    "title": "Moby"
+                },
+                "relationships": {
+                    "author": {
+                        "data": {
+                            "type": "people",
+                            "id": "2"
+                        }
+                    }
+                }
+            }
+        }'

docs/request-examples/008-GET_Articles_With_Filter_Eq.sh

@@ -0,0 +1,2 @@
+curl -vs http://localhost:5001/api/articles?filter%5Btitle%5D=Moby     \
+    -H "Accept: application/vnd.api+json"

docs/request-examples/009-GET_Articles_With_Filter_Like.sh

@@ -0,0 +1,2 @@
+curl -vs http://localhost:5001/api/people?filter%5Bname%5D=like:Al     \
+    -H "Accept: application/vnd.api+json"

docs/request-examples/index.md

@@ -2,28 +2,60 @@
 
 These requests have been generated against the "GettingStarted" application and are updated on every deployment.
 
-## Create Person
+## Simple CRUD
+
+### Create
 
 [!code-sh[CREATE](000-CREATE_Person.sh)]
 [!code-json[CREATE](000-CREATE_Person-Response.json)]
 
-## Create Article
+### Create with Relationship
 
 [!code-sh[CREATE](001-CREATE_Article.sh)]
 [!code-json[CREATE](001-CREATE_Article-Response.json)]
 
 
-## Get All Articles
+### Get All
 
 [!code-sh[GET Request](002-GET_Articles.sh)]
 [!code-json[GET Response](002-GET_Articles-Response.json)]
 
-## Get Article By Id
+### Get By Id
 
 [!code-sh[GET Request](003-GET_Article.sh)]
 [!code-json[GET Response](003-GET_Article-Response.json)]
 
-## Get Article with Author
+### Get with Relationship
 
 [!code-sh[GET Request](004-GET_Articles_With_Authors.sh)]
-[!code-json[GET Response](004-GET_Articles_With_Authors-Response.json)]
+[!code-json[GET Response](004-GET_Articles_With_Authors-Response.json)]
+
+### Update
+
+[!code-sh[PATCH Request](005-PATCH_Article.sh)]
+[!code-json[PATCH Response](005-PATCH_Article-Response.json)]
+
+### Delete
+
+[!code-sh[DELETE Request](006-DELETE_Article.sh)]
+[!code-json[DELETE Response](006-DELETE_Article-Response.json)]
+
+## Filters
+
+_Note that cURL requires URLs to be escaped._
+
+### Equality
+
+[!code-sh[GET Request](008-GET_Articles_With_Filter_Eq.sh)]
+[!code-json[GET Response](008-GET_Articles_With_Filter_Eq-Response.json)]
+
+### Like
+
+[!code-sh[GET Request](009-GET_Articles_With_Filter_Like.sh)]
+[!code-json[GET Response](009-GET_Articles_With_Filter_Like-Response.json)]
+
+## Sorting
+
+# See Also
+
+- Customizing QuerySet