DaliConfig.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "DALI Configuration",
    "version": "2021-04-22",
    "license": {
        "name": "OCF Data Model License",
        "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
        "x-copyright": "Copyright 2021 Open Connectivity Foundation, Inc. All rights reserved."
    },
    "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/daliconf" : {
      "get": {
        "description": "This Resource describes a DALI (addressing) configuration,  IEC 62386-104, Digital  addressable lighting interface - Part 104: General requirements - Wireless and alternative wired system.\n",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.dali.conf"],
                  "if": ["oic.if.baseline", "oic.if.rw"],
                  "bus": 2,
                  "src": 5,
                  "ver": 2
                },
              "schema": { "$ref": "#/definitions/Response" }
            }
        }
      },
      "post": {
        "description": "The POST can be used to set the bus identification or to issue an DALI FF frame. The command can be issued as Multicast (SSM) or as unicast. The Multicast command will have no response, the unicast command can have a BF response.",
        "parameters": [
          {"$ref": "#/parameters/interface"},
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": { "$ref": "#/definitions/Request" },
            "x-example":
              {
                "bus": 3
              }
          }
        ],
        "responses": {
            "200": {
              "description" : "The BF response of a unicast command",
              "x-example":
                {
                  "bus": 3,
                  "src": 5,
                  "ver": 2
                },
              "schema": { "$ref": "#/definitions/Response" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.baseline", "oic.if.rw"]
    }
  },
  "definitions": {
    "Request": {
      "properties": {
        "bus": {
          "description": "assign the bus identifier.",
          "type": "integer"
        },
        "src": {
          "description": "assigned source address. -1 means not yet assigned by the Application controller.",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "Response": {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.dali.conf"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "bus": {
          "description": "The assigned bus identifier.",
          "type": "integer"
        },
        "src": {
          "description": "assigned source address. -1 means not yet assigned by the Application controller.",
          "type": "integer"
        },
        "ver": {
          "description": "version of dali on the device.",
          "type": "integer",
          "enum": [1, 2]
        },
        "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. Baseline as default interface.",
          "items": {
            "enum": [
              "oic.if.baseline",
              "oic.if.rw"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["ver"]
    }
  }
}