Merge pull request #24 from JonathanMM/master

Increase swagger
This commit is contained in:
Laurent Bossavit 2017-05-01 15:40:57 +02:00 committed by GitHub
commit 4e2b5d683e

View file

@ -145,7 +145,15 @@
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [], "parameters": [
{
"name": "id",
"in": "path",
"description": "Id of event",
"required": true,
"type": "string"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Success", "description": "Success",
@ -179,7 +187,29 @@
} }
}, },
"definitions": { "definitions": {
"Event": { "EventGeometry": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Geometry type: Point"
},
"coordinates": {
"description": "Geometry coordinates (longitude; latitude)",
"type": "array",
"items": {
"type": "number",
"format": "float",
"maxItems": 2,
"minItems": 2
}
}
}
},
"EventProperties": {
"type": "object", "type": "object",
"required": [ "required": [
"id", "id",
@ -196,11 +226,27 @@
"type": "string", "type": "string",
"description": "Event UUID" "description": "Event UUID"
}, },
"label": {
"type": "string",
"description": "Event label"
},
"lastupdate": { "lastupdate": {
"type": "string", "type": "string",
"format": "date", "format": "date",
"description": "Event last modification timestamp" "description": "Event last modification timestamp"
}, },
"lat": {
"type": "number",
"description": "Event location latitude"
},
"lon": {
"type": "number",
"description": "Event location longitude"
},
"source": {
"type": "string",
"description": "Event source"
},
"start": { "start": {
"type": "string", "type": "string",
"format": "date", "format": "date",
@ -213,7 +259,8 @@
}, },
"type": { "type": {
"type": "string", "type": "string",
"description": "Event type: scheduled, forecast, unscheduled" "description": "Event type",
"enum": ["scheduled", "forecast", "unscheduled"]
}, },
"what": { "what": {
"type": "string", "type": "string",
@ -225,6 +272,28 @@
"description": "Event timestamp" "description": "Event timestamp"
} }
} }
},
"Event": {
"type": "object",
"required": [
"geometry",
"properties",
"type"
],
"properties": {
"geometry": {
"$ref": "#/definitions/EventGeometry"
},
"properties": {
"$ref": "#/definitions/EventProperties"
},
"type":
{
"description": "Type of event",
"type": "string",
"enum": ["Point"]
}
}
} }
} }
} }