bridge_device_IDD.json 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. {
  2. "schemes": [
  3. "http"
  4. ],
  5. "swagger": "2.0",
  6. "consumes": [
  7. "application/json"
  8. ],
  9. "paths": {
  10. "/bridge/vodlist": {
  11. "get": {
  12. "description": "This resource describes the VODs that have been onboarded on the Bridge Platform.\n",
  13. "responses": {
  14. "200": {
  15. "schema": {
  16. "$ref": "#/definitions/vodlist"
  17. },
  18. "description": ""
  19. }
  20. },
  21. "parameters": [
  22. {
  23. "$ref": "#/parameters/interface-r"
  24. },
  25. {
  26. "schema": {
  27. "$ref": "#/definitions/vodlist"
  28. },
  29. "in": "body",
  30. "required": true,
  31. "name": "body"
  32. }
  33. ]
  34. }
  35. },
  36. "/oic/p": {
  37. "get": {
  38. "responses": {
  39. "200": {
  40. "schema": {
  41. "$ref": "#/definitions/Platform"
  42. },
  43. "description": ""
  44. }
  45. },
  46. "parameters": [
  47. {
  48. "$ref": "#/parameters/interface-r"
  49. }
  50. ],
  51. "description": ""
  52. }
  53. }
  54. },
  55. "definitions": {
  56. "vodlist": {
  57. "properties": {
  58. "n": {
  59. "type": "string",
  60. "maxLength": 64,
  61. "readOnly": true,
  62. "description": "Friendly name of the Resource"
  63. },
  64. "rt": {
  65. "minItems": 1,
  66. "items": {
  67. "enum": [
  68. "oic.r.vodlist"
  69. ],
  70. "type": "string",
  71. "maxLength": 64
  72. },
  73. "description": "Resource Type",
  74. "uniqueItems": true,
  75. "readOnly": true,
  76. "default": [
  77. "oic.r.vodlist"
  78. ],
  79. "type": "array"
  80. },
  81. "if": {
  82. "minItems": 2,
  83. "items": {
  84. "enum": [
  85. "oic.if.r",
  86. "oic.if.baseline"
  87. ],
  88. "type": "string"
  89. },
  90. "description": "The OCF Interface set supported by this Resource",
  91. "uniqueItems": true,
  92. "readOnly": true,
  93. "type": "array"
  94. },
  95. "vods": {
  96. "description": "Array of information per VOD created by the Bridge",
  97. "type": "array",
  98. "minItems": 0,
  99. "uniqueItems": true,
  100. "readOnly": true,
  101. "items": {
  102. "$ref": "#/definitions/vodentry"
  103. }
  104. }
  105. },
  106. "required": [ "vods" ],
  107. "type": "object"
  108. },
  109. "vodentry": {
  110. "description": "Information for a VOD created by the Bridge",
  111. "type": "object",
  112. "properties": {
  113. "n": {
  114. "type": "string",
  115. "maxLength": 64,
  116. "readOnly": true,
  117. "description": "Friendly name of the Resource"
  118. },
  119. "di": {
  120. "type": "string",
  121. "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
  122. "readOnly": true,
  123. "description": "Format pattern according to IETF RFC 4122."
  124. },
  125. "econame": {
  126. "type": "string",
  127. "enum": [ "ABC", "XYZ" ],
  128. "readOnly": true,
  129. "description": "Ecosystem Name of the Bridged Device which is exposed by this VOD"
  130. }
  131. },
  132. "required": ["n", "di", "econame"]
  133. },
  134. "Platform": {
  135. "properties": {
  136. "id": {
  137. "type": "string",
  138. "readOnly": true,
  139. "maxLength": 64,
  140. "description": ""
  141. },
  142. "if": {
  143. "minItems": 2,
  144. "items": {
  145. "enum": [
  146. "oic.if.r",
  147. "oic.if.baseline"
  148. ],
  149. "type": "string",
  150. "maxLength": 64
  151. },
  152. "description": "",
  153. "uniqueItems": true,
  154. "readOnly": true,
  155. "type": "array"
  156. },
  157. "n": {
  158. "type": "string",
  159. "readOnly": true,
  160. "maxLength": 64,
  161. "description": ""
  162. },
  163. "mnmn": {
  164. "type": "string",
  165. "readOnly": true,
  166. "maxLength": 64,
  167. "description": ""
  168. },
  169. "mnnct": {
  170. "minItems": 1,
  171. "items": {
  172. "minimum": 1,
  173. "type": "integer",
  174. "description": ""
  175. },
  176. "readOnly": true,
  177. "type": "array",
  178. "description": ""
  179. },
  180. "mnml": {
  181. "format": "uri",
  182. "type": "string",
  183. "readOnly": true,
  184. "maxLength": 256,
  185. "description": ""
  186. },
  187. "mnsel": {
  188. "type": "string",
  189. "readOnly": true,
  190. "maxLength": 64,
  191. "description": ""
  192. },
  193. "mnpv": {
  194. "type": "string",
  195. "readOnly": true,
  196. "maxLength": 64,
  197. "description": ""
  198. },
  199. "mnfv": {
  200. "type": "string",
  201. "readOnly": true,
  202. "maxLength": 64,
  203. "description": ""
  204. },
  205. "rt": {
  206. "minItems": 1,
  207. "items": {
  208. "enum": [
  209. "oic.wk.p"
  210. ],
  211. "type": "string",
  212. "maxLength": 64
  213. },
  214. "description": "",
  215. "uniqueItems": true,
  216. "readOnly": true,
  217. "default": [
  218. "oic.wk.p"
  219. ],
  220. "type": "array"
  221. },
  222. "mnos": {
  223. "type": "string",
  224. "readOnly": true,
  225. "maxLength": 64,
  226. "description": ""
  227. },
  228. "mnhw": {
  229. "type": "string",
  230. "readOnly": true,
  231. "maxLength": 64,
  232. "description": ""
  233. },
  234. "vid": {
  235. "type": "string",
  236. "readOnly": true,
  237. "maxLength": 64,
  238. "description": ""
  239. },
  240. "mnmo": {
  241. "type": "string",
  242. "readOnly": true,
  243. "maxLength": 64,
  244. "description": ""
  245. },
  246. "mndt": {
  247. "readOnly": true,
  248. "type": "string",
  249. "pattern": "^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$",
  250. "description": ""
  251. },
  252. "pi": {
  253. "readOnly": true,
  254. "type": "string",
  255. "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
  256. "description": ""
  257. },
  258. "st": {
  259. "format": "date-time",
  260. "readOnly": true,
  261. "type": "string",
  262. "description": ""
  263. },
  264. "mnsl": {
  265. "format": "uri",
  266. "type": "string",
  267. "readOnly": true,
  268. "maxLength": 256,
  269. "description": ""
  270. }
  271. },
  272. "required": [
  273. "pi",
  274. "mnmn"
  275. ],
  276. "type": "object"
  277. }
  278. },
  279. "info": {
  280. "version": "20190215",
  281. "title": "serverlite24521",
  282. "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md",
  283. "license": {
  284. "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved.",
  285. "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
  286. "name": "OCF Data Model License"
  287. }
  288. },
  289. "parameters": {
  290. "interface-r": {
  291. "enum": [
  292. "oic.if.r",
  293. "oic.if.baseline"
  294. ],
  295. "type": "string",
  296. "in": "query",
  297. "name": "if"
  298. }
  299. },
  300. "produces": [
  301. "application/json"
  302. ]
  303. }