Merge branch 'development' into 'master'

Adding sphinxjsondomain to document json objects

See merge request warricksothr/Atheneum!8

server/Pipfile

@@ -24,6 +24,7 @@ pydocstyle = ">=2.1,<2.2"
 sphinx = ">=1.7,<1.8"
 sphinx-rtd-theme = ">=0.4,<0.5"
 sphinxcontrib-httpdomain = ">=1.7,<1.8"
+sphinx-jsondomain = "*"
 
 [requires]
 python_version = "3.6"

server/Pipfile.lock

@@ -1,7 +1,7 @@
 {
     "_meta": {
         "hash": {
-            "sha256": "2d44286a15539f26e69e12737247e8f490fa6c5e1f35a28f5c322cbd525d5eda"
+            "sha256": "9ba0840844223ce8320a900a02e33f5ea9314301a827f49f0b92a4eff7227812"
         },
         "pipfile-spec": 6,
         "requires": {
@@ -314,6 +314,13 @@
             ],
             "version": "==0.14"
         },
+        "faker": {
+            "hashes": [
+                "sha256:228970fbdd8322e92406cff256338c1cf0a330332d0172f4403863689a3c5576",
+                "sha256:310b20f3c497a777622920dca314d90f774028d49c7ee7ccfa96ca4b9d9bf429"
+            ],
+            "version": "==0.7.18"
+        },
         "idna": {
             "hashes": [
                 "sha256:156a6814fb5ac1fc6850fb002e0852d56c0c8d2531923a51032d1b70760e186e",
@@ -495,6 +502,13 @@
             "index": "pypi",
             "version": "==3.6.4"
         },
+        "python-dateutil": {
+            "hashes": [
+                "sha256:1adb80e7a782c12e52ef9a8182bebeb73f1d7e24e374397af06fb4956c8dc5c0",
+                "sha256:e27001de32f627c22380a688bcc43ce83504a7bc5da472209b4c70f02829f0b8"
+            ],
+            "version": "==2.7.3"
+        },
         "python-dotenv": {
             "hashes": [
                 "sha256:4965ed170bf51c347a89820e8050655e9c25db3837db6602e906b6d850fad85c",
@@ -539,6 +553,14 @@
             "index": "pypi",
             "version": "==1.7.6"
         },
+        "sphinx-jsondomain": {
+            "hashes": [
+                "sha256:cdc03fa28dafc383d30451d724ea293dded4619d777acfa003b2a538bbf52f85",
+                "sha256:fd4688d3026bd40c8d3aea94c0ea423d32dd9a046e6dc80fba83aaf60c87abc4"
+            ],
+            "index": "pypi",
+            "version": "==0.0.3"
+        },
         "sphinx-rtd-theme": {
             "hashes": [
                 "sha256:3b49758a64f8a1ebd8a33cb6cc9093c3935a908b716edfaa5772fd86aac27ef6",

server/documentation/api/authentication.rst

@@ -103,3 +103,26 @@ Authentication API
     :>json boolean success: Whether the logout was successful
     :statuscode 200: User successfully logged out
     :statuscode 401: Authorization failed
+
+Authentication Object Models
+============================
+
+.. json:object:: UserToken
+   :showexample:
+
+   UserToken definition
+
+   :property token: The token value, used for authentication
+   :proptype token: string
+   :property note: Additional information about the token
+   :proptype note: string
+   :property enabled: Determine if a token will be accepted
+   :proptype enabled: boolean
+   :property expirationTime: The time that the token becomes invalid, regardless of enabled state
+   :proptype expirationTime: iso8601
+   :property creationTime: The time that the token was created
+   :proptype creationTime: iso8601
+   :property lastUsageTime: The time that the token was last used
+   :proptype lastUsageTime: iso8601
+   :property version: An identifier for the token version
+   :proptype version: integer

server/documentation/api/user.rst

@@ -27,13 +27,15 @@ User API
             "count": 1,
             "totalCount": 1,
             "lastPage": 1,
-        "items" :[{
+            "items": [
+                {
                     "creationTime": "2018-07-29T11:58:17-05:00",
                     "lastLoginTime": "2018-07-29T12:43:27-05:00",
                     "name": "atheneum_administrator",
                     "role": "ADMIN",
                     "version": 0
-        }]
+                }
+            ]
         }
 
     :query int page: User page to retrieve
@@ -234,3 +236,38 @@ User API
     :statuscode 200: Successfully deleted the user
     :statuscode 401: Authorization failed
     :statuscode 404: User doesn't exist
+
+User Object Models
+==================
+
+.. json:object:: Page<User>
+    :showexample:
+
+    Page<User> definition
+
+    :property page: The page returned
+    :proptype page: integer
+    :property count: The number of items on this page
+    :proptype count: integer
+    :property totalCount: The total number of items available
+    :proptype totalCount: integer
+    :property lastPage: The last page that is accessible before 404
+    :proptype lastPage: integer
+    :property items: The list of items on the page
+    :proptype items: :json:list: 'User'
+
+.. json:object:: User
+    :showexample:
+
+    User definition
+
+    :property name: The unique name of the user
+    :proptype name: string
+    :property creationTime: The time that the user was created
+    :proptype creationTime: iso8601
+    :property lastLoginTime: The time that the user last logged in
+    :proptype lastLoginTime: iso8601
+    :property version: An identifier for the user version
+    :proptype version: integer
+    :property role: The assigned role for the user
+    :proptype role: string

server/documentation/conf.py

@@ -39,7 +39,8 @@ release = '2018.8.1'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinxcontrib.httpdomain'
+    'sphinxcontrib.httpdomain',
+    'sphinxjsondomain'
 ]
 
 # Add any paths that contain templates here, relative to this directory.