HeatingZoneResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Heating Zone",
    "version": "2019-02-15",
    "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": {
    "/HeatingZoneResURI" : {
      "get": {
        "description": "This Resource provides information about the status of a (single) heating zone of a Cook-Top.\nIt describes the case of a Cook-Top whose zones can be activated dynamically (i.e. the device implements pot recognition).\nThe Property \"maxheatinglevel\" defines the max level for the heating zone\nThe Property \"heatinglevel\" is the current heating level of the zone\n  For each element, the value range is from 0 (indication that the zone is not heating) to \"maxheatinglevel\".",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "RETRIEVES the current heating zone information.",
              "x-example":
                {
                  "rt": ["oic.r.heatingzone"],
                  "if": ["oic.if.s", "oic.if.baseline"],
                  "maxheatinglevel": 6,
                  "heatinglevel": 0
                },
              "schema": { "$ref": "#/definitions/HeatingZone" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "HeatingZone" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.heatingzone"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "heatinglevel": {
          "description": "The current heating level for the zone.",
          "readOnly": true,
          "type": "integer"
        },
        "maxheatinglevel": {
          "description": "The maximum heating level for the zone.",
          "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"
        },
        "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": ["maxheatinglevel", "heatinglevel"]
    }
  }
}