ClockResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Clock",
    "version": "2019-03-27",
     "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": {
    "/ClockResURI" : {
      "get": {
        "description": "This Resource describes the properties associated with clock and time.\nClock is a time information.\nThe Property \"datetime\" is using RFC3339 datetime format (e.g: \"2007-04-05T14:30Z\") (Time+Date+Timezone)\nThe Property \"countdown\" is the desired total seconds for countdown.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.clock"],
                  "if": ["oic.if.a", "oic.if.baseline"],
                  "datetime": "2015-11-05T14:30:00Z",
                  "countdown": 0.0
                },
              "schema": { "$ref": "#/definitions/Clock" }
            }
        }
      },
      "post": {
        "description": "Sets the desired datetime.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/Clock" },
            "x-example":
              {
                "datetime": "2015-11-05T14:30:00Z",
                "countdown": 0.0
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "Indicates that the datetime value was successfully changed.\nThe new datetime value is provided in the response.\n",
              "x-example":
                {
                  "datetime": "2015-11-05T14:30:00Z",
                  "countdown": 0.0
                }
                ,
              "schema": { "$ref": "#/definitions/Clock" }
            },
            "403": {
              "description" : "Indicates that OIC client sent an invalid property value to the server.\nThe server responds with the required input representation.\n",
              "x-example":
                {
                  "datetime": "2015-11-05T14:30:00Z",
                  "countdown": 0.0
                }
                ,
              "schema": { "$ref": "#/definitions/Clock" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.a", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Clock": {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.clock"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "readOnly": true,
          "type": "array"
        },
        "countdown": {
          "description": "The desired total seconds for countdown.",
          "minimum": 0,
          "type": "number"
        },
        "datetime": {
          "description": "Rhe date time using RFC3339 datetime format (e.g: 2007-04-05T14:30:00Z, 2007-04-05T14:30:00+09:00).",
          "type": "string",
          "format" : "date-time"
        },
         "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,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["datetime"]
    }
  }
}