HeartRateZoneResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Heart Rate Zone",
    "version": "2019-03-28",
    "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": {
    "/HeartRateZoneResURI" : {
      "get": {
        "description": "This Resource describes a measured heart rate by the current Zone using the Zoladz method. The Zoladz method defines Zones based on maximum heart rate; Zone 1 is the lowest, Zone 5 is the highest.\nThe heartRateZone is an enumeration containing one of: \"Zone1\", \"Zone2\", \"Zone3\", \"Zone4\", and \"Zone5\".\n",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
          "200": {
            "description" : "",
            "x-example":
              {
                "rt":            ["oic.r.sensor.heart.zone"],
                "heartRateZone": "Zone3"
              },
            "schema": { "$ref": "#/definitions/heartRateZone" }
          }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "heartRateZone" : {
      "properties": {
        "rt": {
          "description": "Resource Type",
          "items": {
            "enum": ["oic.r.sensor.heart.zone"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "readOnly": true,
          "uniqueItems": true,
          "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"
        },
        "heartRateZone": {
          "description": "Current heart rate zone based on the Zoladz system.",
          "enum": [
            "Zone1",
            "Zone2",
            "Zone3",
            "Zone4",
            "Zone5"
          ],
          "readOnly": true,
          "type": "string"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource",
          "items": {
            "enum": [
              "oic.if.s",
              "oic.if.baseline"
            ],
            "type": "string",
            "maxLength": 64
          },
          "minItems": 1,
          "readOnly": true,
          "uniqueItems": true,
          "type": "array"
        }
      },
      "type" : "object",
      "required": ["heartRateZone"]
    }
  }
}