github.com/openshift-online/ocm-sdk-go@v0.1.473/openapi/web_rca/v1/openapi.json (about) 1 { 2 "openapi": "3.0.0", 3 "info": { 4 "version": "v1", 5 "title": "web_rca", 6 "license": { 7 "name": "Apache 2.0", 8 "url": "http://www.apache.org/licenses/LICENSE-2.0" 9 }, 10 "contact": { 11 "name": "OCM Feedback", 12 "email": "ocm-feedback@redhat.com" 13 } 14 }, 15 "servers": [ 16 { 17 "description": "Production", 18 "url": "https://api.openshift.com" 19 }, 20 { 21 "description": "Stage", 22 "url": "https://api.stage.openshift.com" 23 } 24 ], 25 "paths": { 26 "/api/web_rca/v1": { 27 "get": { 28 "description": "Retrieves the version metadata.", 29 "responses": { 30 "200": { 31 "description": "Success.", 32 "content": { 33 "application/json": { 34 "schema": { 35 "$ref": "#/components/schemas/Metadata" 36 } 37 } 38 } 39 }, 40 "default": { 41 "description": "Error.", 42 "content": { 43 "application/json": { 44 "schema": { 45 "$ref": "#/components/schemas/Error" 46 } 47 } 48 } 49 } 50 } 51 } 52 }, 53 "/api/web_rca/v1/errors": { 54 "get": { 55 "description": "Retrieves the list of errors.", 56 "parameters": [ 57 { 58 "name": "page", 59 "in": "query", 60 "schema": { 61 "type": "integer", 62 "format": "int32" 63 } 64 }, 65 { 66 "name": "size", 67 "in": "query", 68 "schema": { 69 "type": "integer", 70 "format": "int32" 71 } 72 } 73 ], 74 "responses": { 75 "200": { 76 "description": "Success.", 77 "content": { 78 "application/json": { 79 "schema": { 80 "type": "object", 81 "properties": { 82 "items": { 83 "type": "array", 84 "items": { 85 "$ref": "#/components/schemas/Error" 86 } 87 }, 88 "page": { 89 "type": "integer", 90 "format": "int32" 91 }, 92 "size": { 93 "type": "integer", 94 "format": "int32" 95 }, 96 "total": { 97 "type": "integer", 98 "format": "int32" 99 } 100 } 101 } 102 } 103 } 104 }, 105 "default": { 106 "description": "Error.", 107 "content": { 108 "application/json": { 109 "schema": { 110 "$ref": "#/components/schemas/Error" 111 } 112 } 113 } 114 } 115 } 116 } 117 }, 118 "/api/web_rca/v1/errors/{error_id}": { 119 "get": { 120 "parameters": [ 121 { 122 "name": "error_id", 123 "in": "path", 124 "schema": { 125 "type": "string" 126 }, 127 "required": true 128 } 129 ], 130 "responses": { 131 "200": { 132 "description": "Success.", 133 "content": { 134 "application/json": { 135 "schema": { 136 "$ref": "#/components/schemas/Error" 137 } 138 } 139 } 140 }, 141 "default": { 142 "description": "Error.", 143 "content": { 144 "application/json": { 145 "schema": { 146 "$ref": "#/components/schemas/Error" 147 } 148 } 149 } 150 } 151 } 152 } 153 }, 154 "/api/web_rca/v1/incidents": { 155 "post": { 156 "requestBody": { 157 "content": { 158 "application/json": { 159 "schema": { 160 "$ref": "#/components/schemas/Incident" 161 } 162 } 163 } 164 }, 165 "responses": { 166 "201": { 167 "description": "Success.", 168 "content": { 169 "application/json": { 170 "schema": { 171 "$ref": "#/components/schemas/Incident" 172 } 173 } 174 } 175 }, 176 "default": { 177 "description": "Error.", 178 "content": { 179 "application/json": { 180 "schema": { 181 "$ref": "#/components/schemas/Error" 182 } 183 } 184 } 185 } 186 } 187 }, 188 "get": { 189 "description": "Retrieves the list of incidents.", 190 "parameters": [ 191 { 192 "name": "creator_id", 193 "in": "query", 194 "schema": { 195 "type": "string" 196 } 197 }, 198 { 199 "name": "incident_commander_id", 200 "in": "query", 201 "schema": { 202 "type": "string" 203 } 204 }, 205 { 206 "name": "incident_name", 207 "in": "query", 208 "schema": { 209 "type": "string" 210 } 211 }, 212 { 213 "name": "mine", 214 "in": "query", 215 "schema": { 216 "type": "boolean" 217 } 218 }, 219 { 220 "name": "on_call_id", 221 "in": "query", 222 "schema": { 223 "type": "string" 224 } 225 }, 226 { 227 "name": "order_by", 228 "in": "query", 229 "schema": { 230 "type": "string" 231 } 232 }, 233 { 234 "name": "page", 235 "in": "query", 236 "schema": { 237 "type": "integer", 238 "format": "int32" 239 } 240 }, 241 { 242 "name": "participant_id", 243 "in": "query", 244 "schema": { 245 "type": "string" 246 } 247 }, 248 { 249 "name": "product_id", 250 "in": "query", 251 "schema": { 252 "type": "string" 253 } 254 }, 255 { 256 "name": "public_id", 257 "in": "query", 258 "schema": { 259 "type": "string" 260 } 261 }, 262 { 263 "name": "responsible_manager_id", 264 "in": "query", 265 "schema": { 266 "type": "string" 267 } 268 }, 269 { 270 "name": "size", 271 "in": "query", 272 "schema": { 273 "type": "integer", 274 "format": "int32" 275 } 276 }, 277 { 278 "name": "status", 279 "in": "query", 280 "schema": { 281 "type": "string" 282 } 283 } 284 ], 285 "responses": { 286 "200": { 287 "description": "Success.", 288 "content": { 289 "application/json": { 290 "schema": { 291 "type": "object", 292 "properties": { 293 "items": { 294 "type": "array", 295 "items": { 296 "$ref": "#/components/schemas/Incident" 297 } 298 }, 299 "page": { 300 "type": "integer", 301 "format": "int32" 302 }, 303 "size": { 304 "type": "integer", 305 "format": "int32" 306 }, 307 "total": { 308 "type": "integer", 309 "format": "int32" 310 } 311 } 312 } 313 } 314 } 315 }, 316 "default": { 317 "description": "Error.", 318 "content": { 319 "application/json": { 320 "schema": { 321 "$ref": "#/components/schemas/Error" 322 } 323 } 324 } 325 } 326 } 327 } 328 }, 329 "/api/web_rca/v1/incidents/{incident_id}": { 330 "delete": { 331 "parameters": [ 332 { 333 "name": "incident_id", 334 "in": "path", 335 "schema": { 336 "type": "string" 337 }, 338 "required": true 339 } 340 ], 341 "responses": { 342 "204": { 343 "description": "Success." 344 }, 345 "default": { 346 "description": "Error.", 347 "content": { 348 "application/json": { 349 "schema": { 350 "$ref": "#/components/schemas/Error" 351 } 352 } 353 } 354 } 355 } 356 }, 357 "get": { 358 "parameters": [ 359 { 360 "name": "incident_id", 361 "in": "path", 362 "schema": { 363 "type": "string" 364 }, 365 "required": true 366 } 367 ], 368 "responses": { 369 "200": { 370 "description": "Success.", 371 "content": { 372 "application/json": { 373 "schema": { 374 "$ref": "#/components/schemas/Incident" 375 } 376 } 377 } 378 }, 379 "default": { 380 "description": "Error.", 381 "content": { 382 "application/json": { 383 "schema": { 384 "$ref": "#/components/schemas/Error" 385 } 386 } 387 } 388 } 389 } 390 }, 391 "patch": { 392 "parameters": [ 393 { 394 "name": "incident_id", 395 "in": "path", 396 "schema": { 397 "type": "string" 398 }, 399 "required": true 400 } 401 ], 402 "requestBody": { 403 "content": { 404 "application/json": { 405 "schema": { 406 "$ref": "#/components/schemas/Incident" 407 } 408 } 409 } 410 }, 411 "responses": { 412 "200": { 413 "description": "Success.", 414 "content": { 415 "application/json": { 416 "schema": { 417 "$ref": "#/components/schemas/Incident" 418 } 419 } 420 } 421 }, 422 "default": { 423 "description": "Error.", 424 "content": { 425 "application/json": { 426 "schema": { 427 "$ref": "#/components/schemas/Error" 428 } 429 } 430 } 431 } 432 } 433 } 434 }, 435 "/api/web_rca/v1/incidents/{incident_id}/events": { 436 "get": { 437 "description": "Retrieves the list of events", 438 "parameters": [ 439 { 440 "name": "incident_id", 441 "in": "path", 442 "schema": { 443 "type": "string" 444 }, 445 "required": true 446 }, 447 { 448 "name": "created_after", 449 "in": "query", 450 "schema": { 451 "type": "string", 452 "format": "date-time" 453 } 454 }, 455 { 456 "name": "created_before", 457 "in": "query", 458 "schema": { 459 "type": "string", 460 "format": "date-time" 461 } 462 }, 463 { 464 "name": "event_type", 465 "in": "query", 466 "schema": { 467 "type": "string" 468 } 469 }, 470 { 471 "name": "note", 472 "in": "query", 473 "schema": { 474 "type": "string" 475 } 476 }, 477 { 478 "name": "order_by", 479 "in": "query", 480 "schema": { 481 "type": "string" 482 } 483 }, 484 { 485 "name": "page", 486 "in": "query", 487 "schema": { 488 "type": "integer", 489 "format": "int32" 490 } 491 }, 492 { 493 "name": "show_system_events", 494 "in": "query", 495 "schema": { 496 "type": "boolean" 497 } 498 }, 499 { 500 "name": "size", 501 "in": "query", 502 "schema": { 503 "type": "integer", 504 "format": "int32" 505 } 506 } 507 ], 508 "responses": { 509 "200": { 510 "description": "Success.", 511 "content": { 512 "application/json": { 513 "schema": { 514 "type": "object", 515 "properties": { 516 "items": { 517 "type": "array", 518 "items": { 519 "$ref": "#/components/schemas/Event" 520 } 521 }, 522 "page": { 523 "type": "integer", 524 "format": "int32" 525 }, 526 "size": { 527 "type": "integer", 528 "format": "int32" 529 }, 530 "total": { 531 "type": "integer", 532 "format": "int32" 533 } 534 } 535 } 536 } 537 } 538 }, 539 "default": { 540 "description": "Error.", 541 "content": { 542 "application/json": { 543 "schema": { 544 "$ref": "#/components/schemas/Error" 545 } 546 } 547 } 548 } 549 } 550 } 551 }, 552 "/api/web_rca/v1/incidents/{incident_id}/events/{event_id}": { 553 "delete": { 554 "parameters": [ 555 { 556 "name": "incident_id", 557 "in": "path", 558 "schema": { 559 "type": "string" 560 }, 561 "required": true 562 }, 563 { 564 "name": "event_id", 565 "in": "path", 566 "schema": { 567 "type": "string" 568 }, 569 "required": true 570 } 571 ], 572 "responses": { 573 "204": { 574 "description": "Success." 575 }, 576 "default": { 577 "description": "Error.", 578 "content": { 579 "application/json": { 580 "schema": { 581 "$ref": "#/components/schemas/Error" 582 } 583 } 584 } 585 } 586 } 587 }, 588 "get": { 589 "parameters": [ 590 { 591 "name": "incident_id", 592 "in": "path", 593 "schema": { 594 "type": "string" 595 }, 596 "required": true 597 }, 598 { 599 "name": "event_id", 600 "in": "path", 601 "schema": { 602 "type": "string" 603 }, 604 "required": true 605 } 606 ], 607 "responses": { 608 "200": { 609 "description": "Success.", 610 "content": { 611 "application/json": { 612 "schema": { 613 "$ref": "#/components/schemas/Event" 614 } 615 } 616 } 617 }, 618 "default": { 619 "description": "Error.", 620 "content": { 621 "application/json": { 622 "schema": { 623 "$ref": "#/components/schemas/Error" 624 } 625 } 626 } 627 } 628 } 629 }, 630 "patch": { 631 "parameters": [ 632 { 633 "name": "incident_id", 634 "in": "path", 635 "schema": { 636 "type": "string" 637 }, 638 "required": true 639 }, 640 { 641 "name": "event_id", 642 "in": "path", 643 "schema": { 644 "type": "string" 645 }, 646 "required": true 647 } 648 ], 649 "requestBody": { 650 "content": { 651 "application/json": { 652 "schema": { 653 "$ref": "#/components/schemas/Event" 654 } 655 } 656 } 657 }, 658 "responses": { 659 "200": { 660 "description": "Success.", 661 "content": { 662 "application/json": { 663 "schema": { 664 "$ref": "#/components/schemas/Event" 665 } 666 } 667 } 668 }, 669 "default": { 670 "description": "Error.", 671 "content": { 672 "application/json": { 673 "schema": { 674 "$ref": "#/components/schemas/Error" 675 } 676 } 677 } 678 } 679 } 680 } 681 }, 682 "/api/web_rca/v1/incidents/{incident_id}/events/{event_id}/attachments": { 683 "get": { 684 "description": "Retrieves the list of attachments", 685 "parameters": [ 686 { 687 "name": "incident_id", 688 "in": "path", 689 "schema": { 690 "type": "string" 691 }, 692 "required": true 693 }, 694 { 695 "name": "event_id", 696 "in": "path", 697 "schema": { 698 "type": "string" 699 }, 700 "required": true 701 }, 702 { 703 "name": "page", 704 "in": "query", 705 "schema": { 706 "type": "integer", 707 "format": "int32" 708 } 709 }, 710 { 711 "name": "size", 712 "in": "query", 713 "schema": { 714 "type": "integer", 715 "format": "int32" 716 } 717 } 718 ], 719 "responses": { 720 "200": { 721 "description": "Success.", 722 "content": { 723 "application/json": { 724 "schema": { 725 "type": "object", 726 "properties": { 727 "items": { 728 "type": "array", 729 "items": { 730 "$ref": "#/components/schemas/Attachment" 731 } 732 }, 733 "page": { 734 "type": "integer", 735 "format": "int32" 736 }, 737 "size": { 738 "type": "integer", 739 "format": "int32" 740 }, 741 "total": { 742 "type": "integer", 743 "format": "int32" 744 } 745 } 746 } 747 } 748 } 749 }, 750 "default": { 751 "description": "Error.", 752 "content": { 753 "application/json": { 754 "schema": { 755 "$ref": "#/components/schemas/Error" 756 } 757 } 758 } 759 } 760 } 761 } 762 }, 763 "/api/web_rca/v1/incidents/{incident_id}/events/{event_id}/attachments/{attachment_id}": { 764 "delete": { 765 "parameters": [ 766 { 767 "name": "incident_id", 768 "in": "path", 769 "schema": { 770 "type": "string" 771 }, 772 "required": true 773 }, 774 { 775 "name": "event_id", 776 "in": "path", 777 "schema": { 778 "type": "string" 779 }, 780 "required": true 781 }, 782 { 783 "name": "attachment_id", 784 "in": "path", 785 "schema": { 786 "type": "string" 787 }, 788 "required": true 789 } 790 ], 791 "responses": { 792 "204": { 793 "description": "Success." 794 }, 795 "default": { 796 "description": "Error.", 797 "content": { 798 "application/json": { 799 "schema": { 800 "$ref": "#/components/schemas/Error" 801 } 802 } 803 } 804 } 805 } 806 }, 807 "get": { 808 "parameters": [ 809 { 810 "name": "incident_id", 811 "in": "path", 812 "schema": { 813 "type": "string" 814 }, 815 "required": true 816 }, 817 { 818 "name": "event_id", 819 "in": "path", 820 "schema": { 821 "type": "string" 822 }, 823 "required": true 824 }, 825 { 826 "name": "attachment_id", 827 "in": "path", 828 "schema": { 829 "type": "string" 830 }, 831 "required": true 832 } 833 ], 834 "responses": { 835 "200": { 836 "description": "Success.", 837 "content": { 838 "application/json": { 839 "schema": { 840 "$ref": "#/components/schemas/Attachment" 841 } 842 } 843 } 844 }, 845 "default": { 846 "description": "Error.", 847 "content": { 848 "application/json": { 849 "schema": { 850 "$ref": "#/components/schemas/Error" 851 } 852 } 853 } 854 } 855 } 856 }, 857 "patch": { 858 "parameters": [ 859 { 860 "name": "incident_id", 861 "in": "path", 862 "schema": { 863 "type": "string" 864 }, 865 "required": true 866 }, 867 { 868 "name": "event_id", 869 "in": "path", 870 "schema": { 871 "type": "string" 872 }, 873 "required": true 874 }, 875 { 876 "name": "attachment_id", 877 "in": "path", 878 "schema": { 879 "type": "string" 880 }, 881 "required": true 882 } 883 ], 884 "requestBody": { 885 "content": { 886 "application/json": { 887 "schema": { 888 "$ref": "#/components/schemas/Attachment" 889 } 890 } 891 } 892 }, 893 "responses": { 894 "200": { 895 "description": "Success.", 896 "content": { 897 "application/json": { 898 "schema": { 899 "$ref": "#/components/schemas/Attachment" 900 } 901 } 902 } 903 }, 904 "default": { 905 "description": "Error.", 906 "content": { 907 "application/json": { 908 "schema": { 909 "$ref": "#/components/schemas/Error" 910 } 911 } 912 } 913 } 914 } 915 } 916 }, 917 "/api/web_rca/v1/incidents/{incident_id}/follow_ups": { 918 "get": { 919 "description": "Retrieves the list of follow-ups", 920 "parameters": [ 921 { 922 "name": "incident_id", 923 "in": "path", 924 "schema": { 925 "type": "string" 926 }, 927 "required": true 928 }, 929 { 930 "name": "created_after", 931 "in": "query", 932 "schema": { 933 "type": "string", 934 "format": "date-time" 935 } 936 }, 937 { 938 "name": "created_before", 939 "in": "query", 940 "schema": { 941 "type": "string", 942 "format": "date-time" 943 } 944 }, 945 { 946 "name": "follow_up_status", 947 "in": "query", 948 "schema": { 949 "type": "string" 950 } 951 }, 952 { 953 "name": "order_by", 954 "in": "query", 955 "schema": { 956 "type": "string" 957 } 958 }, 959 { 960 "name": "page", 961 "in": "query", 962 "schema": { 963 "type": "integer", 964 "format": "int32" 965 } 966 }, 967 { 968 "name": "size", 969 "in": "query", 970 "schema": { 971 "type": "integer", 972 "format": "int32" 973 } 974 } 975 ], 976 "responses": { 977 "200": { 978 "description": "Success.", 979 "content": { 980 "application/json": { 981 "schema": { 982 "type": "object", 983 "properties": { 984 "items": { 985 "type": "array", 986 "items": { 987 "$ref": "#/components/schemas/FollowUp" 988 } 989 }, 990 "page": { 991 "type": "integer", 992 "format": "int32" 993 }, 994 "size": { 995 "type": "integer", 996 "format": "int32" 997 }, 998 "total": { 999 "type": "integer", 1000 "format": "int32" 1001 } 1002 } 1003 } 1004 } 1005 } 1006 }, 1007 "default": { 1008 "description": "Error.", 1009 "content": { 1010 "application/json": { 1011 "schema": { 1012 "$ref": "#/components/schemas/Error" 1013 } 1014 } 1015 } 1016 } 1017 } 1018 } 1019 }, 1020 "/api/web_rca/v1/incidents/{incident_id}/follow_ups/{follow_up_id}": { 1021 "delete": { 1022 "parameters": [ 1023 { 1024 "name": "incident_id", 1025 "in": "path", 1026 "schema": { 1027 "type": "string" 1028 }, 1029 "required": true 1030 }, 1031 { 1032 "name": "follow_up_id", 1033 "in": "path", 1034 "schema": { 1035 "type": "string" 1036 }, 1037 "required": true 1038 } 1039 ], 1040 "responses": { 1041 "204": { 1042 "description": "Success." 1043 }, 1044 "default": { 1045 "description": "Error.", 1046 "content": { 1047 "application/json": { 1048 "schema": { 1049 "$ref": "#/components/schemas/Error" 1050 } 1051 } 1052 } 1053 } 1054 } 1055 }, 1056 "get": { 1057 "parameters": [ 1058 { 1059 "name": "incident_id", 1060 "in": "path", 1061 "schema": { 1062 "type": "string" 1063 }, 1064 "required": true 1065 }, 1066 { 1067 "name": "follow_up_id", 1068 "in": "path", 1069 "schema": { 1070 "type": "string" 1071 }, 1072 "required": true 1073 } 1074 ], 1075 "responses": { 1076 "200": { 1077 "description": "Success.", 1078 "content": { 1079 "application/json": { 1080 "schema": { 1081 "$ref": "#/components/schemas/FollowUp" 1082 } 1083 } 1084 } 1085 }, 1086 "default": { 1087 "description": "Error.", 1088 "content": { 1089 "application/json": { 1090 "schema": { 1091 "$ref": "#/components/schemas/Error" 1092 } 1093 } 1094 } 1095 } 1096 } 1097 }, 1098 "patch": { 1099 "parameters": [ 1100 { 1101 "name": "incident_id", 1102 "in": "path", 1103 "schema": { 1104 "type": "string" 1105 }, 1106 "required": true 1107 }, 1108 { 1109 "name": "follow_up_id", 1110 "in": "path", 1111 "schema": { 1112 "type": "string" 1113 }, 1114 "required": true 1115 } 1116 ], 1117 "requestBody": { 1118 "content": { 1119 "application/json": { 1120 "schema": { 1121 "$ref": "#/components/schemas/FollowUp" 1122 } 1123 } 1124 } 1125 }, 1126 "responses": { 1127 "200": { 1128 "description": "Success.", 1129 "content": { 1130 "application/json": { 1131 "schema": { 1132 "$ref": "#/components/schemas/FollowUp" 1133 } 1134 } 1135 } 1136 }, 1137 "default": { 1138 "description": "Error.", 1139 "content": { 1140 "application/json": { 1141 "schema": { 1142 "$ref": "#/components/schemas/Error" 1143 } 1144 } 1145 } 1146 } 1147 } 1148 } 1149 }, 1150 "/api/web_rca/v1/incidents/{incident_id}/notifications": { 1151 "get": { 1152 "description": "Retrieves the list of notifications", 1153 "parameters": [ 1154 { 1155 "name": "incident_id", 1156 "in": "path", 1157 "schema": { 1158 "type": "string" 1159 }, 1160 "required": true 1161 }, 1162 { 1163 "name": "checked", 1164 "in": "query", 1165 "schema": { 1166 "type": "boolean" 1167 } 1168 }, 1169 { 1170 "name": "page", 1171 "in": "query", 1172 "schema": { 1173 "type": "integer", 1174 "format": "int32" 1175 } 1176 }, 1177 { 1178 "name": "size", 1179 "in": "query", 1180 "schema": { 1181 "type": "integer", 1182 "format": "int32" 1183 } 1184 } 1185 ], 1186 "responses": { 1187 "200": { 1188 "description": "Success.", 1189 "content": { 1190 "application/json": { 1191 "schema": { 1192 "type": "object", 1193 "properties": { 1194 "items": { 1195 "type": "array", 1196 "items": { 1197 "$ref": "#/components/schemas/Notification" 1198 } 1199 }, 1200 "page": { 1201 "type": "integer", 1202 "format": "int32" 1203 }, 1204 "size": { 1205 "type": "integer", 1206 "format": "int32" 1207 }, 1208 "total": { 1209 "type": "integer", 1210 "format": "int32" 1211 } 1212 } 1213 } 1214 } 1215 } 1216 }, 1217 "default": { 1218 "description": "Error.", 1219 "content": { 1220 "application/json": { 1221 "schema": { 1222 "$ref": "#/components/schemas/Error" 1223 } 1224 } 1225 } 1226 } 1227 } 1228 } 1229 }, 1230 "/api/web_rca/v1/incidents/{incident_id}/notifications/{notification_id}": { 1231 "delete": { 1232 "parameters": [ 1233 { 1234 "name": "incident_id", 1235 "in": "path", 1236 "schema": { 1237 "type": "string" 1238 }, 1239 "required": true 1240 }, 1241 { 1242 "name": "notification_id", 1243 "in": "path", 1244 "schema": { 1245 "type": "string" 1246 }, 1247 "required": true 1248 } 1249 ], 1250 "responses": { 1251 "204": { 1252 "description": "Success." 1253 }, 1254 "default": { 1255 "description": "Error.", 1256 "content": { 1257 "application/json": { 1258 "schema": { 1259 "$ref": "#/components/schemas/Error" 1260 } 1261 } 1262 } 1263 } 1264 } 1265 }, 1266 "get": { 1267 "parameters": [ 1268 { 1269 "name": "incident_id", 1270 "in": "path", 1271 "schema": { 1272 "type": "string" 1273 }, 1274 "required": true 1275 }, 1276 { 1277 "name": "notification_id", 1278 "in": "path", 1279 "schema": { 1280 "type": "string" 1281 }, 1282 "required": true 1283 } 1284 ], 1285 "responses": { 1286 "200": { 1287 "description": "Success.", 1288 "content": { 1289 "application/json": { 1290 "schema": { 1291 "$ref": "#/components/schemas/Notification" 1292 } 1293 } 1294 } 1295 }, 1296 "default": { 1297 "description": "Error.", 1298 "content": { 1299 "application/json": { 1300 "schema": { 1301 "$ref": "#/components/schemas/Error" 1302 } 1303 } 1304 } 1305 } 1306 } 1307 }, 1308 "patch": { 1309 "parameters": [ 1310 { 1311 "name": "incident_id", 1312 "in": "path", 1313 "schema": { 1314 "type": "string" 1315 }, 1316 "required": true 1317 }, 1318 { 1319 "name": "notification_id", 1320 "in": "path", 1321 "schema": { 1322 "type": "string" 1323 }, 1324 "required": true 1325 } 1326 ], 1327 "requestBody": { 1328 "content": { 1329 "application/json": { 1330 "schema": { 1331 "$ref": "#/components/schemas/Notification" 1332 } 1333 } 1334 } 1335 }, 1336 "responses": { 1337 "200": { 1338 "description": "Success.", 1339 "content": { 1340 "application/json": { 1341 "schema": { 1342 "$ref": "#/components/schemas/Notification" 1343 } 1344 } 1345 } 1346 }, 1347 "default": { 1348 "description": "Error.", 1349 "content": { 1350 "application/json": { 1351 "schema": { 1352 "$ref": "#/components/schemas/Error" 1353 } 1354 } 1355 } 1356 } 1357 } 1358 } 1359 }, 1360 "/api/web_rca/v1/users": { 1361 "get": { 1362 "description": "Retrieves the list of users.", 1363 "parameters": [ 1364 { 1365 "name": "order_by", 1366 "in": "query", 1367 "schema": { 1368 "type": "string" 1369 } 1370 }, 1371 { 1372 "name": "page", 1373 "in": "query", 1374 "schema": { 1375 "type": "integer", 1376 "format": "int32" 1377 } 1378 }, 1379 { 1380 "name": "size", 1381 "in": "query", 1382 "schema": { 1383 "type": "integer", 1384 "format": "int32" 1385 } 1386 } 1387 ], 1388 "responses": { 1389 "200": { 1390 "description": "Success.", 1391 "content": { 1392 "application/json": { 1393 "schema": { 1394 "type": "object", 1395 "properties": { 1396 "items": { 1397 "type": "array", 1398 "items": { 1399 "$ref": "#/components/schemas/User" 1400 } 1401 }, 1402 "page": { 1403 "type": "integer", 1404 "format": "int32" 1405 }, 1406 "size": { 1407 "type": "integer", 1408 "format": "int32" 1409 }, 1410 "total": { 1411 "type": "integer", 1412 "format": "int32" 1413 } 1414 } 1415 } 1416 } 1417 } 1418 }, 1419 "default": { 1420 "description": "Error.", 1421 "content": { 1422 "application/json": { 1423 "schema": { 1424 "$ref": "#/components/schemas/Error" 1425 } 1426 } 1427 } 1428 } 1429 } 1430 } 1431 }, 1432 "/api/web_rca/v1/users/{user_id}": { 1433 "get": { 1434 "parameters": [ 1435 { 1436 "name": "user_id", 1437 "in": "path", 1438 "schema": { 1439 "type": "string" 1440 }, 1441 "required": true 1442 } 1443 ], 1444 "responses": { 1445 "200": { 1446 "description": "Success.", 1447 "content": { 1448 "application/json": { 1449 "schema": { 1450 "$ref": "#/components/schemas/User" 1451 } 1452 } 1453 } 1454 }, 1455 "default": { 1456 "description": "Error.", 1457 "content": { 1458 "application/json": { 1459 "schema": { 1460 "$ref": "#/components/schemas/Error" 1461 } 1462 } 1463 } 1464 } 1465 } 1466 } 1467 } 1468 }, 1469 "components": { 1470 "schemas": { 1471 "Metadata": { 1472 "description": "Version metadata.", 1473 "properties": { 1474 "server_version": { 1475 "description": "Version of the server.", 1476 "type": "string" 1477 } 1478 } 1479 }, 1480 "Attachment": { 1481 "description": "Definition of a Web RCA attachment.", 1482 "properties": { 1483 "kind": { 1484 "description": "Indicates the type of this object. Will be 'Attachment' if this is a complete object or 'AttachmentLink' if it is just a link.", 1485 "type": "string" 1486 }, 1487 "id": { 1488 "description": "Unique identifier of the object.", 1489 "type": "string" 1490 }, 1491 "href": { 1492 "description": "Self link.", 1493 "type": "string" 1494 }, 1495 "content_type": { 1496 "type": "string" 1497 }, 1498 "created_at": { 1499 "description": "Object creation timestamp.", 1500 "type": "string", 1501 "format": "date-time" 1502 }, 1503 "creator": { 1504 "$ref": "#/components/schemas/User" 1505 }, 1506 "deleted_at": { 1507 "description": "Object deletion timestamp.", 1508 "type": "string", 1509 "format": "date-time" 1510 }, 1511 "event": { 1512 "$ref": "#/components/schemas/Event" 1513 }, 1514 "file_size": { 1515 "type": "integer", 1516 "format": "int32" 1517 }, 1518 "name": { 1519 "type": "string" 1520 }, 1521 "updated_at": { 1522 "description": "Object modification timestamp.", 1523 "type": "string", 1524 "format": "date-time" 1525 } 1526 } 1527 }, 1528 "Error": { 1529 "description": "Definition of a Web RCA error.", 1530 "properties": { 1531 "kind": { 1532 "description": "Indicates the type of this object. Will be 'Error' if this is a complete object or 'ErrorLink' if it is just a link.", 1533 "type": "string" 1534 }, 1535 "id": { 1536 "description": "Unique identifier of the object.", 1537 "type": "string" 1538 }, 1539 "href": { 1540 "description": "Self link.", 1541 "type": "string" 1542 }, 1543 "code": { 1544 "type": "string" 1545 }, 1546 "reason": { 1547 "type": "string" 1548 } 1549 } 1550 }, 1551 "Escalation": { 1552 "description": "Definition of a Web RCA escalation.", 1553 "properties": { 1554 "kind": { 1555 "description": "Indicates the type of this object. Will be 'Escalation' if this is a complete object or 'EscalationLink' if it is just a link.", 1556 "type": "string" 1557 }, 1558 "id": { 1559 "description": "Unique identifier of the object.", 1560 "type": "string" 1561 }, 1562 "href": { 1563 "description": "Self link.", 1564 "type": "string" 1565 }, 1566 "created_at": { 1567 "description": "Object creation timestamp.", 1568 "type": "string", 1569 "format": "date-time" 1570 }, 1571 "deleted_at": { 1572 "description": "Object deletion timestamp.", 1573 "type": "string", 1574 "format": "date-time" 1575 }, 1576 "updated_at": { 1577 "description": "Object modification timestamp.", 1578 "type": "string", 1579 "format": "date-time" 1580 }, 1581 "user": { 1582 "$ref": "#/components/schemas/User" 1583 } 1584 } 1585 }, 1586 "Event": { 1587 "description": "Definition of a Web RCA event.", 1588 "properties": { 1589 "kind": { 1590 "description": "Indicates the type of this object. Will be 'Event' if this is a complete object or 'EventLink' if it is just a link.", 1591 "type": "string" 1592 }, 1593 "id": { 1594 "description": "Unique identifier of the object.", 1595 "type": "string" 1596 }, 1597 "href": { 1598 "description": "Self link.", 1599 "type": "string" 1600 }, 1601 "created_at": { 1602 "description": "Object creation timestamp.", 1603 "type": "string", 1604 "format": "date-time" 1605 }, 1606 "creator": { 1607 "$ref": "#/components/schemas/User" 1608 }, 1609 "deleted_at": { 1610 "description": "Object deletion timestamp.", 1611 "type": "string", 1612 "format": "date-time" 1613 }, 1614 "escalation": { 1615 "$ref": "#/components/schemas/Escalation" 1616 }, 1617 "event_type": { 1618 "type": "string" 1619 }, 1620 "external_reference_url": { 1621 "type": "string" 1622 }, 1623 "follow_up": { 1624 "$ref": "#/components/schemas/FollowUp" 1625 }, 1626 "follow_up_change": { 1627 "$ref": "#/components/schemas/FollowUpChange" 1628 }, 1629 "handoff": { 1630 "$ref": "#/components/schemas/Handoff" 1631 }, 1632 "incident": { 1633 "$ref": "#/components/schemas/Incident" 1634 }, 1635 "note": { 1636 "type": "string" 1637 }, 1638 "status_change": { 1639 "$ref": "#/components/schemas/StatusChange" 1640 }, 1641 "updated_at": { 1642 "description": "Object modification timestamp.", 1643 "type": "string", 1644 "format": "date-time" 1645 } 1646 } 1647 }, 1648 "FollowUp": { 1649 "description": "Definition of a Web RCA event.", 1650 "properties": { 1651 "kind": { 1652 "description": "Indicates the type of this object. Will be 'FollowUp' if this is a complete object or 'FollowUpLink' if it is just a link.", 1653 "type": "string" 1654 }, 1655 "id": { 1656 "description": "Unique identifier of the object.", 1657 "type": "string" 1658 }, 1659 "href": { 1660 "description": "Self link.", 1661 "type": "string" 1662 }, 1663 "archived": { 1664 "type": "boolean" 1665 }, 1666 "created_at": { 1667 "description": "Object creation timestamp.", 1668 "type": "string", 1669 "format": "date-time" 1670 }, 1671 "deleted_at": { 1672 "description": "Object deletion timestamp.", 1673 "type": "string", 1674 "format": "date-time" 1675 }, 1676 "done": { 1677 "type": "boolean" 1678 }, 1679 "follow_up_type": { 1680 "type": "string" 1681 }, 1682 "incident": { 1683 "$ref": "#/components/schemas/Incident" 1684 }, 1685 "owner": { 1686 "type": "string" 1687 }, 1688 "priority": { 1689 "type": "string" 1690 }, 1691 "status": { 1692 "type": "string" 1693 }, 1694 "title": { 1695 "type": "string" 1696 }, 1697 "updated_at": { 1698 "description": "Object modification timestamp.", 1699 "type": "string", 1700 "format": "date-time" 1701 }, 1702 "url": { 1703 "type": "string" 1704 }, 1705 "worked_at": { 1706 "type": "string", 1707 "format": "date-time" 1708 } 1709 } 1710 }, 1711 "FollowUpChange": { 1712 "description": "Definition of a Web RCA event.", 1713 "properties": { 1714 "kind": { 1715 "description": "Indicates the type of this object. Will be 'FollowUpChange' if this is a complete object or 'FollowUpChangeLink' if it is just a link.", 1716 "type": "string" 1717 }, 1718 "id": { 1719 "description": "Unique identifier of the object.", 1720 "type": "string" 1721 }, 1722 "href": { 1723 "description": "Self link.", 1724 "type": "string" 1725 }, 1726 "created_at": { 1727 "description": "Object creation timestamp.", 1728 "type": "string", 1729 "format": "date-time" 1730 }, 1731 "deleted_at": { 1732 "description": "Object deletion timestamp.", 1733 "type": "string", 1734 "format": "date-time" 1735 }, 1736 "follow_up": { 1737 "$ref": "#/components/schemas/FollowUp" 1738 }, 1739 "status": { 1740 "type": "object" 1741 }, 1742 "updated_at": { 1743 "description": "Object modification timestamp.", 1744 "type": "string", 1745 "format": "date-time" 1746 } 1747 } 1748 }, 1749 "Handoff": { 1750 "description": "Definition of a Web RCA handoff.", 1751 "properties": { 1752 "kind": { 1753 "description": "Indicates the type of this object. Will be 'Handoff' if this is a complete object or 'HandoffLink' if it is just a link.", 1754 "type": "string" 1755 }, 1756 "id": { 1757 "description": "Unique identifier of the object.", 1758 "type": "string" 1759 }, 1760 "href": { 1761 "description": "Self link.", 1762 "type": "string" 1763 }, 1764 "created_at": { 1765 "description": "Object creation timestamp.", 1766 "type": "string", 1767 "format": "date-time" 1768 }, 1769 "deleted_at": { 1770 "description": "Object deletion timestamp.", 1771 "type": "string", 1772 "format": "date-time" 1773 }, 1774 "handoff_from": { 1775 "$ref": "#/components/schemas/User" 1776 }, 1777 "handoff_to": { 1778 "$ref": "#/components/schemas/User" 1779 }, 1780 "handoff_type": { 1781 "type": "string" 1782 }, 1783 "updated_at": { 1784 "description": "Object modification timestamp.", 1785 "type": "string", 1786 "format": "date-time" 1787 } 1788 } 1789 }, 1790 "Incident": { 1791 "description": "Definition of a Web RCA incident.", 1792 "properties": { 1793 "kind": { 1794 "description": "Indicates the type of this object. Will be 'Incident' if this is a complete object or 'IncidentLink' if it is just a link.", 1795 "type": "string" 1796 }, 1797 "id": { 1798 "description": "Unique identifier of the object.", 1799 "type": "string" 1800 }, 1801 "href": { 1802 "description": "Self link.", 1803 "type": "string" 1804 }, 1805 "created_at": { 1806 "description": "Object creation timestamp.", 1807 "type": "string", 1808 "format": "date-time" 1809 }, 1810 "creator_id": { 1811 "type": "string" 1812 }, 1813 "deleted_at": { 1814 "description": "Object deletion timestamp.", 1815 "type": "string", 1816 "format": "date-time" 1817 }, 1818 "description": { 1819 "type": "string" 1820 }, 1821 "external_coordination": { 1822 "type": "array", 1823 "items": { 1824 "type": "string" 1825 } 1826 }, 1827 "incident_id": { 1828 "type": "string" 1829 }, 1830 "incident_type": { 1831 "type": "string" 1832 }, 1833 "last_updated": { 1834 "type": "string", 1835 "format": "date-time" 1836 }, 1837 "primary_team": { 1838 "type": "string" 1839 }, 1840 "severity": { 1841 "type": "string" 1842 }, 1843 "status": { 1844 "type": "string" 1845 }, 1846 "summary": { 1847 "type": "string" 1848 }, 1849 "updated_at": { 1850 "description": "Object modification timestamp.", 1851 "type": "string", 1852 "format": "date-time" 1853 }, 1854 "worked_at": { 1855 "type": "string", 1856 "format": "date-time" 1857 } 1858 } 1859 }, 1860 "Notification": { 1861 "description": "Definition of a Web RCA notification.", 1862 "properties": { 1863 "kind": { 1864 "description": "Indicates the type of this object. Will be 'Notification' if this is a complete object or 'NotificationLink' if it is just a link.", 1865 "type": "string" 1866 }, 1867 "id": { 1868 "description": "Unique identifier of the object.", 1869 "type": "string" 1870 }, 1871 "href": { 1872 "description": "Self link.", 1873 "type": "string" 1874 }, 1875 "checked": { 1876 "type": "boolean" 1877 }, 1878 "created_at": { 1879 "description": "Object creation timestamp.", 1880 "type": "string", 1881 "format": "date-time" 1882 }, 1883 "deleted_at": { 1884 "description": "Object deletion timestamp.", 1885 "type": "string", 1886 "format": "date-time" 1887 }, 1888 "incident": { 1889 "$ref": "#/components/schemas/Incident" 1890 }, 1891 "name": { 1892 "type": "string" 1893 }, 1894 "rank": { 1895 "type": "integer", 1896 "format": "int32" 1897 }, 1898 "updated_at": { 1899 "description": "Object modification timestamp.", 1900 "type": "string", 1901 "format": "date-time" 1902 } 1903 } 1904 }, 1905 "Product": { 1906 "description": "Definition of a Web RCA product.", 1907 "properties": { 1908 "kind": { 1909 "description": "Indicates the type of this object. Will be 'Product' if this is a complete object or 'ProductLink' if it is just a link.", 1910 "type": "string" 1911 }, 1912 "id": { 1913 "description": "Unique identifier of the object.", 1914 "type": "string" 1915 }, 1916 "href": { 1917 "description": "Self link.", 1918 "type": "string" 1919 }, 1920 "created_at": { 1921 "description": "Object creation timestamp.", 1922 "type": "string", 1923 "format": "date-time" 1924 }, 1925 "deleted_at": { 1926 "description": "Object deletion timestamp.", 1927 "type": "string", 1928 "format": "date-time" 1929 }, 1930 "product_id": { 1931 "description": "The product ID from status board", 1932 "type": "string" 1933 }, 1934 "product_name": { 1935 "description": "The name of the product from status-board.", 1936 "type": "string" 1937 }, 1938 "updated_at": { 1939 "description": "Object modification timestamp.", 1940 "type": "string", 1941 "format": "date-time" 1942 } 1943 } 1944 }, 1945 "StatusChange": { 1946 "description": "Definition of a Web RCA event.", 1947 "properties": { 1948 "kind": { 1949 "description": "Indicates the type of this object. Will be 'StatusChange' if this is a complete object or 'StatusChangeLink' if it is just a link.", 1950 "type": "string" 1951 }, 1952 "id": { 1953 "description": "Unique identifier of the object.", 1954 "type": "string" 1955 }, 1956 "href": { 1957 "description": "Self link.", 1958 "type": "string" 1959 }, 1960 "created_at": { 1961 "description": "Object creation timestamp.", 1962 "type": "string", 1963 "format": "date-time" 1964 }, 1965 "deleted_at": { 1966 "description": "Object deletion timestamp.", 1967 "type": "string", 1968 "format": "date-time" 1969 }, 1970 "status": { 1971 "type": "object" 1972 }, 1973 "status_id": { 1974 "type": "string" 1975 }, 1976 "updated_at": { 1977 "description": "Object modification timestamp.", 1978 "type": "string", 1979 "format": "date-time" 1980 } 1981 } 1982 }, 1983 "User": { 1984 "description": "Definition of a Web RCA user.", 1985 "properties": { 1986 "kind": { 1987 "description": "Indicates the type of this object. Will be 'User' if this is a complete object or 'UserLink' if it is just a link.", 1988 "type": "string" 1989 }, 1990 "id": { 1991 "description": "Unique identifier of the object.", 1992 "type": "string" 1993 }, 1994 "href": { 1995 "description": "Self link.", 1996 "type": "string" 1997 }, 1998 "created_at": { 1999 "description": "Object creation timestamp.", 2000 "type": "string", 2001 "format": "date-time" 2002 }, 2003 "deleted_at": { 2004 "description": "Object deletion timestamp.", 2005 "type": "string", 2006 "format": "date-time" 2007 }, 2008 "email": { 2009 "type": "string" 2010 }, 2011 "from_auth": { 2012 "type": "boolean" 2013 }, 2014 "name": { 2015 "type": "string" 2016 }, 2017 "updated_at": { 2018 "description": "Object modification timestamp.", 2019 "type": "string", 2020 "format": "date-time" 2021 }, 2022 "username": { 2023 "type": "string" 2024 } 2025 } 2026 }, 2027 "Error": { 2028 "type": "object", 2029 "properties": { 2030 "kind": { 2031 "description": "Indicates the type of this object. Will always be 'Error'", 2032 "type": "string" 2033 }, 2034 "id": { 2035 "description": "Numeric identifier of the error.", 2036 "type": "integer", 2037 "format": "int32" 2038 }, 2039 "href": { 2040 "description": "Self link.", 2041 "type": "string" 2042 }, 2043 "code": { 2044 "description": "Globally unique code of the error, composed of the unique identifier of the API and the numeric identifier of the error. For example, for if the numeric identifier of the error is `93` and the identifier of the API is `clusters_mgmt` then the code will be `CLUSTERS-MGMT-93`.", 2045 "type": "string" 2046 }, 2047 "reason": { 2048 "description": "Human readable description of the error.", 2049 "type": "string" 2050 }, 2051 "details": { 2052 "description": "Extra information about the error.", 2053 "type": "object", 2054 "additionalProperties": true 2055 } 2056 } 2057 } 2058 }, 2059 "securitySchemes": { 2060 "bearer": { 2061 "type": "http", 2062 "scheme": "bearer", 2063 "bearerFormat": "JWT" 2064 } 2065 } 2066 }, 2067 "security": [ 2068 { 2069 "bearer": [ 2070 2071 ] 2072 } 2073 ] 2074 }