AirQualityResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Air Quality",
    "version": "2020-08-13",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
      "x-copyright": "copyright 2016-2017, 2019, 2020 Open Connectivity Foundation, Inc. All rights reserved."
    },
    "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/AirQualityResURI" : {
      "get": {
        "description": "This Resource describes a qualitative or measured contaminant that can be used to infer Air Quality.\nThe Property \"valueType\" indicates a qualitative or measured reading within the contaminantvalue Property.\nThe Property \"contaminantvalue\" can contain the actual sensed value with units per contaminant type.\nQualitative is a representative value within the range provided where the minimum value is minimum contamination and maximum value is maximum contamination for the specific contaminant.\nThe Property \"contaminantvalue\" contains the actual measured or qualitative level.\nThe Property \"range\" contains the allowed range for the value that is being reported.\nIf valueType is 'Measured' then the units for the contaminant types are as follows:\n Methanol (also known as Formaldehyde): CH2O (ug/m^3),\n Carbon Dioxide: CO2 (ppm),\n Carbon Monoxide: CO (ppm),\n Particulate Matter (less than 1 micron in diameter): PM1 (ug/m^3),\n Particulate Matter (less than 2.5 microns in diameter): PM2.5 (ug/m^3),\n Particulate Matter (less than 10 microns in diameter): PM10 (ug/m^3),\n Volatile Organic Compounds: VOC (ug/m^3),\n Ozone: 03 (ppm), Nitrogen dioxide: NO2 (ppm), Sulphur dioxide: SO2 (ppm) ",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.airquality"],
                  "if":  ["oic.if.s", "oic.if.baseline"],
                  "contaminanttype": "CO",
                  "valuetype": "Measured",
                  "contaminantvalue": 10,
                  "range": [0,500]
                },
              "schema": { "$ref": "#/definitions/AirQuality" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "AirQuality" : {
      "properties": {
       "rt" : {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.airquality"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "contaminanttype": {
          "description": "The contaminant being measured.",
          "enum": [
            "CH2O",
            "CO2",
            "CO",
            "PM1",
            "PM2.5",
            "PM10",
            "VOC",
            "Smoke",
            "Odor",
            "AirPollution",
            "NO2", 
            "SO2", 
            "O3"
          ],
          "readOnly": true,
          "type": "string"
        },
         "valuetype": {
          "description": "The property that indicates whether the provided value is qualitative or measured.",
          "enum": [
            "Qualitative",
            "Measured"
          ],
          "readOnly": true,
          "type": "string"
        },
        "contaminantvalue": {
          "description": "The measured or qualitative value for the contaminant.",
          "readOnly": true,
          "type": "integer"
        },
        "n": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "id": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
        },
        "range": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_integer"
        },
        "if" : {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.s",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["contaminantvalue", "contaminanttype", "valuetype"]
    }
  }
}