Approved: OCF1.0-Bugzilla956-StepProperty

OpenInterConnect · Jan 10, 2017 · bcf024d · bcf024d
1 parent 0630c61
commit bcf024d
Show file tree

Hide file tree

Showing 15 changed files with 572 additions and 613 deletions.
diff --git a/airFlow.raml b/airFlow.raml
@@ -1,88 +1,89 @@
-#%RAML 0.8
-title: OICAirFlow
-version: v1.1.0-20160519
-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:
-  - AirFlow: !include oic.r.airFlow.json
-
-traits:
-  - interface:
-      queryParameters:
-        if:
-          enum: ["oic.if.a","oic.if.baseline"]
-
-/AirFlowResURI:
-  description: |
-    This resource describes the properties associated with air flow.
-    The direction is the directionality of the air flow if applicable.
-    Direction values are dependent on the capabilities of the unit.
-    The speed is an integer representing the current speed level for the unit.
-    The range is an array of the min,max values for the speed level.
-
-  displayName: Air Flow
-  is: [ interface ] # valid for all methods
-
-  get:
-    description: |
-      Retrieves the current air flow values.
-    responses:
-      200:
-        body:
-          application/json:
-            schema: AirFlow
-            example: |
-              {
-                "rt":         ["oic.r.airflow"],
-                "id":         "unique_example_id",
-                "direction":  "left",
-                "speed":      5,
-                "range":      [1,7]
-              }
-
-  post:
-    description: |
-      Sets the current air flow values.
-      Only direction and speed may be set by an update operation.
-    body:
-      application/json:
-        schema: AirFlow
-        example: |
-          {
-            "id":         "unique_example_id",
-            "direction":  "right",
-            "speed":      3
-          }
-    responses:
-      200:
-        body:
-          application/json:
-            schema: AirFlow
-            example: |
-              {
-                "id":         "unique_example_id",
-                "direction":  "right",
-                "speed":      3
-              }
-
-      403:
-        description: |
-          This response is generated by the OIC Server when the client sends:
-            An update with an invalid property value for direction.
-            An update with an out of range property value for speed.
-          The server responds with the current resource representation.
-        body:
-          application/json:
-            schema: AirFlow
-            example: |
-              {
-                "id":         "unique_example_id",
-                "direction":  "right",
-                "speed":      3
-              }
+#%RAML 0.8
+title: OICAirFlow
+version: v1.1.0-20160519
+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:
+  - AirFlow: !include oic.r.airFlow.json
+
+traits:
+  - interface:
+      queryParameters:
+        if:
+          enum: ["oic.if.a","oic.if.baseline"]
+
+/AirFlowResURI:
+  description: |
+    This resource describes the properties associated with air flow.
+    The direction is the directionality of the air flow if applicable.
+    Direction values are dependent on the capabilities of the unit.
+    The speed is an integer representing the current speed level for the unit.
+    The range (from oic.r.baseresource) is an array of the min,max values for the speed level.
+    If not present the range defaults to [0,100]
+
+  displayName: Air Flow
+  is: [ interface ] # valid for all methods
+
+  get:
+    description: |
+      Retrieves the current air flow values.
+    responses:
+      200:
+        body:
+          application/json:
+            schema: AirFlow
+            example: |
+              {
+                "rt":         ["oic.r.airflow"],
+                "id":         "unique_example_id",
+                "direction":  "left",
+                "speed":      5,
+                "range":      [1,7]
+              }
+
+  post:
+    description: |
+      Sets the current air flow values.
+      Only direction and speed may be set by an update operation.
+    body:
+      application/json:
+        schema: AirFlow
+        example: |
+          {
+            "id":         "unique_example_id",
+            "direction":  "right",
+            "speed":      3
+          }
+    responses:
+      200:
+        body:
+          application/json:
+            schema: AirFlow
+            example: |
+              {
+                "id":         "unique_example_id",
+                "direction":  "right",
+                "speed":      3
+              }
+
+      403:
+        description: |
+          This response is generated by the OIC Server when the client sends:
+            An update with an invalid property value for direction.
+            An update with an out of range property value for speed.
+          The server responds with the current resource representation.
+        body:
+          application/json:
+            schema: AirFlow
+            example: |
+              {
+                "id":         "unique_example_id",
+                "direction":  "right",
+                "speed":      3
+              }
diff --git a/baseResourceSchema.raml b/baseResourceSchema.raml
@@ -26,7 +26,10 @@ traits:
 
 /BaseResourceSchemaResURI:
   description: |
-    This is the base resource schema in which all other resources defined in this specification build
+    This is the base resource schema on which all other resources defined in this specification build.
+    value is the sensed or actuated value of the Resource.
+    range is the range over which value is valid.
+    step is the step function over the defined range if applicable (e.g. always step by '2').
   displayName: Base Resource Schema
 
   get:
@@ -42,8 +45,9 @@ traits:
                 "rt" :          ["oic.baseresource"],
                 "if":           ["oic.if.baseline"],
                 "id":           "unique_example_id",
-                "value":        "someValue",
-                "range":        [0,100]
+                "value":        8,
+                "range":        [0,100],
+                "step":         2
               }
 
   post:
@@ -54,7 +58,7 @@ traits:
         schema: base
         example: |
           {
-            "value":  "newValue"
+            "value":  10
           }
     responses:
       200:
@@ -63,5 +67,5 @@ traits:
             schema: base
             example: |
               {
-                "value":  "newValue"
+                "value":  10
               }
diff --git a/colourRGB.raml b/colourRGB.raml
@@ -23,8 +23,8 @@ traits:
     This resource specifies the actual colour in the RGB space represented as an array of integers.
     Each colour value is described with a Red, Green, Blue component.
     These colour values are encoded as an array of integer values ([R,G,B]).
-    The minimum and maximum colour value per component is described by the range array.
-    When the range value is omitted, then the range is [0,255].
+    The minimum and maximum colour value per component may be described by range (from oic.r.baseresource).
+    When range (from oic.r.baseresource) is omitted, then the range is [0,255].
   displayName: Colour RGB
   is: [ interface ] # valid for all methods