-
Notifications
You must be signed in to change notification settings - Fork 27
/
oic.wk.introspection.swagger.json
150 lines (150 loc) · 4.34 KB
/
oic.wk.introspection.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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
{
"swagger": "2.0",
"info": {
"title": "Introspection Resource",
"version": "2019-03-04",
"license": {
"name": "OCF Data Model License",
"url": "https://openconnectivityfoundation.github.io/core/LICENSE.md",
"x-copyright": "Copyright 2016-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": {
"/IntrospectionResURI": {
"get": {
"description": "This Resource provides the means to get the Introspection Device Data (IDD) specifying all the OCF Endpoints of the Device.\nThe url hosted by this Resource is either a local or an external url.\n",
"parameters": [
{
"$ref": "#/parameters/interface"
}
],
"responses": {
"200": {
"description": "",
"x-example": {
"rt": ["oic.wk.introspection"],
"urlInfo": [
{
"content-type": "application/cbor",
"protocol": "coap",
"url": "coap://[fe80::1]:1234/IntrospectionExampleURI"
}
]
},
"schema": {
"$ref": "#/definitions/oic.wk.introspectionInfo"
}
}
}
}
}
},
"parameters": {
"interface": {
"in": "query",
"name": "if",
"type": "string",
"enum": ["oic.if.r", "oic.if.baseline"]
}
},
"definitions": {
"oic.wk.introspectionInfo": {
"properties": {
"rt": {
"description": "Resource Type of the Resource",
"items": {
"enum": ["oic.wk.introspection"],
"type": "string",
"maxLength": 64
},
"minItems": 1,
"readOnly": true,
"uniqueItems": true,
"type": "array"
},
"n": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
},
"urlInfo": {
"description": "Information on the location of the Introspection Device Data (IDD).",
"items": {
"properties": {
"content-type": {
"default": "application/cbor",
"description": "content-type of the Introspection Device Data",
"enum": [
"application/json",
"application/cbor"
],
"type": "string"
},
"protocol": {
"description": "Identifier for the protocol to be used to obtain the Introspection Device Data",
"enum": [
"coap",
"coaps",
"http",
"https",
"coap+tcp",
"coaps+tcp"
],
"type": "string"
},
"url": {
"description": "The URL of the Introspection Device Data.",
"format": "uri",
"type": "string"
},
"version": {
"default": 1,
"description": "The version of the Introspection Device Data that can be downloaded",
"enum": [
1
],
"type": "integer"
}
},
"required": [
"url",
"protocol"
],
"type": "object"
},
"minItems": 1,
"readOnly": true,
"type": "array"
},
"id": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
},
"if": {
"description": "The OCF Interfaces supported by this Resource",
"items": {
"enum": [
"oic.if.r",
"oic.if.baseline"
],
"type": "string",
"maxLength": 64
},
"minItems": 2,
"readOnly": true,
"uniqueItems": true,
"type": "array"
}
},
"type" : "object",
"required": ["urlInfo"]
}
}
}