update snippets for person, add get persons

Author: mahenzon

docs/http_snippets/minimal_api__create_person.json

@@ -12,6 +12,6 @@
   ],
   "postData": {
     "mimeType": "application/json",
-    "text": "{\n\t\"data\": {\n\t\t\"type\": \"person\",\n\t\t\"name\": \"John\"\n\t}\n}"
+    "text": "{\n\t\"data\": {\n\t\t\"type\": \"person\",\n\t\t\"attributes\": {\n\t\t\t\t\"name\": \"John\"\n\t\t}\n\t}\n}"
   }
 }

docs/http_snippets/minimal_api__get_person.json

@@ -0,0 +1,13 @@
+{
+  "method": "GET",
+  "url": "http://localhost:5000/persons",
+  "httpVersion": "HTTP/1.1",
+  "queryString": [
+  ],
+  "headers": [
+    {
+      "name": "content-type",
+      "value": "application/vnd.api+json"
+    }
+  ]
+}

docs/http_snippets/snippets/.gitignore

@@ -0,0 +1 @@
+*.py

docs/http_snippets/snippets/minimal_api__create_person

@@ -1,11 +1,13 @@
 POST /persons HTTP/1.1
 Content-Type: application/vnd.api+json
 Host: localhost:5000
-Content-Length: 54
+Content-Length: 78
 
 {
 	"data": {
 		"type": "person",
-		"name": "John"
+		"attributes": {
+				"name": "John"
+		}
 	}
 }

docs/http_snippets/snippets/minimal_api__create_person_result

@@ -4,7 +4,7 @@ Content-Type: application/vnd.api+json
 {
   "data": {
     "attributes": {
-      "name": null
+      "name": "John"
     },
     "id": "1",
     "links": {

docs/http_snippets/snippets/minimal_api__get_person

@@ -0,0 +1,3 @@
+GET /persons HTTP/1.1
+Content-Type: application/vnd.api+json
+Host: localhost:5000

docs/http_snippets/snippets/minimal_api__get_person_result

@@ -0,0 +1,29 @@
+HTTP/1.1 200 OK
+Content-Type: application/vnd.api+json
+
+{
+  "data": [
+    {
+      "attributes": {
+        "name": "John"
+      },
+      "id": "1",
+      "links": {
+        "self": "/persons/1"
+      },
+      "type": "person"
+    }
+  ],
+  "jsonapi": {
+    "version": "1.0"
+  },
+  "links": {
+    "first": "http://localhost:5000/persons",
+    "last": "http://localhost:5000/persons?page%5Bnumber%5D=2",
+    "next": "http://localhost:5000/persons?page%5Bnumber%5D=2",
+    "self": "http://localhost:5000/persons"
+  },
+  "meta": {
+    "count": 1
+  }
+}

docs/http_snippets/update_snippets_with_responses.py

@@ -26,8 +26,13 @@ def run_request_for_module(module_name: str):
     log.info("Process module %s", module)
     response: requests.Response = module.response
     log.info("Response %s", response)
+
     http_response_text = []
-    response_reason = (response.reason or "").title()
+
+    response_reason = (response.reason or "")
+    if response.status_code != HTTPStatus.OK:
+        response_reason = response_reason.title()
+
     http_response_text.append(
         # "HTTP/1.1 201 Created"
         "{} {} {}".format(
@@ -36,6 +41,7 @@ def run_request_for_module(module_name: str):
             response_reason,
         )
     )
+
     http_response_text.append(
         "{}: {}".format(
             "Content-Type",

docs/index.rst

@@ -51,6 +51,7 @@ Flask-COMBO-JSONAPI with Flask.
    :maxdepth: 3
 
    installation
+   minimal_api_example
    quickstart
    logical_data_abstraction
    resource_manager

docs/minimal_api_example.rst

@@ -1,4 +1,3 @@
-
 A minimal API
 =============