TimePeriodResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Time Period",
    "version": "v1.1.0-20160519",
    "license": {
      "name": "copyright 2016-2017 Open Connectivity Foundation, Inc. All rights reserved.",
      "x-description": "Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\n        1.  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\n        2.  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.\n\n        THIS SOFTWARE IS PROVIDED BY THE Open Connectivity Foundation, INC. \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE OR WARRANTIES OF NON-INFRINGEMENT, ARE DISCLAIMED.\n        IN NO EVENT SHALL THE Open Connectivity Foundation, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\n        HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
    }
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/TimePeriodResURI" : {
      "get": {
        "description": "This resource describes the time period over which any additionally provided\ninformation is derived or bounded.\nThe startTime and stopTime are ISO8601 encoded strings.  startTime must be present.\nThe interval is the interval of the time period in minutes, if present this value must be no less than 1 minute.\nstoptime and interval are mutually exclusive; both Properties cannot be present in a Resource instance.\nDefines a time period for information retrieval, action or other behaviour.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt":       ["oic.r.time.period"],
                  "id":       "unique_example_id",
                  "startTime":"2015-01-09T14:30Z",
                  "stopTime": "2015-01-09T14:45Z"
                }
                ,
              "schema": { "$ref": "#/definitions/TimePeriod" }
            }
        }
      },
      "post": {
        "description": "Sets or updates a time period for information retrieval, action or other behavior.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/TimePeriod" },
            "x-example":
              {
                "id":       "unique_example_id",
                "startTime":"2015-01-09T14:30Z",
                "stopTime": "2015-01-09T14:45Z"
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "id":       "unique_example_id",
                  "startTime":"2015-01-09T14:30Z",
                  "stopTime": "2015-01-09T14:45Z"
                }
                ,
              "schema": { "$ref": "#/definitions/TimePeriod" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in" : "query",
      "name" : "if",
      "type" : "string",
      "enum" : ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "TimePeriod" : 
            {
        "properties": {
          "interval": {
            "description": "Time interval in minutes after the startTime, if present stopTime cannot be present",
            "type": "integer"
          },
          "precision": {
            "description": "Accuracy granularity of the exposed value",
            "readOnly": true,
            "type": "number"
          },
          "range": {
            "description": "The valid range for the value Property",
            "items": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "maxItems": 2,
            "minItems": 2,
            "readOnly": true,
            "type": "array"
          },
          "startTime": {
            "description": "Start time for the time period",
            "type": "string"
          },
          "step": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "number"
              }
            ],
            "description": "Step value across the defined range",
            "readOnly": true
          },
          "stopTime": {
            "description": "Stop time for the time period, if present interval cannot be present",
            "type": "string"
          },
          "value": {
            "anyOf": [
              {
                "type": "array"
              },
              {
                "type": "string"
              },
              {
                "type": "boolean"
              },
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "object"
              }
            ],
            "description": "The value sensed or actuated by this Resource"
          }
        },
        "required": [
          "startTime"
        ],
        "type": "object"
      }

  }
}