IEEE.org     |     IEEE Xplore Digital Library     |     IEEE Standards     |     IEEE Spectrum     |     More Sites

Unverified Commit 20b3f87b authored by tilley14's avatar tilley14 Committed by GitHub
Browse files

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

Updating documentation for the database endpoints in the API.
parents 0b3176f4 3fae7fbc
{
"/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"
}
}
}
}
}
}
}
}
}
{
"/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"
}
}
}
}
}
}
}
}
}
{
"/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"
}
}
}
}
}
}
}
}
}
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment