BatteryResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Battery",
    "version": "2019-06-18",
    "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": {
    "/BatteryResURI" : {
      "get": {
        "description": "This Resource describes the attributes associated with a battery. The Property \"charge\" is an integer showing the current battery charge level as a percentage in the range 0 (fully discharged) to 100 (fully charged). The Property \"capacity\" represents the total capacity of battery in Amp Hours (Ah). The \"charging\" status and \"discharging\" status are represented by boolean values set to \"true\" indicating enabled and \"false\" indicating disabled. Low battery status is represented by a boolean value set to \"true\" indicating low charge level and \"false\" indicating otherwise, based upon the battery threshold represented as a percentage.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
          "200": {
            "description" : "",
            "x-example":
            {
              "rt": ["oic.r.energy.battery"],
              "if": ["oic.if.rw", "oic.if.baseline"],
              "charge": 50,
              "capacity": 3000,
              "charging": true,
              "discharging": false,
              "lowbattery": false,
              "batterythreshold": 20,
              "defect": false,
              "timestamp": "2015-11-05T14:30:00.20Z"
            },
            "schema": { "$ref": "#/definitions/Battery" }
          }
        }
      },
      "post": {
        "description": "Sets current battery values\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/BatteryUpdate" },
            "x-example":
            {
              "batterythreshold": 20
            }
          }
        ],
        "responses": {
          "200": {
            "description" : "",
            "x-example":
            {
              "batterythreshold": 20
            },
            "schema": { "$ref": "#/definitions/BatteryUpdate" }
          }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.rw", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Battery" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.energy.battery"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "discharging": {
          "description": "The status of discharging.",
          "readOnly": true,
          "type": "boolean"
        },
        "lowbattery": {
          "description": "The status of the low battery warning based upon the defined threshold.",
          "readOnly": true,
          "type": "boolean"
        },
        "capacity": {
          "description": "The total capacity in Amp-hours (Ah).",
          "readOnly": true,
          "type": "number"
        },
         "batterythreshold": {
          "description": "The threshold percentage for the low battery warning.",
          "maximum": 100,
          "minimum": 0,
          "type": "integer"
        },
        "charge": {
          "description": "The current charge percentage.",
          "maximum": 100,
          "minimum": 0,
          "readOnly": true,
          "type": "integer"
        },
        "charging": {
          "description": "The status of charging.",
          "readOnly": true,
          "type": "boolean"
        },
        "defect": {
          "description": "Battery defect detected. True = defect, False = no defect",
          "readOnly": true,
          "type": "boolean"
        },
        "timestamp": {
          "description": "An RFC3339 formatted time indicating when the data was observed (e.g.: 2016-02-15T09:19Z, 1996-12-19T16:39:57-08:00). Note that 1/100 time resolution should be used.",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "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.rw",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type" : "object",
      "required": ["charge"]
    },
    "BatteryUpdate": {
      "properties": {
        "batterythreshold": {
          "description": "The threshold percentage for the low battery warning.",
          "maximum": 100,
          "minimum": 0,
          "type": "integer"
        }
      },
      "type" : "object",
      "required": ["batterythreshold"]
    }
  }
}