update docs and snippets for person

Author: mahenzon

README.rst

@@ -24,7 +24,7 @@ Install
 
 
 
-.. include:: ./docs/minimal_api_example.rst
+.. include:: ./docs/minimal_api_head.rst
 
 
 Flask-COMBO-JSONAPI vs `Flask-RESTful <https://flask-restful.readthedocs.io/en/latest/>`_

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\"attributes\": {\n\t\t\t\t\"name\": \"John\"\n\t\t}\n\t}\n}"
+    "text": "{\n  \"data\": {\n    \"type\": \"person\",\n    \"attributes\": {\n        \"name\": \"John\"\n    }\n  }\n}"
   }
 }

docs/http_snippets/snippets/minimal_api__create_person

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

docs/http_snippets/snippets/minimal_api__get_person_result

@@ -12,6 +12,16 @@ Content-Type: application/vnd.api+json
         "self": "/persons/1"
       },
       "type": "person"
+    },
+    {
+      "attributes": {
+        "name": "Sam"
+      },
+      "id": "2",
+      "links": {
+        "self": "/persons/2"
+      },
+      "type": "person"
     }
   ],
   "jsonapi": {
@@ -24,6 +34,6 @@ Content-Type: application/vnd.api+json
     "self": "http://localhost:5000/persons"
   },
   "meta": {
-    "count": 1
+    "count": 2
   }
 }

docs/minimal_api_example.rst

@@ -1,22 +1,4 @@
-A minimal API
-=============
-
-.. literalinclude:: ../examples/api_minimal.py
-    :language: python
-
-
-This example provides the following API structure:
-
-========================  ======  =============  ===========================
-URL                       method  endpoint       Usage
-========================  ======  =============  ===========================
-/persons                  GET     person_list    Get a collection of persons
-/persons                  POST    person_list    Create a person
-/persons/<int:person_id>  GET     person_detail  Get person details
-/persons/<int:person_id>  PATCH   person_detail  Update a person
-/persons/<int:person_id>  DELETE  person_detail  Delete a person
-========================  ======  =============  ===========================
-
+.. include::./minimal_api_head.rst
 
 Request:
 

docs/minimal_api_head.rst

@@ -0,0 +1,18 @@
+A minimal API
+=============
+
+.. literalinclude:: ../examples/api_minimal.py
+    :language: python
+
+
+This example provides the following API structure:
+
+========================  ======  =============  ===========================
+URL                       method  endpoint       Usage
+========================  ======  =============  ===========================
+/persons                  GET     person_list    Get a collection of persons
+/persons                  POST    person_list    Create a person
+/persons/<int:person_id>  GET     person_detail  Get person details
+/persons/<int:person_id>  PATCH   person_detail  Update a person
+/persons/<int:person_id>  DELETE  person_detail  Delete a person
+========================  ======  =============  ===========================

docs/quickstart.rst

@@ -5,11 +5,16 @@ Quickstart
 
 .. currentmodule:: flask_combo_jsonapi
 
-It's time to write your first REST API. This guide assumes you have a working understanding of `Flask <http://flask.pocoo.org>`_, and that you have already installed both Flask and Flask-COMBO-JSONAPI. If not, then follow the steps in the :ref:`installation` section.
+It's time to write your first advanced REST API.
+This guide assumes you have a working understanding of `Flask <https://flask.palletsprojects.com/en/1.1.x/>`_,
+and that you have already installed both Flask and Flask-COMBO-JSONAPI.
+If not, then follow the steps in the :ref:`installation` section.
 
-In this section you will learn basic usage of Flask-COMBO-JSONAPI around a small tutorial that use the SQLAlchemy data layer. This tutorial show you an example of a person and his computers.
+In this section you will learn basic usage of Flask-COMBO-JSONAPI
+around a small tutorial that use the SQLAlchemy data layer.
+This tutorial show you an example of a person and his computers.
 
-First example
+Advanced example
 -------------
 
 An example of Flask-COMBO-JSONAPI API looks like this: