EcomodeResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Eco Mode",
    "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": {
    "/EcomodeResURI" : {
      "get": {
        "description": "This Resource specifies the supported and currently active Eco Mode of a Device\nThe Resource is a deriviative of the Mode Resource (oic.r.mode) with a restriction that the population of supportedmodes and modes Properties is restricted to the set of values:\n\"disabled\",\"enabled\",\"notsupported\".\nThe adminforced Property indicates that the value has been set by another party (e.g. via some offboard Smart Energy interaction)\n",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.ecomode"],
                  "if": ["oic.if.a", "oic.if.baseline"],
                  "supportedModes": ["disabled","enabled"],
                  "modes": ["disabled"],
                  "adminforced": false
                },
              "schema": { "$ref": "#/definitions/ecomode" }
            }
        }
      },
      "post": {
        "description": "",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/ecomode-update" },
            "x-example":
              {
                "modes": ["enabled"]
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "modes": ["enabled"]
                },
              "schema": { "$ref": "#/definitions/ecomode-update" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "ecomode" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.ecomode"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "modes": {
          "description": "The array of the currently active mode(s).",
          "items": {
            "enum": ["disabled", "enabled", "notsupported"],
            "type": "string"
          },
          "uniqueItems": true,
          "type": "array"
        },
        "supportedModes": {
          "description": "The array of possible modes the device supports.",
          "items": {
            "enum": ["disabled", "enabled", "notsupported"],
            "type": "string"
          },
          "readOnly": true,
          "type": "array"
        },
        "adminforced": {
          "description": "The indicator that the current mode of operation has been forced by admin action.",
          "readOnly": true,
          "type": "boolean"
        },
        "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.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type" : "object",
      "required": ["supportedModes", "modes"]
    },
    "ecomode-update" : {
      "properties": {
        "modes": {
          "description": "The desired mode.",
          "items": {
            "enum": ["disabled", "enabled", "notsupported"],
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object",
     "required": ["modes"]
    }
  }
}