github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/openapis/filestorage.openapi.yml (about) 1 openapi: "3.0.3" 2 info: 3 version: 1.0.0 4 title: Cios FileStorage Openapi 5 6 paths: 7 # File Storage 8 '/v2/file_storage/buckets': 9 get: 10 tags: 11 - fileStorage 12 description: file_storage.read 13 operationId: getBuckets 14 parameters: 15 - $ref: "../components/parameters.yml#/components/parameters/limit" 16 - $ref: "../components/parameters.yml#/components/parameters/offset" 17 - $ref: "../components/parameters.yml#/components/parameters/order" 18 - $ref: "../components/parameters.yml#/components/parameters/order_by" 19 - $ref: "../components/parameters.yml#/components/parameters/resource_owner_id" 20 - $ref: "../components/parameters.yml#/components/parameters/name_query" 21 responses: 22 200: 23 description: 'OK' 24 content: 25 application/json: 26 schema: 27 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/MultipleBucket" 28 400: 29 $ref: "../components/responses.yml#/components/responses/invalid_request" 30 401: 31 $ref: "../components/responses.yml#/components/responses/invalid_token" 32 403: 33 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 34 500: 35 $ref: "../components/responses.yml#/components/responses/internal_server_error" 36 503: 37 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 38 security: 39 - bearerAuth: [] 40 post: 41 tags: 42 - fileStorage 43 description: file_storage.write 44 operationId: createBucket 45 requestBody: 46 required: true 47 content: 48 application/json: 49 schema: 50 $ref: '../components/filestorage-component.openapi.yml#/components/schemas/BucketRequest' 51 52 responses: 53 200: 54 description: 'OK' 55 content: 56 application/json: 57 schema: 58 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/SingleBucket" 59 400: 60 $ref: "../components/responses.yml#/components/responses/invalid_request" 61 401: 62 $ref: "../components/responses.yml#/components/responses/invalid_token" 63 403: 64 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 65 409: 66 $ref: "../components/responses.yml#/components/responses/conflict_request" 67 500: 68 $ref: "../components/responses.yml#/components/responses/internal_server_error" 69 503: 70 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 71 security: 72 - bearerAuth: [] 73 '/v2/file_storage/buckets/{bucket_id}': 74 get: 75 tags: 76 - fileStorage 77 description: file_storage.read 78 parameters: 79 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 80 operationId: getBucket 81 responses: 82 200: 83 description: 'OK' 84 content: 85 application/json: 86 schema: 87 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/SingleBucket" 88 400: 89 $ref: "../components/responses.yml#/components/responses/invalid_request" 90 401: 91 $ref: "../components/responses.yml#/components/responses/invalid_token" 92 403: 93 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 94 404: 95 $ref: "../components/responses.yml#/components/responses/resource_not_found" 96 409: 97 $ref: "../components/responses.yml#/components/responses/conflict_request" 98 500: 99 $ref: "../components/responses.yml#/components/responses/internal_server_error" 100 503: 101 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 102 security: 103 - bearerAuth: [] 104 delete: 105 tags: 106 - fileStorage 107 description: file_storage.write 108 parameters: 109 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 110 operationId: deleteBucket 111 responses: 112 200: 113 description: 'OK' 114 400: 115 $ref: "../components/responses.yml#/components/responses/invalid_request" 116 401: 117 $ref: "../components/responses.yml#/components/responses/invalid_token" 118 403: 119 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 120 404: 121 $ref: "../components/responses.yml#/components/responses/resource_not_found" 122 409: 123 $ref: "../components/responses.yml#/components/responses/conflict_request" 124 500: 125 $ref: "../components/responses.yml#/components/responses/internal_server_error" 126 503: 127 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 128 security: 129 - bearerAuth: [] 130 patch: 131 tags: 132 - fileStorage 133 parameters: 134 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 135 operationId: updateBucket 136 requestBody: 137 required: true 138 content: 139 application/json: 140 schema: 141 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/BucketName" 142 responses: 143 200: 144 description: 'OK' 145 400: 146 $ref: "../components/responses.yml#/components/responses/invalid_request" 147 401: 148 $ref: "../components/responses.yml#/components/responses/invalid_token" 149 403: 150 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 151 404: 152 $ref: "../components/responses.yml#/components/responses/resource_not_found" 153 409: 154 $ref: "../components/responses.yml#/components/responses/conflict_request" 155 500: 156 $ref: "../components/responses.yml#/components/responses/internal_server_error" 157 503: 158 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 159 security: 160 - bearerAuth: [] 161 '/v2/file_storage/buckets/{bucket_id}/create_directory': 162 post: 163 tags: 164 - fileStorage 165 description: file_storage.write 166 operationId: createDirectory 167 parameters: 168 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 169 requestBody: 170 required: true 171 content: 172 application/json: 173 schema: 174 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/NodeRequest" 175 176 responses: 177 200: 178 description: '' 179 content: 180 application/json: 181 schema: 182 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/SingleNode" 183 400: 184 $ref: "../components/responses.yml#/components/responses/invalid_request" 185 401: 186 $ref: "../components/responses.yml#/components/responses/invalid_token" 187 403: 188 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 189 404: 190 $ref: "../components/responses.yml#/components/responses/resource_not_found" 191 409: 192 $ref: "../components/responses.yml#/components/responses/conflict_request" 193 500: 194 $ref: "../components/responses.yml#/components/responses/internal_server_error" 195 503: 196 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 197 security: 198 - bearerAuth: [] 199 '/v2/file_storage/buckets/{bucket_id}/nodes': 200 get: 201 tags: 202 - fileStorage 203 description: file_storage.read 204 operationId: getNodes 205 parameters: 206 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 207 - $ref: "../components/parameters.yml#/components/parameters/parent_node_id" 208 - $ref: "../components/parameters.yml#/components/parameters/recursive" 209 - $ref: "../components/parameters.yml#/components/parameters/name_query" 210 - $ref: "../components/parameters.yml#/components/parameters/key_query" 211 - $ref: "../components/parameters.yml#/components/parameters/is_directory" 212 - $ref: "../components/parameters.yml#/components/parameters/limit" 213 - $ref: "../components/parameters.yml#/components/parameters/offset" 214 - $ref: "../components/parameters.yml#/components/parameters/node_order_by" 215 - $ref: "../components/parameters.yml#/components/parameters/order" 216 responses: 217 200: 218 description: '' 219 content: 220 application/json: 221 schema: 222 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/MultipleNode" 223 400: 224 $ref: "../components/responses.yml#/components/responses/invalid_request" 225 401: 226 $ref: "../components/responses.yml#/components/responses/invalid_token" 227 403: 228 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 229 404: 230 $ref: "../components/responses.yml#/components/responses/resource_not_found" 231 409: 232 $ref: "../components/responses.yml#/components/responses/conflict_request" 233 500: 234 $ref: "../components/responses.yml#/components/responses/internal_server_error" 235 503: 236 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 237 238 security: 239 - bearerAuth: [] 240 '/v2/file_storage/buckets/{bucket_id}/nodes/{node_id}': 241 get: 242 tags: 243 - fileStorage 244 operationId: getNode 245 description: file_storage.read 246 parameters: 247 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 248 - $ref: "../components/parameters.yml#/components/parameters/node_id_required" 249 - $ref: "../components/parameters.yml#/components/parameters/directory_size" 250 responses: 251 200: 252 description: '' 253 content: 254 application/json: 255 schema: 256 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/SingleNode" 257 400: 258 $ref: "../components/responses.yml#/components/responses/invalid_request" 259 401: 260 $ref: "../components/responses.yml#/components/responses/invalid_token" 261 403: 262 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 263 404: 264 $ref: "../components/responses.yml#/components/responses/resource_not_found" 265 500: 266 $ref: "../components/responses.yml#/components/responses/internal_server_error" 267 503: 268 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 269 security: 270 - bearerAuth: [] 271 delete: 272 tags: 273 - fileStorage 274 operationId: deleteNode 275 description: file_storage.write 276 parameters: 277 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 278 - $ref: "../components/parameters.yml#/components/parameters/node_id_required" 279 - $ref: "../components/parameters.yml#/components/parameters/directory_size" 280 responses: 281 200: 282 description: 'OK' 283 400: 284 $ref: "../components/responses.yml#/components/responses/invalid_request" 285 401: 286 $ref: "../components/responses.yml#/components/responses/invalid_token" 287 403: 288 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 289 404: 290 $ref: "../components/responses.yml#/components/responses/resource_not_found" 291 500: 292 $ref: "../components/responses.yml#/components/responses/internal_server_error" 293 503: 294 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 295 296 security: 297 - bearerAuth: [] 298 '/v2/file_storage/buckets/{bucket_id}/nodes/{node_id}/rename': 299 post: 300 tags: 301 - fileStorage 302 operationId: renameNode 303 parameters: 304 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 305 - $ref: "../components/parameters.yml#/components/parameters/node_id_required" 306 requestBody: 307 required: true 308 content: 309 application/json: 310 schema: 311 $ref: '../components/filestorage-component.openapi.yml#/components/schemas/NodeName' 312 responses: 313 200: 314 description: '' 315 content: 316 application/json: 317 schema: 318 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/SingleNode" 319 security: 320 - bearerAuth: [] 321 '/v2/file_storage/buckets/{bucket_id}/nodes/{node_id}/move': 322 post: 323 tags: 324 - fileStorage 325 operationId: moveNode 326 parameters: 327 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 328 - $ref: "../components/parameters.yml#/components/parameters/node_id_required" 329 requestBody: 330 required: true 331 content: 332 application/json: 333 schema: 334 $ref: '../components/filestorage-component.openapi.yml#/components/schemas/BucketEditBody' 335 responses: 336 200: 337 description: '' 338 content: 339 application/json: 340 schema: 341 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/SingleNode" 342 security: 343 - bearerAuth: [] 344 '/v2/file_storage/buckets/{bucket_id}/nodes/{node_id}/copy': 345 post: 346 tags: 347 - fileStorage 348 operationId: copyNode 349 parameters: 350 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 351 - $ref: "../components/parameters.yml#/components/parameters/node_id_required" 352 requestBody: 353 required: true 354 content: 355 application/json: 356 schema: 357 $ref: '../components/filestorage-component.openapi.yml#/components/schemas/BucketEditBody' 358 responses: 359 200: 360 description: '' 361 content: 362 application/json: 363 schema: 364 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/SingleNode" 365 security: 366 - bearerAuth: [] 367 '/v2/file_storage/buckets/{bucket_id}/upload': 368 put: 369 tags: 370 - fileStorage 371 description: file_storage.upload 372 parameters: 373 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 374 - $ref: "../components/parameters.yml#/components/parameters/checksum" 375 - $ref: "../components/parameters.yml#/components/parameters/name_query" 376 - $ref: "../components/parameters.yml#/components/parameters/node_id_query" 377 - $ref: "../components/parameters.yml#/components/parameters/key_query" 378 - $ref: "../components/parameters.yml#/components/parameters/parent_node_id" 379 - $ref: "../components/parameters.yml#/components/parameters/parent_key" 380 - $ref: "../components/parameters.yml#/components/parameters/force" 381 operationId: uploadFile 382 requestBody: 383 required: true 384 content: 385 application/octet-stream: 386 schema: 387 type: string 388 format: byte 389 390 responses: 391 200: 392 description: 'OK' 393 content: 394 application/json: 395 schema: 396 $ref: "../components/filestorage-component.openapi.yml#/components/schemas/SingleBucket" 397 400: 398 $ref: "../components/responses.yml#/components/responses/invalid_request" 399 401: 400 $ref: "../components/responses.yml#/components/responses/invalid_token" 401 403: 402 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 403 404: 404 $ref: "../components/responses.yml#/components/responses/resource_not_found" 405 409: 406 $ref: "../components/responses.yml#/components/responses/conflict_request" 407 500: 408 $ref: "../components/responses.yml#/components/responses/internal_server_error" 409 503: 410 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 411 security: 412 - bearerAuth: [] 413 '/v2/file_storage/buckets/{bucket_id}/download': 414 get: 415 tags: 416 - fileStorage 417 description: file_storage.download 418 parameters: 419 - $ref: "../components/parameters.yml#/components/parameters/bucket_id_required" 420 - $ref: "../components/parameters.yml#/components/parameters/node_id_query" 421 - $ref: "../components/parameters.yml#/components/parameters/key_query" 422 operationId: downloadFile 423 responses: 424 200: 425 description: 'OK' 426 content: 427 /*: 428 schema: 429 type: string 430 format: byte 431 400: 432 $ref: "../components/responses.yml#/components/responses/invalid_request" 433 401: 434 $ref: "../components/responses.yml#/components/responses/invalid_token" 435 403: 436 $ref: "../components/responses.yml#/components/responses/insufficient_scopes" 437 404: 438 $ref: "../components/responses.yml#/components/responses/resource_not_found" 439 500: 440 $ref: "../components/responses.yml#/components/responses/internal_server_error" 441 503: 442 $ref: "../components/responses.yml#/components/responses/server_temporarily_unavailable" 443 security: 444 - bearerAuth: [] 445 446 components: 447 securitySchemes: 448 bearerAuth: 449 type: http 450 scheme: bearer 451 bearerFormat: JWT