IoTDataModels/SelectableLevels.raml at master · OpenOCF/IoTDataModels · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
#%RAML 0.8
title: OICSelectableLevels
version: v1.1.0-20160519
documentation:
  - title: © 2017 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:
  - SelectableLevels:  !include oic.r.selectablelevels.json
  - UpdateSchema: !include oic.r.selectablelevels-Update.json

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

/SelectableLevelsResURI:
  description: |
    This Resource provides a set of device defined 'levels' that can be selected for an operation.
    For example where a humidifier has a discrete set that model different humidity levels that can be set.
    availablelevels is an array of the levels that can be selected, these can be a number or an integer.
    targetlevel is the level that has currently been selected and is written to in order to select a new level.
    When retrieved the targetlevel provides the actual value that has been selected.

  displayName: Selectable Levels
  is: [ interface ] # valid for all methods

  get:
    description: |
      Retrieves the current selectable levels.
    responses:
      200:
        body:
          application/json:
            schema: SelectableLevels
            example: |
              {
                "rt":             ["oic.r.selectablelevels"],
                "id":             "unique_example_id",
                "availablelevels":[0,2,4,6,8],
                "targetlevel":    2
              }

  post:
    description:
      Sets the current level from the set that is selectable
    body:
      application/json:
        schema: UpdateSchema
        example: |
          {
            "targetlevel": 4
          }
    responses:
      200:
        body:
          application/json:
            schema: UpdateSchema
            example: |
              {
                "targetlevel": 4
              }

      403:
        description:
          Generated by a Server when an attempt is made to update to a targetlevel that is not in the set of availablelevels
        body:
            application/json:
              schema: SelectableLevels
              example: |
                {
                  "id":             "unique_example_id",
                  "availablelevels":[0,2,4,6,8],
                  "targetlevel":    2
                }