3DPrinterResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "3D Printer",
    "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": {
    "/3DPrinterResURI" : {
      "get": {
        "description": "This Resource describes the attributes associated with 3D Printer. The type of 3D printing technology is specified by an enumerated string value. The maximum sizes in mm are included for the x, y, and z dimensions. A designation of whether the device is capable of WAN connectivity is represented in a boolean. The memory capacity is captured in MB.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt" : ["oic.r.printer.3d"],
                  "if" : ["oic.if.r", "oic.if.baseline"],
                  "3dprinttype" : "Digital Light Processing",
                  "printsizex" : 300.00,
                  "printsizey" : 200.50,
                  "printsizez" : 250.75,
                  "wanconnected" : false,
                  "memorysize" : 120.5
                },
              "schema": { "$ref": "#/definitions/3DPrinter" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.r", "oic.if.baseline"]
    }
  },
  "definitions": {
    "3DPrinter": {
      "properties": {
        "rt": {
          "description": "The Resource Type",
          "items": {
            "maxLength": 64,
            "type": "string",
            "enum": ["oic.r.printer.3d"]
          },
          "minItems": 1,
          "uniqueItems" : true,
          "readOnly": true,
          "type": "array"
        },
        "printsizey": {
          "description": "This Property represents the maximum size of printing object in the direction of Y-axis. The unit is mm.",
          "readOnly": true,
          "type": "number"
        },
        "memorysize": {
          "description": "This Property represents the total memory size of the printer. The unit is MB(Mega Bytes)",
          "readOnly": true,
          "type": "number"
        },
        "3dprinttype": {
          "description": "The type of 3D printing technology.",
          "enum": [
            "Fused Filament Fabrication",
            "Fused Deposition Modeling",
            "Digital Light Processing",
            "Powder Bed & inkjet head 3D Printing",
            "Photopolymer Jetting Technology",
            "Laminated Object Manufacturing",
            "Stereolithography Apparatus",
            "Selective Laser Sintering",
            "Unknown"
          ],
          "readOnly": true,
          "type": "string"
        },
        "wanconnected": {
          "description": "This Property indicates the connectivity capability of the 3D printer. If the value is false, the printer does not have network facility to Wide Area Network such as internet and GSM. If the value is true, the printer has network connectivity",
          "readOnly": true,
          "type": "boolean"
        },
        "printsizex": {
          "description": "This Property represents the maximum size of printing object in the direction of X-axis. The unit is mm.",
          "readOnly": true,
          "type": "number"
        },
        "printsizez": {
          "description": "This Property represents the maximum size of printing object in the direction of Z-axis. The unit is mm.",
          "readOnly": true,
          "type": "number"
        },
        "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.r",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "readOnly": true,
          "uniqueItems": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["3dprinttype", "printsizex", "printsizey", "printsizez", "wanconnected", "memorysize"]
    }
  }
}