EnergyResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Energy",
    "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": {
    "/EnergyResURI" : {
      "get": {
        "description": "This Resource describes the attributes associated with electrical energy. This Resource can be used for either rated (read-only), desired (read-write) or measured (read-only) energy. The Property \"voltage\" is in Volts (V), The Property \"current\" in Amps (A), and The Property \"frequency\" is in Hertz (Hz).",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "Retrieves the current energy.",
              "x-example":
                {
                  "rt": ["oic.r.energy.electrical"],
                  "if": ["oic.if.rw", "oic.if.baseline"],
                  "voltage": 120.0,
                  "current": 5.0,
                  "frequency": 60.0
                },
              "schema": { "$ref": "#/definitions/Energy" }
            }
        }
      },
      "post": {
        "description": "Sets the desired energy values\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/EnergyUpdate" },
            "x-example":
              {
                "desiredvoltage": 130.0,
                "desiredcurrent": 6.0
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "desiredvoltage": 130.0,
                  "desiredcurrent": 6.0
                }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.rw", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Energy" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.energy.electrical"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "desiredcurrent": {
          "description": "The desired electric current in Amps (A).",
          "type": "number"
        },
        "current": {
          "description": "The electric current in Amps (A).",
          "readOnly": true,
          "type": "number"
        },
        "frequency": {
          "description": "The electric frequency in Hertz (Hz).",
          "readOnly": true,
          "type": "number"
        },
        "voltage": {
          "description": "The electric voltage in Volts (V).",
          "readOnly": true,
          "type": "number"
        },
        "desiredfrequency": {
          "description": "The desired electric frequency in Hertz (Hz).",
          "type": "number"
        },
        "desiredvoltage": {
          "description": "The desired electric voltage in Volts (V).",
          "type": "number"
        },
        "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": ["voltage", "current", "frequency"]
    }
    ,
    "EnergyUpdate" : {
      "properties": {
        "desiredcurrent": {
          "description": "The desired electric current in Amps (A).",
          "type": "number"
        },
        "desiredfrequency": {
          "description": "The desired electric frequency in Hertz (Hz).",
          "type": "number"
        },
        "desiredvoltage": {
          "description": "The desired electric voltage in Volts (V).",
          "type": "number"
        }
      },
      "anyOf": [
        {
          "required": ["desiredvoltage"]
        },
        {
          "required": ["desiredcurrent"]
        },
        {
          "required": ["desiredfrequency"]
        }
      ],
      "type": "object"
    }
  }
}