#%RAML 0.8
title: ST Window Shade
version: v1.1.0-20180130
documentation:
  - title: Copyright (c) 2018 Samsung Electronics Co., Ltd. All rights reserved.
           Copyright (c) 2016 Open Connectivity Foundation, Inc. All rights reserved.
    content: |
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        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.

          THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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. IN NO EVENT SHALL THE COPYRIGHT OWNER 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) 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. 
schemas:
- WindowShadeGet: |
    {
      "id": "http://samsung.com/schemas/x.com.st.windowshade.json#",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description" : "Copyright (c) 2016 Samsung Electronics, Inc. All rights reserved.",
      "title": "ST Window Shade",
      "definitions": {
        "x.com.st.windowshade": {
          "type": "object",
          "properties": {
            "windowShade": {
              "type": "string",
              "enum": ["unknown", "open", "closing", "closed", "opening", "partially open"],
              "description":"Status of the window shade"
            }
          }
        }
      },
      "type": "object",
      "allOf": [
        {"$ref": "oic.core.json#/definitions/oic.core"},
        {"$ref": "oic.baseResource.json#/definitions/oic.r.baseresource"},
        {"$ref": "#/definitions/x.com.st.windowshade"}
      ],
      "required": ["windowShade"]
    }
- WindowShadePost: |
    {
      "id": "http://samsung.com/schemas/x.com.st.windowshade.json#",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description" : "Copyright (c) 2016 Samsung Electronics, Inc. All rights reserved.",
      "title": "ST Window Shade",
      "definitions": {
        "x.com.st.windowshade": {
          "type": "object",
          "properties": {
            "windowShade": {
              "type": "string",
              "enum": ["open", "closing", "closed", "opening", "presetPosition"],
              "description":"Status of the windowShade"
            }
          }
        }
      },
      "type": "object",
      "allOf": [
        {"$ref": "oic.core.json#/definitions/oic.core"},
        {"$ref": "oic.baseResource.json#/definitions/oic.r.baseresource"},
        {"$ref": "#/definitions/x.com.st.windowshade"}
      ],
      "required": ["windowShade"]
    }
- Exception: |
    {
      "id": "http://samsung.com/iotdatamodels/schemas/stocfexception.json#",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Copyright (c) 2016 Samsung, Inc. All rights reserved.",
      "title": "StOcfException",
      "definition": {
        "stOcfError": {
        "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "enum": ["OCF_001", "OCF_005"],
              "description": "Code of the exception"
            },
            "message": {
              "type": "string",
              "description": "Message of the exception"
            }
          }
        }
      }
    }
traits:
 - interface :
     queryParameters:
       if:
         enum: ["oic.if.baseline"]

/WindowShade:
  displayName: WindowShade
  description: |
    This resource implements Window Shade capability from SmartThings.

  is : ['interface']
  get:
    description: |
      Retrieve the current state and operation of the window shade.

    responses :
      200:
        body:
          application/json:
            schema: WindowShadeGet
            example: |
              {
                  "id": "unique_example_id",
                  "windowShade":	"closing"
              }

  post:
    description: |
      Update the current status of the window shade.
      Posting "opening" or "open" in the "closed" or "closing" state will transit
      the state to "opening". The "opening" state will last for 10 - 20 seconds
      until the window shade is completely open. Posting "closing" or "closed"
      in the "open" or "closed" state will transit the state to "closing". The
      "closing" state will last for 10 - 20 seconds until the window shade is
      completely closed.

    body:
      application/json:
        schema: WindowShadePost
        example: |
          {
            "id": "unique_example_id",
            "windowShade":	"closing"
          }
    responses :
      200:
        body:
          application/json:
            schema: WindowShadePost
            example: |
              {
                "id":    "unique_example_id",
                "windowShade":"closing"
              }
