DoorResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Door",
    "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": {
    "/DoorResURI" : {
      "get": {
        "description": "This Resource describes the open state of the door.\nA door is modelled by means of openState (Open/Closed), openDuration (ISO 8601 Time), and openAlarm (boolean).\nFor Property \"openState\", the value 'Open' indicates the door is open.\nThe value 'Closed' indicates the door is closed.\nThe type of Property \"openDuration\" is an RFC Time encoded string.\nThe Property \"openAlarm\" value 'true' indicates that the open alarm is active.\nThe openAlarm value 'false' indicates that open alarm is not active.\nretrieves the state of the Door.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
          "200": {
            "description" : "",
            "x-example": {
              "rt": ["oic.r.door"],
              "if": ["oic.if.a", "oic.if.baseline"],
              "openState": "Open",
              "openDuration": "P0Y0M0DT2H25M5S",
              "openAlarm": true
            },
            "schema": { "$ref": "#/definitions/Door" }
          }
        }
      },
      "post": {
        "description": "Sets the current Door properties.\nThe only property that can be set as part of an update operation is\n  the openAlarm.\nThis can be made active (true) or inactive (false)\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/DoorUpdate" },
            "x-example": {
              "openAlarm":  false
            }
          }
        ],
        "responses": {
          "200": {
            "description" : "",
            "x-example": {
              "openAlarm":  false
            },
            "schema": { "$ref": "#/definitions/DoorUpdate" }
          }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Door" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.door"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "openDuration": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.types-schema.json#/definitions/duration"
        },
        "openState": {
          "description": "The state of the door (open or closed).",
          "enum": [
            "Open",
            "Closed"
          ],
          "readOnly": true,
          "type": "string"
        },
        "openAlarm": {
          "description": "The state of the door open alarm.",
          "type": "boolean"
        },
        "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.a",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["openState"]
    },
     "DoorUpdate" : {
      "properties": {
        "openAlarm": {
          "description": "The state of the door open alarm.",
          "type": "boolean"
        }
      },
      "type": "object",
      "required": ["openAlarm"]
    }
  }
}