forked from openconnectivityfoundation/IoTDataModels
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ConsumableResURI.swagger.json
114 lines (114 loc) · 3.9 KB
/
ConsumableResURI.swagger.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
{
"swagger": "2.0",
"info": {
"title": "Consumable",
"version": "2019-02-15",
"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": {
"/ConsumableResURI" : {
"get": {
"description": "This Resource specifies a thing that can be consumed such as filter material, printer toner etc\nThe Propert \"typeofconsumable\" is an enumeration defining the thing being consumed as defined by the Smart Home Device Specification\nThe Property \"remaining\" is an integer capturing the percentatge remaining life\nThe Property \"orderpercentage\" is an integer capturing the percentage life at which replacement or replenishment is recommended by the manufacturer\nThe Property \"url\" is a string containing a URL at which further information may be obtained with respect to the consumable.",
"parameters": [
{"$ref": "#/parameters/interface"}
],
"responses": {
"200": {
"description" : "",
"x-example":
{
"rt": ["oic.r.consumable"],
"if": ["oic.if.s", "oic.if.baseline"],
"typeofconsumable": "tonerBlack",
"remaining": 20,
"orderpercentage": 10,
"url": "http://myreorderURL"
},
"schema": { "$ref": "#/definitions/consumable" }
}
}
}
}
},
"parameters": {
"interface": {
"in": "query",
"name": "if",
"type": "string",
"enum": ["oic.if.s", "oic.if.baseline"]
}
},
"definitions": {
"consumable" : {
"properties": {
"rt": {
"description": "The Resource Type.",
"items": {
"enum": ["oic.r.consumable"],
"maxLength": 64,
"type": "string"
},
"minItems": 1,
"uniqueItems": true,
"readOnly": true,
"type": "array"
},
"remaining": {
"description": "The percentage remaining lifespan.",
"maximum": 100,
"minimum": 0,
"readOnly": true,
"type": "integer"
},
"typeofconsumable": {
"description": "The thing that is being consumed.",
"readOnly": true,
"type": "string"
},
"url": {
"description": "The URL at which additional ordering information may be found.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"orderpercentage": {
"description": "The percentage at which re-ordering is recommended by the manufacturer.",
"maximum": 100,
"minimum": 0,
"readOnly": true,
"type": "integer"
},
"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.s",
"oic.if.baseline"
],
"type": "string"
},
"minItems": 2,
"uniqueItems": true,
"readOnly": true,
"type": "array"
}
},
"type": "object",
"required": ["typeofconsumable", "remaining"]
}
}
}