github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/openapis/pubsub.openapi.yml (about) 1 openapi: "3.0.3" 2 info: 3 version: 1.0.0 4 description: a 5 title: Cios Pub/Sub Openapi 6 7 paths: 8 '/v2/channels': 9 get: 10 tags: 11 - PublishSubscribe 12 parameters: 13 - $ref: "../components/parameters.yml#/components/parameters/name_query" 14 - $ref: "../components/parameters.yml#/components/parameters/resource_owner_id" 15 - $ref: "../components/parameters.yml#/components/parameters/label" 16 - $ref: "../components/parameters.yml#/components/parameters/channel_protocol" 17 - $ref: "../components/parameters.yml#/components/parameters/limit" 18 - $ref: "../components/parameters.yml#/components/parameters/offset" 19 - $ref: "../components/parameters.yml#/components/parameters/order" 20 - $ref: "../components/parameters.yml#/components/parameters/order_by" 21 - $ref: "../components/parameters.yml#/components/parameters/lang" 22 - $ref: "../components/parameters.yml#/components/parameters/is_dev" 23 - $ref: "../components/parameters.yml#/components/parameters/is_public" 24 - $ref: "../components/parameters.yml#/components/parameters/messaging_enabled" 25 - $ref: "../components/parameters.yml#/components/parameters/datastore_enabled" 26 - $ref: "../components/parameters.yml#/components/parameters/messaging_persisted" 27 28 operationId: getChannels 29 responses: 30 200: 31 description: 'OK' 32 content: 33 application/json: 34 schema: 35 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/MultipleChannel" 36 security: 37 - bearerAuth: [ ] 38 post: 39 tags: 40 - PublishSubscribe 41 operationId: createChannel 42 requestBody: 43 required: true 44 content: 45 application/json: 46 schema: 47 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/ChannelProposal" 48 responses: 49 200: 50 description: 'OK' 51 content: 52 application/json: 53 schema: 54 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/SingleChannel" 55 security: 56 - bearerAuth: [ ] 57 '/v2/channels/{channel_id}': 58 get: 59 tags: 60 - PublishSubscribe 61 parameters: 62 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 63 - $ref: "../components/parameters.yml#/components/parameters/lang" 64 - $ref: "../components/parameters.yml#/components/parameters/is_dev" 65 operationId: getChannel 66 responses: 67 200: 68 description: 'OK' 69 content: 70 application/json: 71 schema: 72 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/SingleChannel" 73 security: 74 - bearerAuth: [ ] 75 patch: 76 tags: 77 - PublishSubscribe 78 parameters: 79 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 80 requestBody: 81 required: true 82 content: 83 application/json: 84 schema: 85 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/ChannelUpdateProposal" 86 operationId: updateChannel 87 responses: 88 200: 89 description: 'OK' 90 content: 91 application/json: 92 schema: 93 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/MultipleChannel" 94 security: 95 - bearerAuth: [ ] 96 delete: 97 tags: 98 - PublishSubscribe 99 parameters: 100 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 101 operationId: deleteChannel 102 responses: 103 200: 104 description: 'OK' 105 security: 106 - bearerAuth: [ ] 107 '/v2/messaging': 108 post: 109 tags: 110 - PublishSubscribe 111 operationId: publishMessage 112 parameters: 113 - $ref: "../components/parameters.yml#/components/parameters/packer_format" 114 - $ref: "../components/parameters.yml#/components/parameters/channel_id_query_required" 115 requestBody: 116 required: false 117 content: 118 application/json: 119 schema: { } 120 application/octet-stream: 121 schema: 122 type: string 123 format: byte 124 text/plain: 125 schema: 126 type: string 127 application/xml: 128 schema: 129 type: object 130 responses: 131 200: 132 description: 'OK' 133 security: 134 - bearerAuth: [ ] 135 get: 136 tags: 137 - PublishSubscribe 138 operationId: subscribeMessage 139 parameters: 140 - $ref: "../components/parameters.yml#/components/parameters/packer_format" 141 - $ref: "../components/parameters.yml#/components/parameters/channel_id_query_required" 142 responses: 143 200: 144 description: 'OK' 145 content: 146 application/octet-stream: 147 schema: 148 type: string 149 format: binary 150 security: 151 - bearerAuth: [ ] 152 '/v2/datastore/channels': 153 get: 154 tags: 155 - PublishSubscribe 156 parameters: 157 - $ref: "../components/parameters.yml#/components/parameters/channel_protocol_id" 158 - $ref: "../components/parameters.yml#/components/parameters/limit" 159 - $ref: "../components/parameters.yml#/components/parameters/offset" 160 - $ref: "../components/parameters.yml#/components/parameters/order" 161 - $ref: "../components/parameters.yml#/components/parameters/order_by" 162 163 operationId: getDataStoreChannels 164 responses: 165 200: 166 description: 'OK' 167 content: 168 application/json: 169 schema: 170 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/MultipleDataStoreChannel" 171 security: 172 - bearerAuth: [ ] 173 '/v2/datastore/channels/{channel_id}': 174 get: 175 tags: 176 - PublishSubscribe 177 parameters: 178 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 179 operationId: getDataStoreChannel 180 responses: 181 200: 182 description: 'OK' 183 content: 184 application/json: 185 schema: 186 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/SingleDataStoreChannel" 187 security: 188 - bearerAuth: [ ] 189 delete: 190 tags: 191 - PublishSubscribe 192 parameters: 193 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 194 operationId: deleteDataStoreChannel 195 responses: 196 200: 197 description: 'OK' 198 security: 199 - bearerAuth: [ ] 200 '/v2/datastore/channels/{channel_id}/objects': 201 get: 202 tags: 203 - PublishSubscribe 204 parameters: 205 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 206 - $ref: "../components/parameters.yml#/components/parameters/session_id_query" 207 - $ref: "../components/parameters.yml#/components/parameters/channel_protocol_version" 208 - $ref: "../components/parameters.yml#/components/parameters/channel_protocol_id" 209 - $ref: "../components/parameters.yml#/components/parameters/label" 210 - $ref: "../components/parameters.yml#/components/parameters/location" 211 - $ref: "../components/parameters.yml#/components/parameters/location_range" 212 - $ref: "../components/parameters.yml#/components/parameters/timestamp" 213 - $ref: "../components/parameters.yml#/components/parameters/timestamp_range" 214 - $ref: "../components/parameters.yml#/components/parameters/ascending" 215 - $ref: "../components/parameters.yml#/components/parameters/offset" 216 - $ref: "../components/parameters.yml#/components/parameters/limit" 217 operationId: getDataStoreObjects 218 responses: 219 200: 220 description: 'OK' 221 content: 222 application/json: 223 schema: 224 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/MultipleDataStoreObject" 225 security: 226 - bearerAuth: [ ] 227 post: 228 tags: 229 - PublishSubscribe 230 parameters: 231 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 232 - $ref: "../components/parameters.yml#/components/parameters/channel_protocol_id" 233 - $ref: "../components/parameters.yml#/components/parameters/channel_protocol_version" 234 - $ref: "../components/parameters.yml#/components/parameters/session_id_query" 235 - $ref: "../components/parameters.yml#/components/parameters/location" 236 - $ref: "../components/parameters.yml#/components/parameters/timestamp" 237 operationId: createDataStoreObject 238 requestBody: 239 required: true 240 content: 241 application/octet-stream: 242 schema: 243 type: string 244 format: binary 245 responses: 246 200: 247 description: 'OK' 248 content: 249 application/json: 250 schema: 251 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/SingleDataStoreObject" 252 security: 253 - bearerAuth: [ ] 254 '/v2/datastore/channels/{channel_id}/objects/{object_id}': 255 get: 256 tags: 257 - PublishSubscribe 258 parameters: 259 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 260 - $ref: "../components/parameters.yml#/components/parameters/object_id_required" 261 - $ref: "../components/parameters.yml#/components/parameters/packer_format" 262 operationId: getDataStoreObjectData 263 responses: 264 200: 265 description: 'OK' 266 content: 267 application/json: 268 schema: { } 269 text/plain: 270 schema: 271 type: string 272 security: 273 - bearerAuth: [ ] 274 delete: 275 tags: 276 - PublishSubscribe 277 parameters: 278 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 279 - $ref: "../components/parameters.yml#/components/parameters/object_id_required" 280 operationId: deleteDataStoreObjectData 281 responses: 282 200: 283 description: 'OK' 284 content: 285 application/json: 286 schema: 287 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/MultipleDataStoreObject" 288 security: 289 - bearerAuth: [ ] 290 '/v2/datastore/channels/{channel_id}/object_latest': 291 get: 292 tags: 293 - PublishSubscribe 294 parameters: 295 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 296 - $ref: "../components/parameters.yml#/components/parameters/packer_format" 297 operationId: getDataStoreObjectDataLatest 298 responses: 299 200: 300 description: 'OK' 301 content: 302 application/json: 303 schema: { } 304 application/xml: 305 schema: { } 306 text/plain: 307 schema: 308 type: string 309 application/octet-stream: 310 schema: 311 type: string 312 format: binary 313 security: 314 - bearerAuth: [ ] 315 '/v2/datastore/objects_latest': 316 post: 317 tags: 318 - PublishSubscribe 319 requestBody: 320 required: true 321 content: 322 application/json: 323 schema: 324 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/Ids" 325 operationId: getDataStoreMultiObjectDataLatest 326 responses: 327 200: 328 description: 'OK' 329 content: 330 application/json: 331 schema: 332 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/MultipleDataStoreDataLatest" 333 security: 334 - bearerAuth: [ ] 335 '/v2/datastore/channels/{channel_id}/sessions': 336 get: 337 tags: 338 - PublishSubscribe 339 parameters: 340 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 341 - $ref: "../components/parameters.yml#/components/parameters/timestamp" 342 - $ref: "../components/parameters.yml#/components/parameters/timestamp_range" 343 - $ref: "../components/parameters.yml#/components/parameters/location_range" 344 - $ref: "../components/parameters.yml#/components/parameters/location" 345 - $ref: "../components/parameters.yml#/components/parameters/ascending" 346 - $ref: "../components/parameters.yml#/components/parameters/offset" 347 - $ref: "../components/parameters.yml#/components/parameters/limit" 348 operationId: getDataStoreSessions 349 responses: 350 200: 351 description: 'OK' 352 content: 353 application/json: 354 schema: 355 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/MultipleSession" 356 security: 357 - bearerAuth: [ ] 358 '/v2/datastore/channels/{channel_id}/sessions/{session_id}': 359 get: 360 tags: 361 - PublishSubscribe 362 parameters: 363 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 364 - $ref: "../components/parameters.yml#/components/parameters/session_id_required" 365 operationId: getDataStoreSession 366 responses: 367 200: 368 description: 'OK' 369 content: 370 application/json: 371 schema: 372 $ref: "../components/publishsublish-component.openapi.yml#/components/schemas/SingleSession" 373 security: 374 - bearerAuth: [ ] 375 delete: 376 tags: 377 - PublishSubscribe 378 parameters: 379 - $ref: "../components/parameters.yml#/components/parameters/channel_id_required" 380 - $ref: "../components/parameters.yml#/components/parameters/session_id_required" 381 operationId: deleteDataStoreSession 382 responses: 383 200: 384 description: 'OK' 385 security: 386 - bearerAuth: [ ] 387 388 components: 389 securitySchemes: 390 bearerAuth: 391 type: http 392 scheme: bearer 393 bearerFormat: JWT