AudioResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Audio Controls",
    "version": "2019-06-20",
    "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": {
    "/AudioResURI" : {
      "get": {
        "description": "This Resource defines basic audio control functions.\nThe Property \"volume\" is an integer containing a percentage [0,100].\nA volume of 0 (zero) means no sound produced.\nA volume of 100 means maximum sound production.\nThe Property \"mute\" is implemented as a boolean.\nA mute value of true means that the device is muted (no audio).\nA mute value of false means that the device is not muted (audio).",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.audio"],
                  "if": ["oic.if.a", "oic.if.baseline"],
                  "volume": 50,
                  "mute": false
                },
              "schema": { "$ref": "#/definitions/Audio" }
            }
        }
      },
      "post": {
        "description": "",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/Audio-update" },
            "x-example":
              {
                "volume": 75
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "volume": 75,
                  "mute": false
                },
              "schema": { "$ref": "#/definitions/Audio" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Audio" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.audio"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "mute": {
          "description": "The mute setting of an audio rendering device.",
          "type": "boolean"
        },
        "volume": {
          "description": "The volume setting of an audio rendering device.",
          "maximum": 100,
          "minimum": 0,
          "type": "integer"
        },
        "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"
        },
        "range": {
            "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/range_integer"
        },
        "step": {
            "$ref": "https://openconnectivityfoundation.github.io/IoTDataModels/schemas/oic.baseresource.properties-schema.json#/definitions/step_integer"
        },
        "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": ["volume", "mute"]
    },
    "Audio-update" : {
      "properties": {
        "mute": {
          "description": "The mute setting of an audio rendering device.",
          "type": "boolean"
        },
        "volume": {
          "description": "The volume setting of an audio rendering device.",
          "maximum": 100,
          "minimum": 0,
          "type": "integer"
        }
      }
    }
  }
}