BrewingResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Brewing",
    "version": "2019-02-22",
    "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": {
    "/BrewingResURI" : {
      "get": {
        "description": "This Resource describes the attributes associated with brewing. This resource is used for configuration only. The Operation of the Device is handled independently of this Resource. The amount requested is in ml. The strength of a brewed drink is an integer, the range of which may be enforced by the presence of a strengthrange Property.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.brewing"],
                  "if": ["oic.if.rw", "oic.if.baseline"],
                  "amountrequested": 120,
                  "strength": 8,
                  "strengthrange": [1, 10]
                },
              "schema": { "$ref": "#/definitions/Brewing" }
            }
        }
      },
      "post": {
        "description": "Sets the brewing values\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/Brewing" },
            "x-example":
              {
                "amountrequested": 120,
                "strength": 8
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "amountrequested": 120,
                  "strength": 8
                }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.rw", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Brewing" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.brewing"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "strength": {
          "description": "The strength of a brewed drink.",
          "type": "integer"
        },
        "amountrequested": {
          "description": "The amount requested in ml.",
          "type": "integer"
        },
        "strengthrange": {
          "description": "The minimum and maximum value of the strength of the brewed drink.",
          "items": {
            "type": "integer"
          },
          "maxItems": 2,
          "minItems": 2,
          "readOnly": 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"
        },
        "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": ["amountrequested"]
    }
  }
}