LockStatusResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Lock",
    "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": {
    "/LockStatusResURI" : {
      "get": {
        "description": "Resource describing a lock.\nFor the type of lockState, the value 'Locked' indicates that the door is Locked.\nThe value 'Unlocked' indicates that the door is Unlocked.\nRetrieves the state of the lock.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt":         ["oic.r.lock.status"],
                  "id":         "unique_example_id",
                  "lockState":  "Locked"
                }
                ,
              "schema": { "$ref": "#/definitions/Lock" }
            }
        }
      },
      "post": {
        "description": "Sets the current lock state.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/Lock" },
            "x-example":
              {
                "id":         "unique_example_id",
                "lockState":  "Unlocked"
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "id":         "unique_example_id",
                  "lockState":  "Unlocked"
                }
                ,
              "schema": { "$ref": "#/definitions/Lock" }
            },
            "403": {
              "description" : "This response is generated by the OIC Server when the client sends:\n  An update with an invalid property value for lockState.\nThe server responds with the current resource representation.\n",
              "x-example":
                {
                  "lockState": "Unlocked"
                }
                ,
              "schema": { "$ref": "#/definitions/Lock" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Lock" : 
            {
        "properties": {
          "lockState": {
            "description": "State of the lock.",
            "enum": [
              "Locked",
              "Unlocked"
            ],
            "type": "string"
          },
          "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": [
          "lockState"
        ],
        "type": "object"
      }

  }
}