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

Unverified Commit 824845db authored by Edward W's avatar Edward W Committed by GitHub
Browse files

Merge pull request #82 from my-conservation-life/temporal-docs

Added API docs for temporal queries
parents 20b3f87b 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."
}
}
}
]
}
{
"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"
}
}
}
}
}
{
"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"
}
}
}
{
"/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"
}
}
}
}
}
}
}
}
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