Activity.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Activity",
    "version": "2019-03-04",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
      "x-copyright": "Copyright 2018-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": {
    "/ActivityResURI": {
      "get": {
        "description": "This Resource describes the Properties associated with a person's physical activity.\n All Properties are read-only values that are provided by the server.\n When range (from \"oic.r.baseresource\") is omitted the default is 0 to +MAXFLOAT.",
        "parameters": [
          {
            "$ref": "#/parameters/interface"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "x-example": {
              "rt": [
                "oic.r.activity"
              ],
              "activity":     "sleep",
              "steps_day":    1000,
              "steps_reset":  500,
              "ccal_day":     3000.0,
              "ccal_reset":   1500.0
            },
            "schema": {
              "$ref": "#/definitions/Activity"
            }
          }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": [
        "oic.if.s",
        "oic.if.baseline"
      ]
    }
  },
  "definitions": {
    "Activity": {
      "properties": {
        "activity":    {
          "description": "This Property describes the recognized current activity type of user",
          "type": "string",
          "enum": [
            "sleep",
            "sit",
            "stand",
            "walk",
            "run",
            "unknown"
          ],
          "readOnly": true
        },
        "steps_day": {
          "description": "This Property describes the user's step count that measures the number of steps the user has taken since the beginning of the day.",
          "type": "integer",
          "minimum": 0,
          "readOnly": true
        },
        "steps_reset": {
          "description": "This Property describes the user's step count that measures the number of steps the user has taken since the last reset.",
          "type": "integer",
          "minimum": 0,
          "readOnly": true
        },
        "ccal_day": {
          "description": "This Property describes the burned off calories of user since the beginning of the day.",
          "type": "number",
          "minimum": 0.0,
          "readOnly": true
        },
        "ccal_reset": {
          "description": "This Property describes the burned off calories of user since the last reset.",
          "type": "number",
          "minimum": 0.0,
          "readOnly": true
        },
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": [
              "oic.r.activity"
            ],
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "n": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.s", "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "steps_day_range": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_integer"
        },
        "steps_day_step": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_integer"
        },
        "steps_reset_range": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_integer"
        },
        "steps_reset_step": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_integer"
        },
        "ccal_day_range": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number"
        },
        "ccal_day_step": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number"
        },
        "ccal_day_precision": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision"
        },
        "ccal_reset_range": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_number"
        },
        "ccal_reset_step": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_number"
        },
        "ccal_reset_precision": {
          "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/precision"
        }
      },
      "type": "object",
      "required": [
        "activity"
      ]
    }
  }
}