AutoFocusResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Auto Focus",
    "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": {
    "/AutoFocusResURI" : {
      "get": {
        "description": "This Resource describes an auto focus on/off feature.\nThe Property \"autoFocus\" is a boolean.\nAn \"autoFocus\" value of 'true' means that the auto focus feature is on.\nAn \"autoFocus\" value of 'false' means that the auto focus feature is off.\nNote that when Pan Tilt Zoom (see 'Pan Tilt Zoom' Resource definition) is used the autofocus works only in the selected area.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.autofocus"],
                  "if": ["oic.if.a", "oic.if.baseline"],
                  "autoFocus": false
                },
              "schema": { "$ref": "#/definitions/AutoFocus" }
            }
        }
      },
      "post": {
        "description": "",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/AutoFocus" },
            "x-example":
              {
                "autoFocus": true
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "autoFocus": true
                },
              "schema": { "$ref": "#/definitions/AutoFocus" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "AutoFocus" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.autofocus"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "autoFocus": {
          "description": "The status of the Auto Focus feature.",
          "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,
          "readOnly": true,
          "uniqueItems": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["autoFocus"]
    }
  }
}