OpenLevelResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Open Level",
    "version": "v1.1.0-20160519",
    "license": {
      "name": "copyright 2016-2017 Open Connectivity Foundation, Inc. All rights reserved.",
      "x-description": "Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\n        1.  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\n        2.  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.\n\n        THIS SOFTWARE IS PROVIDED BY THE Open Connectivity Foundation, INC. \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE OR WARRANTIES OF NON-INFRINGEMENT, ARE DISCLAIMED.\n        IN NO EVENT SHALL THE Open Connectivity Foundation, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\n        HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
    }
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/OpenLevelResURI" : {
      "get": {
        "description": "This resource describes how open or ajar an entity such as a window, door, blind or shutter is.\nThe openLevel can be read (acting as a sensor).\nThe openLevel can also be set (acting as an actuator).\nThe openLevel is device dependent across the range provided.\nWhen range (from oic.r.baseresource) is omitted then 0 to 100 is assumed where 0 means closed, 100 means fully open.\nIf a range is provided then the lower bound=closed, upper bound=open.\nIf step (from oic.r.baseresource) is present then it represents the increment between possible values; if not provided 1 is assumed.\nRetrieves the current openLevel.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt":         ["oic.r.openlevel"],
                  "id":         "unique_example_id",
                  "openLevel":  50,
                  "step":       2,
                  "range":      [0,100]
                }
                ,
              "schema": { "$ref": "#/definitions/OpenLevel" }
            }
        }
      },
      "post": {
        "description": "Sets the desired openLevel.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/OpenLevel" },
            "x-example":
              {
                "id":         "unique_example_id",
                "openLevel":  0
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "id":         "unique_example_id",
                  "openLevel":  0
                }
                ,
              "schema": { "$ref": "#/definitions/OpenLevel" }
            },
            "403": {
              "description" : "This response is generated by the OIC Server when the client sends:\n  An update with an out of range property value for openLevel.\nThe server responds with the current resource representation.\n",
              "x-example":
                {
                  "id":         "unique_example_id",
                  "openLevel":  50,
                  "step":       2,
                  "range":      [0,100]
                }
                ,
              "schema": { "$ref": "#/definitions/OpenLevel" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "OpenLevel" : 
            {
        "properties": {
          "increment": {
            "description": "Deprecated, use 'step' instead.",
            "readOnly": true,
            "type": "integer"
          },
          "openLevel": {
            "description": "How open or ajar the entity is",
            "type": "integer"
          },
          "precision": {
            "description": "Accuracy granularity of the exposed value",
            "readOnly": true,
            "type": "number"
          },
          "range": {
            "description": "The valid range for the value Property",
            "items": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "maxItems": 2,
            "minItems": 2,
            "readOnly": true,
            "type": "array"
          },
          "step": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "number"
              }
            ],
            "description": "Step value across the defined range",
            "readOnly": true
          },
          "value": {
            "anyOf": [
              {
                "type": "array"
              },
              {
                "type": "string"
              },
              {
                "type": "boolean"
              },
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "object"
              }
            ],
            "description": "The value sensed or actuated by this Resource"
          }
        },
        "required": [
          "openLevel"
        ],
        "type": "object"
      }

  }
}