ColourChromaResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Colour Chroma",
    "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/ColourChromaResURI" : {
      "get": {
        "description": "This Resource describes the colour using chroma conventions.\nProperties are \"hue\", \"saturation\", \"csc\", and \"ct\".\nThe Property \"hue\" is the hue angle, it is an integer value as defined by the CIECAM02 model definition (see reference [CIE CIE159:2004]).\nThe Property \"saturation\" is an integer value as defined by the CIECAM02 model definition (see reference [CIE CIE159:2004]).\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 Property \"csc\" is the colour space coordinates in CIE colour space.\n  The first item in the array is the X coordinate.\n  The second item in the array is the Y coordinate.\nThe Property \"nct\" is the Mired colour temperature.\nThe Resource provides the colour using chroma conventions.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.colour.chroma"],
                  "if": [ "oic.if.a", "oic.if.baseline"],
                  "hue": 256.0,
                  "saturation": 212,
                  "maximumsaturation": 1000,
                  "csc": [0.41, 0.51],
                  "ct": 457
                },
              "schema": { "$ref": "#/definitions/ColourChroma" }
            }
        }
      },
      "post": {
        "description": "Sets current colour chroma values\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/ColourChroma" },
            "x-example":
              {
                "hue": 300.0,
                "saturation": 212,
                "csc": [0.41, 0.51],
                "ct": 457
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "hue": 300.0,
                  "saturation": 212,
                  "csc": [0.41, 0.51],
                  "ct": 467
                },
              "schema": { "$ref": "#/definitions/ColourChroma" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
       "ColourChroma" : {
          "properties": {
                "rt" : {
                  "description": "The Resource Type.",
                  "items": {
                    "enum": ["oic.r.colour.chroma"],
                    "maxLength": 64,
                    "type": "string"
                  },
                  "minItems": 1,
                  "uniqueItems": true,
                  "readOnly": true,
                  "type": "array"
                },
                "ct" : {
                  "description": "The Mired colour temperature.",
                  "minimum": 0,
                  "type": "integer"
                },
                "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"
                },
                "csc" :  {
                  "description": "The X and Y coordinates of the colour in CIE colour space",
                  "items": {
                    "maximum": 1,
                    "minimum": 0,
                    "type": "number"
                  },
                  "maxItems": 2,
                  "minItems": 2,
                  "type": "array"
                },
                "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"
                },
                "if" :  {
                  "description": "The OCF Interface set supported by this Resource.",
                  "items": {
                    "enum": [
                      "oic.if.a",
                      "oic.if.baseline"
                    ],
                    "maxLength": 64,
                    "type": "string"
                  },
                  "minItems": 2,
                  "uniqueItems": true,
                  "readOnly": true,
                  "type": "array"
                }
           },
           "type" : "object",
           "required": ["hue", "saturation", "csc"]
       }
   }
}