HeatingZone.raml

#%RAML 0.8
title: OICHeatingZone
version: OCF1.0-20160722
documentation:
  - title: © 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 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. 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) 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:
  - HeatingZone:  !include oic.r.heatingzone.json

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

/HeatingZoneResURI:
  description: |
    This Resource provides information about the status of a heating zone of a Cook-Top.
    It describes the case of a Cook-Top whose zones can be activated dynamically (i.e. the device implements pot recognition).
    maxheatinglevel defines the max level for the heating zone
    heatinglevel is the current heating level of the zone
      For each element the value range is from 0 (indication that the zone is not heating) to maxheatinglevel,

  displayName: Heating Zone
  is: [ interface ] # valid for all methods

  get:
    description: |
      Retrieves the current heating zone information.
    responses:
      200:
        body:
          application/json:
            schema: HeatingZone
            example: |
              {
                "rt":             ["oic.r.heatingzone"],
                "id":             "unique_example_id",
                "maxheatinglevel": 6,
                "heatinglevel":    0
              }