Merge pull request #78 from my-conservation-life/update-docs

Updating documentation for the database endpoints in the API.

db/docs/assetPropTypes.json

+{
+    "/assetPropTypes": {
+        "post": {
+            "description": "Returns all the property types for an asset type.",
+            "requestBody": {
+                "assetTypeID": "The number for the asset type ID",
+                "content": {
+                    "application/json": {}
+                }
+            }
+        },
+        "responses": {
+            "200": {
+                "description": "The property types have been returned.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "id": {
+                                    "type": "integer"
+                                },
+                                "asset_type_id": {
+                                    "type": "integer"
+                                },
+                                "name": {
+                                    "type": "string"
+                                },
+                                "data_type": {
+                                    "type": "string"
+                                },
+                                "required": {
+                                    "type": "boolean"
+                                },
+                                "is_private": {
+                                    "type": "boolean"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

db/docs/assetPropsByTypeID.json

+{
+    "/assetPropsByTypeID": {
+        "post": {
+            "description": "Gets all asset properties for a given asset type.",
+            "requestBody": {
+                "assetTypeID": "The asset type ID as an integer",
+                "content": {
+                    "application/json": {}
+                }
+            }
+        },
+        "responses": {
+            "200": {
+                "description": "All of the asset properties have been returned.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "id": {
+                                    "type": "integer"
+                                },
+                                "value": {
+                                    "type": "string"
+                                },
+                                "property_id": {
+                                    "type": "integer"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

db/docs/assetTypes.json

+{
+    "/assetTypes": {
+        "get": {
+            "description": "Returns all asset type IDs and descriptions.",
+            "parameters": [],
+            "responses": {
+                "200": {
+                    "description": "Asset types returned",
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "type": "object",
+                                "properties":  {
+                                    "id": {
+                                        "type": "integer"
+                                    },
+                                    "description": {
+                                        "type": "string"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}