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
c261274d
Commit
c261274d
authored
Feb 23, 2020
by
Nikolas Tilley
Browse files
Added API docs for temporal queries
parent
20b3f87b
Changes
4
Hide whitespace changes
Inline
Side-by-side
db/docs/components/schemas/assetHistoryFeatureCollection.json
0 → 100644
View file @
c261274d
{
"type"
:
"FeatureCollection"
,
"features"
:
[
{
"type"
:
"Feature"
,
"geometry"
:
{
"type"
:
"Point"
,
"coordinates"
:
[
longitude
,
latitude
]
},
"properties"
:
{
"asset_id"
:
{
"type"
:
"integer"
,
"description"
:
"The unique ID of the asset"
},
"asset_type"
:
{
"type"
:
"string"
,
"description"
:
"The type of asset"
},
"asset_properties"
:
[
{
"property"
:
{
"type"
:
"string"
,
"description"
:
"The property name"
},
"value"
:
{
"type"
:
"string"
,
"description"
:
"The property value"
}
}
],
"sponsor_name"
:
{
"type"
:
"string"
,
"description"
:
"The name of the sponsoring organization the asset belongs to."
},
"project_name"
:
{
"type"
:
"string"
,
"description"
:
"The name of the project the asset belongs to."
},
"date"
:
{
"type"
:
"string"
,
"description"
:
"The date the asset properties entered the database."
}
}
}
]
}
db/docs/components/schemas/geospacialTemporalQuery.json
0 → 100644
View file @
c261274d
{
"geospatialTemporalQuery"
:
{
"type"
:
"Object"
,
"required"
:
[
"geometry"
],
"properties:"
:
{
"asset_id"
:
{
"type"
:
"integer"
,
"description"
:
"The ID of the asset."
},
"sponsor"
:
{
"type"
:
"string"
,
"description"
:
"The sponsoring organization of the asset."
},
"project"
:
{
"type"
:
"string"
,
"description"
:
"The project the asset is a part of."
},
"asset_type"
:
{
"type"
:
"string"
,
"description"
:
"They type of asset"
},
"start_date"
:
{
"type"
:
"date"
,
"format"
:
"YYYY-MM-DD"
,
"description"
:
"The lower bounding date the asset entered the database."
},
"end_date"
:
{
"type"
:
"date"
,
"format"
:
"YYYY-MM-DD"
,
"description"
:
"The uper bounding date the asset entered the database."
},
"geometry"
:
{
"type"
:
"object"
,
"description"
:
"The type of geospatial search to query asset data for."
,
"example"
:
{
"$ref"
:
"examples/geospatialTemporalQueryExamples"
}
}
}
}
}
db/docs/examples/geospatialTemporalQueryExamples.json
0 → 100644
View file @
c261274d
{
"circle-query-example"
:
{
"summary"
:
"A circular area to query asset historical data."
,
"description"
:
"A query that specifies a latitude longitude point and a radius to find asset data."
,
"value"
:
{
"geometry"
:
{
"type"
:
"Circle"
,
"coordinates"
:
[
-16
,
44
],
"radius"
:
"1000000"
},
"start_date"
:
"2020-02-01"
,
"end_date"
:
"2020-02-20"
,
"sponsor"
:
"seneca park zoo society"
,
"asset_type"
:
"fire"
,
"project"
:
"Madagascar reforesting project"
}
},
"polygon-query-example"
:
{
"summary"
:
"A polygon area to query asset historical data."
,
"description"
:
"A query that specifies a polygonal area to query historical data."
,
"value"
:
{
"geometry"
:
{
"type"
:
"Polygon"
,
"coordinates"
:
[
[
-16
,
44
],
[
-18
,
44
],
[
-18
,
48
],
[
-16
,
48
],
[
-16
,
44
]
]
},
"sponsor"
:
"seneca park zoo society"
,
"asset_type"
:
"fire"
,
"project"
:
"Madagascar reforesting project"
}
}
}
db/docs/geospatialTemporal.json
0 → 100644
View file @
c261274d
{
"/assets/properties/temporalSearch"
:
{
"get"
:
{
"requestBody"
:
{
"description"
:
"Gets an array of assets' historical properties."
,
"content"
:
{
"application/json"
:
{
"schema"
:
{
"$ref"
:
"#/components/schema/geospacialTemporalQuery"
},
"examples"
:
{
"$ref"
:
"#/examples/geospatialTemporalQueryExamples"
}
}
}
},
"responses"
:
{
"200"
:
{
"description"
:
"GeoJson FeatureCollection containing an array of assets' historical properties "
,
"content"
:
{
"application/json"
:
{
"schema"
:
{
"$ref"
:
"#/components/schema/assetHistoryFeatureCollection"
}
}
}
}
}
}
}
}
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