Commit 8980e6fb authored by Jean-Marie Lepioufle's avatar Jean-Marie Lepioufle
Browse files

add swagger.json

parent a40cf92a
{
"swagger": "2.0",
"info": {
"title": "Air Quality Open Data API",
"description": "Air Quality Open Data API",
"termsOfService": "terms.html",
"contact": {
"url": "http://www.epa.ie",
"name": "EPA"
},
"license": {
"url": "https://creativecommons.org/licenses/by/4.0/",
"name": "Creative Commons Attribution 4.0 International License (CC BY 4.0)"
},
"version": "1.0"
},
"host": "air-tst.epa.ie",
"basePath": "/api/v1",
"schemes": [
"http"
],
"consumes": [
"application/json"
],
"produces": [
"application/xml",
"application/json"
],
"paths": {
"/aq_measurements": {
"get": {
"summary": "Retrieves one or more aq_measurements",
"responses": {
"200": {
"description": "An array of aq_measurements",
"schema": {
"items": {
"$ref": "#/definitions/Aq_measurement"
},
"type": "array"
}
}
},
"tags": [
"Aq_measurement"
]
}
},
"/aq_measurements/{aq_measurementId}": {
"get": {
"summary": "Retrieves a Aq_measurement document",
"responses": {
"200": {
"description": "Aq_measurement document fetched successfully",
"schema": {
"$ref": "#/definitions/Aq_measurement"
}
}
},
"parameters": [
{
"$ref": "#/parameters/Aq_measurement__id"
}
],
"tags": [
"Aq_measurement"
]
}
}
},
"definitions": {
"Aq_measurement": {
"type": "object",
"properties": {
"rawdatavalue": {
"type": "double"
},
"measurementtype": {
"type": "string"
},
"samplingpoint": {
"type": "string"
},
"pollutantname": {
"type": "string"
},
"measurementunit": {
"type": "string"
},
"raw_reading_measurement_time": {
"type": "string",
"format": "date-time"
},
"rawreadingid": {
"type": "int64"
},
"_id": {
"type": "string",
"format": "objectid"
}
}
}
},
"parameters": {
"Aq_measurement__id": {
"in": "path",
"name": "aq_measurementId",
"required": true,
"description": "",
"type": "string",
"format": "objectid"
}
},
"tags": [
{
"name": "Aq_measurement"
}
]
}
Supports Markdown
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