#%RAML 0.8
title: WWST Temperature
version: v1.0.0-20170911
schemas:
- Temperature: |
    {
      "id": "http://www.samsung.com/schemas/x.com.st.temperature.oven.json#",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Copyright (c) 2016, 2017 Open Connectivity Foundation, Inc. All rights reserved.",
      "title": "WWST Temperature",
      "definitions": {
        "x.com.st.temperature.oven": {
          "type": "object",
          "properties": {
            "temperature": {
              "type": "number",
              "description": "Current temperature setting or measurement"
            },
            "units": {
              "enum": [
                "C",
                "F",
                "K"
              ],
              "description": "Units for the temperature value",
              "readOnly": true
            },
            "range": {
              "type": "array",
              "description": "Array defining min,max values for this temperature on this device",
              "items": {
                "type": "number"
              },
              "readOnly": true
            }
          }
        }
      },
      "type": "object",
      "allOf": [
        {
          "$ref": "oic.baseResource.json#/definitions/oic.r.baseresource"
        },
        {
          "$ref": "#/definitions/x.com.st.temperature.oven"
        }
      ],
      "required": [
        "temperature", "units", "range"
      ]
    }
- TemperatureUpdate: |
    {
      "id": "http://www.samsung.com/schemas/x.com.st.temperature.oven.json#",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "description": "Copyright (c) 2016, 2017 Open Connectivity Foundation, Inc. All rights reserved.",
      "title": "WWST Temperature",
      "definitions": {
        "x.com.st.temperature.oven": {
          "type": "object",
          "properties": {
            "temperature": {
              "type": "number",
              "description": "Current temperature setting or measurement"
            },
            "units": {
              "enum": [
                "C",
                "F",
                "K"
              ],
              "description": "Units for the temperature value",
              "readOnly": true
            },
            "range": {
              "type": "array",
              "description": "Array defining min,max values for this temperature on this device",
              "items": {
                "type": "number"
              },
              "readOnly": true
            }
          }
        }
      },
      "type": "object",
      "allOf": [
        {
          "$ref": "oic.baseResource.json#/definitions/oic.r.baseresource"
        },
        {
          "$ref": "#/definitions/x.com.st.temperature.oven"
        }
      ],
      "required": [
        "temperature"
      ]
    }

traits:
  - interface:
      queryParameters:
        if:
          enum: ["oic.if.a","oic.if.s","oic.if.baseline"]

/WWSTTemperatureResURI:
  description: |
        Setting temperature
  displayName: WWST Temperature
  is: [ interface ]

  get:
    description: |
      Retrieves the setting temperature
    queryParameters:
      units:
        displayName: Units
        enum: ["C","F","K"]
    responses:
      200:
        body:
          application/json:
            schema: Temperature
            example: |
              {
                "rt":           ["x.com.st.temperature.oven"],
                "id":           "unique_example_id",
                "temperature":  20.0,
                "units":        "C",
                "range":        [0.0,100.0]
              }

      403:
        description: |
          This response is generated by the OIC Server when the client sends:
            A retrieve with q queryParameter indicating a unit that the server does not support.
          The server responds with the current resource representation including the
          units property illustrating the supported units and the error.
        body:
          application/json:
            schema: Temperature
            example: |
              {
                "id":           "unique_example_id",
                "temperature":  20.0,
                "units":        "C"
              }

  post:
    description: |
      Sets the desired temperature
    body:
      application/json:
        schema: Temperature
        example: |
          {
            "id":           "unique_example_id",
            "temperature":  18.0
          }
    responses:
      200:
         body:
          application/json:
            schema: Temperature
            example: |
              {
                "id":          "unique_example_id",
                "temperature": 18.0
              }

      403:
        description: |
          This response is generated by the OIC Server when the client sends:
            An update with an out of range property value for temperature.
            An update with an unsupported unit for this server.
          The server responds with the current resource representation including
          the range property illustrating the supported range and the error.
        body:
          application/json:
            schema: Temperature
            example: |
              {
                "id":           "unique_example_id",
                "temperature":  20.0,
                "units":        "C",
                "range":        [0.0,100.0]
              }
