IEEE.org
|
IEEE Xplore Digital Library
|
IEEE Standards
|
IEEE Spectrum
|
More Sites
Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Open at RIT
My Conservation Life
Conservation360
Commits
8c154a76
Commit
8c154a76
authored
Feb 17, 2020
by
exw4141
Browse files
Created docs for CSV endpoint and parts of the schema
parent
85d1c869
Changes
4
Hide whitespace changes
Inline
Side-by-side
db/docs/assetDefinitions.json
0 → 100644
View file @
8c154a76
{
"/csv"
:
{
"put"
:
{
"requestBody"
:
{
"description"
:
""
,
"content"
:
{
"application/vnd.ms-excel"
:
{
"schema"
:
{
"$ref"
:
"#/components/schema/asset_property"
},
"examples"
:
{
"import-csv-example"
:
{
"summary"
:
"Importing data with a valid CSV"
,
"description"
:
"CSV containing data to be stored"
,
"value"
:
{
"asset_type_id"
:
"3"
,
"csv"
:
"fire.csv"
}
}
}
}
}
}
}
}
}
db/docs/components/schemas/Asset.json
0 → 100644
View file @
8c154a76
{
"Asset"
:
{
"type"
:
"object"
,
"required"
:
[
"id"
,
"project_id"
,
"asset_type_id"
],
"properties"
:
{
"id"
:
{
"type"
:
"bigint"
,
"description"
:
"the ID of the asset"
},
"project_id"
:
{
"type"
:
"integer"
,
"description"
:
"the ID of the project tracking the asset"
},
"asset_type_id"
:
{
"type"
:
"integer"
,
"description"
:
"the ID of the asset type that the asset belongs to"
},
"location"
:
{
"type"
:
"geometry"
,
"description"
:
"the location of the asset"
}
}
}
}
db/docs/components/schemas/Asset_Property.json
0 → 100644
View file @
8c154a76
{
"Asset Property"
:
{
"type"
:
"object"
,
"required"
:
[
"asset_id"
,
"property_id"
],
"properties"
:
{
"asset_id"
:
{
"type"
:
"bigint"
,
"description"
:
"The asset associated with the property"
},
"property_id"
:
{
"type"
:
"integer"
,
"description"
:
"The property the asset possesses"
},
"value"
:
{
"type"
:
"string"
,
"description"
:
"Value of the property for a particular asset"
}
}
}
}
db/docs/components/schemas/Property.json
0 → 100644
View file @
8c154a76
{
"Property"
:
{
"type"
:
"object"
,
"required"
:
[
"id"
,
"asset_type_id"
,
"data_type"
],
"properties"
:
{
"id"
:
{
"type"
:
"integer"
,
"description"
:
"the unique ID of the property"
},
"asset_type_id"
:
{
"type"
:
"integer"
,
"description"
:
"the ID of the asset type possessing the property"
},
"data_type"
:
{
"type"
:
"string"
,
"description"
:
"the data type of the information that the property tracks"
},
"name"
:
{
"type"
:
"string"
,
"description"
:
"the name of the property"
},
"required"
:
{
"type"
:
"boolean"
,
"description"
:
"tell whether the property is required to be stored for all assets possessing the property"
},
"is_private"
:
{
"type"
:
"boolean"
,
"description"
:
"tell whether this property should be private from the general public"
}
}
}
}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment