GasConsumptionResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Gas Consumption",
    "version": "2019-03-18",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://openconnectivityfoundation.github.io/core/LICENSE.md",
      "x-copyright": "Copyright 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": {
    "/GasConsumptionResURI" : {
      "get": {
        "description": "This Resource describes Properties associated with the energy associated with the consumption of natural gas\nThe gas value is in kilowatt hours [kWh].\nThe volume value is in metres cubed [m3].\nProvides the cumulative gas energy, the cumulative gas volume and the calorific value and conversion factor used/required to convert from gas volume (m3[TB1]) to gas energy (KWh).\n",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
          "200": {
            "description" : "Success path response for the Resource",
            "x-example": {
              "rt":     ["oic.r.gas.consumption"],
              "gas":  11135.41,
              "volume": 1000.0
            },
            "schema": { "$ref": "#/definitions/Consumption" }
          }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Consumption" : {
      "properties": {
        "rt":  {
          "description": "Resource Type",
          "items": {
            "maxLength": 64,
            "type": "string",
            "enum": ["oic.r.gas.consumption"]
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "if":  {
          "description": "The OCF Interfaces supported by this Resource",
          "items": {
            "enum": ["oic.if.r", "oic.if.baseline"],
            "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"
        },
        "gas" :  {
          "description": "gas energy consumed in kWh",
          "readOnly": true,
          "type": "number",
		      "minimum": 0
        },
        "precision" :  {
          "description": "Accuracy granularity of the exposed value",
          "readOnly": true,
          "type": "number"
        },
        "volume" :  {
          "description": "gas volume consumed in m3 (metres cubed)",
          "readOnly": true,
          "type": "number",
		      "minimum": 0
        }
      },
      "type" : "object",
      "required": ["gas"]
    }
  }
}