HeightResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Height",
    "version": "2019-03-22",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
      "x-copyright": "Copyright 2016-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": {
    "/HeightResURI": {
      "get": {
        "description": "This Resource describes the Properties associated with height of an object's physical size.\nThe unit is a single value that is one of m, cm, ft or in.\nIf the unit Property is missing the default is meters [m].\nThe unit Property is a read-only value that is provided by the server.\nWhen range is omitted the default is 0 to +MAXFLOAT.",
        "parameters": [
          {
            "$ref": "#/parameters/interface"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "x-example": {
              "rt": [
                "oic.r.height"
              ],
              "height": 1.8,
              "units": "m"
            },
            "schema": {
              "$ref": "#/definitions/Height"
            }
          }
        }
      },
      "post": {
        "description": "Sets the height.",
        "parameters": [
          {
            "$ref": "#/parameters/interface"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Height"
            },
            "x-example": {
              "height": 1.75,
              "units": "m"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Indicates that the height was successfully changed.\nThe new height is provided in the response.",
            "x-example": {
              "height": 1.75,
              "units": "m"
            },
            "schema": {
              "$ref": "#/definitions/Height"
            }
          },
          "403": {
            "description": "Indicates that OCF Client sent an invalid Property value to the Server.\nThe Server responds with the current Resource representation.",
            "x-example": {
              "height": 1.8,
              "units": "m"
            },
            "schema": {
              "$ref": "#/definitions/Height"
            }
          }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": [
        "oic.if.a",
        "oic.if.s",
        "oic.if.baseline"
      ]
    }
  },
  "definitions": {
    "Height": {
      "properties": {
        "rt": {
          "description": "Resource Type",
          "items": {
            "enum": [
              "oic.r.height"
            ],
            "type": "string",
            "maxLength": 64
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "height": {
          "description": "Height of an object",
          "minimum": 0,
          "type": "number"
        },
        "units": {
          "description": "Height unit",
          "enum": [
            "m",
            "cm",
            "ft",
            "in"
          ],
          "readOnly": true,
          "type": "string",
          "default": "m"
        },
        "range": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number"
        },
        "step": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number"
        },
        "precision": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision"
        },
        "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.s",
              "oic.if.baseline"
            ],
            "type": "string",
            "maxLength": 64
          },
          "minItems": 1,
          "readOnly": true,
          "uniqueItems": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": [
        "height"
      ]
    }
  }
}