| TamasBakai | 67eccc9 | 2019-04-26 10:58:08 +0000 | [diff] [blame^] | 1 | { |
| 2 | "swagger": "2.0", |
| 3 | "info": { |
| 4 | "description": "This page lists all the rest apis for DATAFILE app server.", |
| 5 | "version": "1.0", |
| 6 | "title": "DATAFILE app server" |
| 7 | }, |
| 8 | "host": "localhost:8100", |
| 9 | "basePath": "/", |
| 10 | "tags": [ |
| 11 | { |
| 12 | "name": "heartbeat-controller", |
| 13 | "description": "Heartbeat Controller" |
| 14 | }, |
| 15 | { |
| 16 | "name": "operation-handler", |
| 17 | "description": "Operation Handler" |
| 18 | }, |
| 19 | { |
| 20 | "name": "schedule-controller", |
| 21 | "description": "Schedule Controller" |
| 22 | }, |
| 23 | { |
| 24 | "name": "web-mvc-links-handler", |
| 25 | "description": "Web Mvc Links Handler" |
| 26 | } |
| 27 | ], |
| 28 | "paths": { |
| 29 | "/actuator": { |
| 30 | "get": { |
| 31 | "tags": [ |
| 32 | "web-mvc-links-handler" |
| 33 | ], |
| 34 | "summary": "links", |
| 35 | "operationId": "linksUsingGET", |
| 36 | "produces": [ |
| 37 | "application/json", |
| 38 | "application/vnd.spring-boot.actuator.v2+json" |
| 39 | ], |
| 40 | "responses": { |
| 41 | "200": { |
| 42 | "description": "OK", |
| 43 | "schema": { |
| 44 | "type": "object", |
| 45 | "additionalProperties": { |
| 46 | "type": "object", |
| 47 | "additionalProperties": { |
| 48 | "$ref": "#/definitions/Link" |
| 49 | } |
| 50 | } |
| 51 | } |
| 52 | }, |
| 53 | "401": { |
| 54 | "description": "Unauthorized" |
| 55 | }, |
| 56 | "403": { |
| 57 | "description": "Forbidden" |
| 58 | }, |
| 59 | "404": { |
| 60 | "description": "Not Found" |
| 61 | } |
| 62 | } |
| 63 | } |
| 64 | }, |
| 65 | "/actuator/health": { |
| 66 | "get": { |
| 67 | "tags": [ |
| 68 | "operation-handler" |
| 69 | ], |
| 70 | "summary": "handle", |
| 71 | "operationId": "handleUsingGET_2", |
| 72 | "produces": [ |
| 73 | "application/json", |
| 74 | "application/vnd.spring-boot.actuator.v2+json" |
| 75 | ], |
| 76 | "parameters": [ |
| 77 | { |
| 78 | "in": "body", |
| 79 | "name": "body", |
| 80 | "description": "body", |
| 81 | "required": false, |
| 82 | "schema": { |
| 83 | "type": "object", |
| 84 | "additionalProperties": { |
| 85 | "type": "string" |
| 86 | } |
| 87 | } |
| 88 | } |
| 89 | ], |
| 90 | "responses": { |
| 91 | "200": { |
| 92 | "description": "OK", |
| 93 | "schema": { |
| 94 | "type": "object" |
| 95 | } |
| 96 | }, |
| 97 | "401": { |
| 98 | "description": "Unauthorized" |
| 99 | }, |
| 100 | "403": { |
| 101 | "description": "Forbidden" |
| 102 | }, |
| 103 | "404": { |
| 104 | "description": "Not Found" |
| 105 | } |
| 106 | } |
| 107 | } |
| 108 | }, |
| 109 | "/actuator/health/{component}": { |
| 110 | "get": { |
| 111 | "tags": [ |
| 112 | "operation-handler" |
| 113 | ], |
| 114 | "summary": "handle", |
| 115 | "operationId": "handleUsingGET_1", |
| 116 | "produces": [ |
| 117 | "application/json", |
| 118 | "application/vnd.spring-boot.actuator.v2+json" |
| 119 | ], |
| 120 | "parameters": [ |
| 121 | { |
| 122 | "in": "body", |
| 123 | "name": "body", |
| 124 | "description": "body", |
| 125 | "required": false, |
| 126 | "schema": { |
| 127 | "type": "object", |
| 128 | "additionalProperties": { |
| 129 | "type": "string" |
| 130 | } |
| 131 | } |
| 132 | } |
| 133 | ], |
| 134 | "responses": { |
| 135 | "200": { |
| 136 | "description": "OK", |
| 137 | "schema": { |
| 138 | "type": "object" |
| 139 | } |
| 140 | }, |
| 141 | "401": { |
| 142 | "description": "Unauthorized" |
| 143 | }, |
| 144 | "403": { |
| 145 | "description": "Forbidden" |
| 146 | }, |
| 147 | "404": { |
| 148 | "description": "Not Found" |
| 149 | } |
| 150 | } |
| 151 | } |
| 152 | }, |
| 153 | "/actuator/health/{component}/{instance}": { |
| 154 | "get": { |
| 155 | "tags": [ |
| 156 | "operation-handler" |
| 157 | ], |
| 158 | "summary": "handle", |
| 159 | "operationId": "handleUsingGET", |
| 160 | "produces": [ |
| 161 | "application/json", |
| 162 | "application/vnd.spring-boot.actuator.v2+json" |
| 163 | ], |
| 164 | "parameters": [ |
| 165 | { |
| 166 | "in": "body", |
| 167 | "name": "body", |
| 168 | "description": "body", |
| 169 | "required": false, |
| 170 | "schema": { |
| 171 | "type": "object", |
| 172 | "additionalProperties": { |
| 173 | "type": "string" |
| 174 | } |
| 175 | } |
| 176 | } |
| 177 | ], |
| 178 | "responses": { |
| 179 | "200": { |
| 180 | "description": "OK", |
| 181 | "schema": { |
| 182 | "type": "object" |
| 183 | } |
| 184 | }, |
| 185 | "401": { |
| 186 | "description": "Unauthorized" |
| 187 | }, |
| 188 | "403": { |
| 189 | "description": "Forbidden" |
| 190 | }, |
| 191 | "404": { |
| 192 | "description": "Not Found" |
| 193 | } |
| 194 | } |
| 195 | } |
| 196 | }, |
| 197 | "/actuator/info": { |
| 198 | "get": { |
| 199 | "tags": [ |
| 200 | "operation-handler" |
| 201 | ], |
| 202 | "summary": "handle", |
| 203 | "operationId": "handleUsingGET_3", |
| 204 | "produces": [ |
| 205 | "application/json", |
| 206 | "application/vnd.spring-boot.actuator.v2+json" |
| 207 | ], |
| 208 | "parameters": [ |
| 209 | { |
| 210 | "in": "body", |
| 211 | "name": "body", |
| 212 | "description": "body", |
| 213 | "required": false, |
| 214 | "schema": { |
| 215 | "type": "object", |
| 216 | "additionalProperties": { |
| 217 | "type": "string" |
| 218 | } |
| 219 | } |
| 220 | } |
| 221 | ], |
| 222 | "responses": { |
| 223 | "200": { |
| 224 | "description": "OK", |
| 225 | "schema": { |
| 226 | "type": "object" |
| 227 | } |
| 228 | }, |
| 229 | "401": { |
| 230 | "description": "Unauthorized" |
| 231 | }, |
| 232 | "403": { |
| 233 | "description": "Forbidden" |
| 234 | }, |
| 235 | "404": { |
| 236 | "description": "Not Found" |
| 237 | } |
| 238 | } |
| 239 | } |
| 240 | }, |
| 241 | "/actuator/logfile": { |
| 242 | "get": { |
| 243 | "tags": [ |
| 244 | "operation-handler" |
| 245 | ], |
| 246 | "summary": "handle", |
| 247 | "operationId": "handleUsingGET_4", |
| 248 | "produces": [ |
| 249 | "application/octet-stream" |
| 250 | ], |
| 251 | "parameters": [ |
| 252 | { |
| 253 | "in": "body", |
| 254 | "name": "body", |
| 255 | "description": "body", |
| 256 | "required": false, |
| 257 | "schema": { |
| 258 | "type": "object", |
| 259 | "additionalProperties": { |
| 260 | "type": "string" |
| 261 | } |
| 262 | } |
| 263 | } |
| 264 | ], |
| 265 | "responses": { |
| 266 | "200": { |
| 267 | "description": "OK", |
| 268 | "schema": { |
| 269 | "type": "object" |
| 270 | } |
| 271 | }, |
| 272 | "401": { |
| 273 | "description": "Unauthorized" |
| 274 | }, |
| 275 | "403": { |
| 276 | "description": "Forbidden" |
| 277 | }, |
| 278 | "404": { |
| 279 | "description": "Not Found" |
| 280 | } |
| 281 | } |
| 282 | } |
| 283 | }, |
| 284 | "/actuator/loggers": { |
| 285 | "get": { |
| 286 | "tags": [ |
| 287 | "operation-handler" |
| 288 | ], |
| 289 | "summary": "handle", |
| 290 | "operationId": "handleUsingGET_6", |
| 291 | "produces": [ |
| 292 | "application/json", |
| 293 | "application/vnd.spring-boot.actuator.v2+json" |
| 294 | ], |
| 295 | "parameters": [ |
| 296 | { |
| 297 | "in": "body", |
| 298 | "name": "body", |
| 299 | "description": "body", |
| 300 | "required": false, |
| 301 | "schema": { |
| 302 | "type": "object", |
| 303 | "additionalProperties": { |
| 304 | "type": "string" |
| 305 | } |
| 306 | } |
| 307 | } |
| 308 | ], |
| 309 | "responses": { |
| 310 | "200": { |
| 311 | "description": "OK", |
| 312 | "schema": { |
| 313 | "type": "object" |
| 314 | } |
| 315 | }, |
| 316 | "401": { |
| 317 | "description": "Unauthorized" |
| 318 | }, |
| 319 | "403": { |
| 320 | "description": "Forbidden" |
| 321 | }, |
| 322 | "404": { |
| 323 | "description": "Not Found" |
| 324 | } |
| 325 | } |
| 326 | } |
| 327 | }, |
| 328 | "/actuator/loggers/{name}": { |
| 329 | "get": { |
| 330 | "tags": [ |
| 331 | "operation-handler" |
| 332 | ], |
| 333 | "summary": "handle", |
| 334 | "operationId": "handleUsingGET_5", |
| 335 | "produces": [ |
| 336 | "application/json", |
| 337 | "application/vnd.spring-boot.actuator.v2+json" |
| 338 | ], |
| 339 | "parameters": [ |
| 340 | { |
| 341 | "in": "body", |
| 342 | "name": "body", |
| 343 | "description": "body", |
| 344 | "required": false, |
| 345 | "schema": { |
| 346 | "type": "object", |
| 347 | "additionalProperties": { |
| 348 | "type": "string" |
| 349 | } |
| 350 | } |
| 351 | } |
| 352 | ], |
| 353 | "responses": { |
| 354 | "200": { |
| 355 | "description": "OK", |
| 356 | "schema": { |
| 357 | "type": "object" |
| 358 | } |
| 359 | }, |
| 360 | "401": { |
| 361 | "description": "Unauthorized" |
| 362 | }, |
| 363 | "403": { |
| 364 | "description": "Forbidden" |
| 365 | }, |
| 366 | "404": { |
| 367 | "description": "Not Found" |
| 368 | } |
| 369 | } |
| 370 | }, |
| 371 | "post": { |
| 372 | "tags": [ |
| 373 | "operation-handler" |
| 374 | ], |
| 375 | "summary": "handle", |
| 376 | "operationId": "handleUsingPOST", |
| 377 | "consumes": [ |
| 378 | "application/json", |
| 379 | "application/vnd.spring-boot.actuator.v2+json" |
| 380 | ], |
| 381 | "produces": [ |
| 382 | "*/*" |
| 383 | ], |
| 384 | "parameters": [ |
| 385 | { |
| 386 | "in": "body", |
| 387 | "name": "body", |
| 388 | "description": "body", |
| 389 | "required": false, |
| 390 | "schema": { |
| 391 | "type": "object", |
| 392 | "additionalProperties": { |
| 393 | "type": "string" |
| 394 | } |
| 395 | } |
| 396 | } |
| 397 | ], |
| 398 | "responses": { |
| 399 | "200": { |
| 400 | "description": "OK", |
| 401 | "schema": { |
| 402 | "type": "object" |
| 403 | } |
| 404 | }, |
| 405 | "201": { |
| 406 | "description": "Created" |
| 407 | }, |
| 408 | "401": { |
| 409 | "description": "Unauthorized" |
| 410 | }, |
| 411 | "403": { |
| 412 | "description": "Forbidden" |
| 413 | }, |
| 414 | "404": { |
| 415 | "description": "Not Found" |
| 416 | } |
| 417 | } |
| 418 | } |
| 419 | }, |
| 420 | "/actuator/metrics": { |
| 421 | "get": { |
| 422 | "tags": [ |
| 423 | "operation-handler" |
| 424 | ], |
| 425 | "summary": "handle", |
| 426 | "operationId": "handleUsingGET_8", |
| 427 | "produces": [ |
| 428 | "application/json", |
| 429 | "application/vnd.spring-boot.actuator.v2+json" |
| 430 | ], |
| 431 | "parameters": [ |
| 432 | { |
| 433 | "in": "body", |
| 434 | "name": "body", |
| 435 | "description": "body", |
| 436 | "required": false, |
| 437 | "schema": { |
| 438 | "type": "object", |
| 439 | "additionalProperties": { |
| 440 | "type": "string" |
| 441 | } |
| 442 | } |
| 443 | } |
| 444 | ], |
| 445 | "responses": { |
| 446 | "200": { |
| 447 | "description": "OK", |
| 448 | "schema": { |
| 449 | "type": "object" |
| 450 | } |
| 451 | }, |
| 452 | "401": { |
| 453 | "description": "Unauthorized" |
| 454 | }, |
| 455 | "403": { |
| 456 | "description": "Forbidden" |
| 457 | }, |
| 458 | "404": { |
| 459 | "description": "Not Found" |
| 460 | } |
| 461 | } |
| 462 | } |
| 463 | }, |
| 464 | "/actuator/metrics/{requiredMetricName}": { |
| 465 | "get": { |
| 466 | "tags": [ |
| 467 | "operation-handler" |
| 468 | ], |
| 469 | "summary": "handle", |
| 470 | "operationId": "handleUsingGET_7", |
| 471 | "produces": [ |
| 472 | "application/json", |
| 473 | "application/vnd.spring-boot.actuator.v2+json" |
| 474 | ], |
| 475 | "parameters": [ |
| 476 | { |
| 477 | "in": "body", |
| 478 | "name": "body", |
| 479 | "description": "body", |
| 480 | "required": false, |
| 481 | "schema": { |
| 482 | "type": "object", |
| 483 | "additionalProperties": { |
| 484 | "type": "string" |
| 485 | } |
| 486 | } |
| 487 | } |
| 488 | ], |
| 489 | "responses": { |
| 490 | "200": { |
| 491 | "description": "OK", |
| 492 | "schema": { |
| 493 | "type": "object" |
| 494 | } |
| 495 | }, |
| 496 | "401": { |
| 497 | "description": "Unauthorized" |
| 498 | }, |
| 499 | "403": { |
| 500 | "description": "Forbidden" |
| 501 | }, |
| 502 | "404": { |
| 503 | "description": "Not Found" |
| 504 | } |
| 505 | } |
| 506 | } |
| 507 | }, |
| 508 | "/heartbeat": { |
| 509 | "get": { |
| 510 | "tags": [ |
| 511 | "heartbeat-controller" |
| 512 | ], |
| 513 | "summary": "Returns liveness of DATAFILE service", |
| 514 | "operationId": "heartbeatUsingGET", |
| 515 | "produces": [ |
| 516 | "*/*" |
| 517 | ], |
| 518 | "responses": { |
| 519 | "200": { |
| 520 | "description": "DATAFILE service is living", |
| 521 | "schema": { |
| 522 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 523 | } |
| 524 | }, |
| 525 | "401": { |
| 526 | "description": "You are not authorized to view the resource" |
| 527 | }, |
| 528 | "403": { |
| 529 | "description": "Accessing the resource you were trying to reach is forbidden" |
| 530 | }, |
| 531 | "404": { |
| 532 | "description": "The resource you were trying to reach is not found" |
| 533 | } |
| 534 | } |
| 535 | } |
| 536 | }, |
| 537 | "/start": { |
| 538 | "get": { |
| 539 | "tags": [ |
| 540 | "schedule-controller" |
| 541 | ], |
| 542 | "summary": "Start scheduling worker request", |
| 543 | "operationId": "startTasksUsingGET", |
| 544 | "produces": [ |
| 545 | "*/*" |
| 546 | ], |
| 547 | "responses": { |
| 548 | "200": { |
| 549 | "description": "OK", |
| 550 | "schema": { |
| 551 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 552 | } |
| 553 | }, |
| 554 | "401": { |
| 555 | "description": "Unauthorized" |
| 556 | }, |
| 557 | "403": { |
| 558 | "description": "Forbidden" |
| 559 | }, |
| 560 | "404": { |
| 561 | "description": "Not Found" |
| 562 | } |
| 563 | } |
| 564 | } |
| 565 | }, |
| 566 | "/stopDatafile": { |
| 567 | "get": { |
| 568 | "tags": [ |
| 569 | "schedule-controller" |
| 570 | ], |
| 571 | "summary": "Receiving stop scheduling worker request", |
| 572 | "operationId": "stopTaskUsingGET", |
| 573 | "produces": [ |
| 574 | "*/*" |
| 575 | ], |
| 576 | "responses": { |
| 577 | "200": { |
| 578 | "description": "OK", |
| 579 | "schema": { |
| 580 | "$ref": "#/definitions/Mono«ResponseEntity«string»»" |
| 581 | } |
| 582 | }, |
| 583 | "401": { |
| 584 | "description": "Unauthorized" |
| 585 | }, |
| 586 | "403": { |
| 587 | "description": "Forbidden" |
| 588 | }, |
| 589 | "404": { |
| 590 | "description": "Not Found" |
| 591 | } |
| 592 | } |
| 593 | } |
| 594 | } |
| 595 | }, |
| 596 | "definitions": { |
| 597 | "Link": { |
| 598 | "type": "object", |
| 599 | "properties": { |
| 600 | "href": { |
| 601 | "type": "string" |
| 602 | }, |
| 603 | "templated": { |
| 604 | "type": "boolean" |
| 605 | } |
| 606 | }, |
| 607 | "title": "Link" |
| 608 | }, |
| 609 | "Map«string,Link»": { |
| 610 | "type": "object", |
| 611 | "title": "Map«string,Link»", |
| 612 | "additionalProperties": { |
| 613 | "$ref": "#/definitions/Link" |
| 614 | } |
| 615 | }, |
| 616 | "Mono«ResponseEntity«string»»": { |
| 617 | "type": "object", |
| 618 | "title": "Mono«ResponseEntity«string»»" |
| 619 | } |
| 620 | } |
| 621 | } |