CarbonMonoxideResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Carbon Monoxide Sensor",
    "version": "2019-11-18",
    "license": {
     "name": "OCF Data Model License",
     "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
     "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved."
   },
   "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/CarbonMonoxideResURI" : {
      "get": {
        "description": "This Resource describes whether carbon monoxide has been sensed or not.\nThe Property \"value\" is a boolean.\nA value of 'true' means that carbon monoxide has been detected.\nA value of 'false' means that carbon monoxide has not been detected.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt":     ["oic.r.sensor.carbonmonoxide"],
                  "id":     "unique_example_id",
                  "value":  true
                },
              "schema": { "$ref": "#/definitions/CO" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "CO": {
      "properties": {
        "rt":  {
          "description": "Resource Type",
          "items": {
            "maxLength": 64,
            "type": "string",
            "enum": ["oic.r.sensor.carbonmonoxide"]
          },
          "minItems": 1,
          "readOnly": true,
          "uniqueItems": true,
          "type": "array"
        },
        "value":  {
          "description": "The carbon monoxide indicator, true = sensed, false = not sensed.",
          "readOnly": true,
          "type": "boolean"
        },
        "measurement":  {
          "type": "number",
          "description": "Measured value for this sensor, units are in ppm",
          "readOnly": true
        },
        "precision":  {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision"
        },
        "n": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "range":  {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number"
        },
        "step": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number"
        },
        "id":  {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
        },
        "if":  {
          "description": "The OCF Interface set supported by this Resource",
          "items": {
            "enum": [
              "oic.if.baseline",
              "oic.if.s"
            ],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type" : "object",
      "required": ["value"]
    }
  }
}