ColourHueSaturationResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Colour Hue and Saturation",
    "version": "2019-02-15",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
      "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved."
    },
    "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/example/ColourHueSaturationResURI" : {
      "get": {
        "description": "This Resource describes the colour using hue-saturation conventions.\nThe Property \"hue\" is the hue angle, it is a number value as defined by the CIECAM02 model definition (see reference [CIE CIE159:2004]).\nA Device that does not support fractional hue angles can provide integer values.\nIf Property \"precision\" is provided it applies to the hue angle.\nThe Property \"saturation\" is an integer value as defined by the CIECAM02 model definition (see reference [CIE CIE159:2004]).\n The Property \"saturation\" can be converted to a percentage by saturation/maximumsaturation X 100; where maximumsaturation is 32767 if the Property itself is not present.\nThe Property \"maximumsaturation\" is the upper bound on the saturation supported by the Device.\nIf not present the maximum value for saturation is 32767.\nThe Resource provides the colour using hue and saturation conventions.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.colour.hs"],
                  "if": ["oic.if.a", "oic.if.baseline"],
                  "hue": 300.0,
                  "saturation": 212,
                  "maximumsaturation": 1000
                },
              "schema": { "$ref": "#/definitions/ColourHS" }
            }
        }
      },
      "post": {
        "description": "Sets current colour hue and saturation values.\nAt least one of hue or saturation shall be provided in the payload.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/ColourHS" },
            "x-example":
              {
                "hue": 300.0,
                "saturation": 212
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "hue": 300.0,
                  "saturation":  212
                },
              "schema": { "$ref": "#/definitions/ColourHS" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "ColourHS" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.colour.hs"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "hue": {
          "description": "The hue angle as defined by the CIECAM02 model definition.",
          "maximum": 360.0,
          "minimum": 0.0,
          "type": "number"
        },
        "saturation": {
          "description": "The saturation as defined by the CIECAM02 model definition.",
          "maximum": 32767,
          "minimum": 0,
          "type": "integer"
        },
        "maximumsaturation": {
          "description": "The maximum supported value of \"saturation\" for this Device.",
          "maximum": 32767,
          "minimum": 0,
          "readOnly": true,
          "type": "integer"
        },
        "n": {
           "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "id": {
           "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
        },
        "precision": {
            "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.a",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["hue", "saturation"]
    }
  }
}