github.com/openshift-online/ocm-sdk-go@v0.1.473/openapi/accounts_mgmt/v1/openapi.json (about) 1 { 2 "openapi": "3.0.0", 3 "info": { 4 "version": "v1", 5 "title": "accounts_mgmt", 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/accounts_mgmt/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/accounts_mgmt/v1/access_token": { 54 "post": { 55 "description": "Returns access token generated from registries in docker format.", 56 "responses": { 57 "201": { 58 "description": "Success.", 59 "content": { 60 "application/json": { 61 "schema": { 62 "$ref": "#/components/schemas/AccessToken" 63 } 64 } 65 } 66 }, 67 "default": { 68 "description": "Error.", 69 "content": { 70 "application/json": { 71 "schema": { 72 "$ref": "#/components/schemas/Error" 73 } 74 } 75 } 76 } 77 } 78 } 79 }, 80 "/api/accounts_mgmt/v1/accounts": { 81 "post": { 82 "description": "Creates a new account.", 83 "requestBody": { 84 "content": { 85 "application/json": { 86 "schema": { 87 "$ref": "#/components/schemas/Account" 88 } 89 } 90 } 91 }, 92 "responses": { 93 "201": { 94 "description": "Success.", 95 "content": { 96 "application/json": { 97 "schema": { 98 "$ref": "#/components/schemas/Account" 99 } 100 } 101 } 102 }, 103 "default": { 104 "description": "Error.", 105 "content": { 106 "application/json": { 107 "schema": { 108 "$ref": "#/components/schemas/Error" 109 } 110 } 111 } 112 } 113 } 114 }, 115 "get": { 116 "description": "Retrieves the list of accounts.", 117 "parameters": [ 118 { 119 "name": "fetchLabels", 120 "description": "If true, includes the labels on an account in the output. Could slow request response time.", 121 "in": "query", 122 "schema": { 123 "type": "boolean" 124 } 125 }, 126 { 127 "name": "fields", 128 "description": "Projection\nThis field contains a comma-separated list of fields you'd like to get in\na result. No new fields can be added, only existing ones can be filtered.\nTo specify a field 'id' of a structure 'plan' use 'plan.id'.\nTo specify all fields of a structure 'labels' use 'labels.*'.\n", 129 "in": "query", 130 "schema": { 131 "type": "string" 132 } 133 }, 134 { 135 "name": "order", 136 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement. For example, in order to sort the\naccounts descending by name identifier the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 137 "in": "query", 138 "schema": { 139 "type": "string" 140 } 141 }, 142 { 143 "name": "page", 144 "description": "Index of the requested page, where one corresponds to the first page.", 145 "in": "query", 146 "schema": { 147 "type": "integer", 148 "format": "int32" 149 } 150 }, 151 { 152 "name": "search", 153 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the account\ninstead of the names of the columns of a table. For example, in order to\nretrieve accounts with username starting with my:\n\n```sql\nusername like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 154 "in": "query", 155 "schema": { 156 "type": "string" 157 } 158 }, 159 { 160 "name": "size", 161 "description": "Maximum number of items that will be contained in the returned page.", 162 "in": "query", 163 "schema": { 164 "type": "integer", 165 "format": "int32" 166 } 167 } 168 ], 169 "responses": { 170 "200": { 171 "description": "Success.", 172 "content": { 173 "application/json": { 174 "schema": { 175 "type": "object", 176 "properties": { 177 "items": { 178 "description": "Retrieved list of accounts.", 179 "type": "array", 180 "items": { 181 "$ref": "#/components/schemas/Account" 182 } 183 }, 184 "page": { 185 "description": "Index of the requested page, where one corresponds to the first page.", 186 "type": "integer", 187 "format": "int32" 188 }, 189 "size": { 190 "description": "Maximum number of items that will be contained in the returned page.", 191 "type": "integer", 192 "format": "int32" 193 }, 194 "total": { 195 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 196 "type": "integer", 197 "format": "int32" 198 } 199 } 200 } 201 } 202 } 203 }, 204 "default": { 205 "description": "Error.", 206 "content": { 207 "application/json": { 208 "schema": { 209 "$ref": "#/components/schemas/Error" 210 } 211 } 212 } 213 } 214 } 215 } 216 }, 217 "/api/accounts_mgmt/v1/accounts/{account_id}": { 218 "delete": { 219 "parameters": [ 220 { 221 "name": "account_id", 222 "in": "path", 223 "schema": { 224 "type": "string" 225 }, 226 "required": true 227 }, 228 { 229 "name": "deleteAssociatedResources", 230 "in": "query", 231 "schema": { 232 "type": "boolean" 233 } 234 } 235 ], 236 "responses": { 237 "204": { 238 "description": "Success." 239 }, 240 "default": { 241 "description": "Error.", 242 "content": { 243 "application/json": { 244 "schema": { 245 "$ref": "#/components/schemas/Error" 246 } 247 } 248 } 249 } 250 } 251 }, 252 "get": { 253 "description": "Retrieves the details of the account.", 254 "parameters": [ 255 { 256 "name": "account_id", 257 "in": "path", 258 "schema": { 259 "type": "string" 260 }, 261 "required": true 262 } 263 ], 264 "responses": { 265 "200": { 266 "description": "Success.", 267 "content": { 268 "application/json": { 269 "schema": { 270 "$ref": "#/components/schemas/Account" 271 } 272 } 273 } 274 }, 275 "default": { 276 "description": "Error.", 277 "content": { 278 "application/json": { 279 "schema": { 280 "$ref": "#/components/schemas/Error" 281 } 282 } 283 } 284 } 285 } 286 }, 287 "patch": { 288 "description": "Updates the account.", 289 "parameters": [ 290 { 291 "name": "account_id", 292 "in": "path", 293 "schema": { 294 "type": "string" 295 }, 296 "required": true 297 } 298 ], 299 "requestBody": { 300 "content": { 301 "application/json": { 302 "schema": { 303 "$ref": "#/components/schemas/Account" 304 } 305 } 306 } 307 }, 308 "responses": { 309 "200": { 310 "description": "Success.", 311 "content": { 312 "application/json": { 313 "schema": { 314 "$ref": "#/components/schemas/Account" 315 } 316 } 317 } 318 }, 319 "default": { 320 "description": "Error.", 321 "content": { 322 "application/json": { 323 "schema": { 324 "$ref": "#/components/schemas/Error" 325 } 326 } 327 } 328 } 329 } 330 } 331 }, 332 "/api/accounts_mgmt/v1/accounts/{account_id}/labels": { 333 "post": { 334 "description": "Create a new account/organization/subscription label.", 335 "parameters": [ 336 { 337 "name": "account_id", 338 "in": "path", 339 "schema": { 340 "type": "string" 341 }, 342 "required": true 343 } 344 ], 345 "requestBody": { 346 "content": { 347 "application/json": { 348 "schema": { 349 "$ref": "#/components/schemas/Label" 350 } 351 } 352 } 353 }, 354 "responses": { 355 "201": { 356 "description": "Success.", 357 "content": { 358 "application/json": { 359 "schema": { 360 "$ref": "#/components/schemas/Label" 361 } 362 } 363 } 364 }, 365 "default": { 366 "description": "Error.", 367 "content": { 368 "application/json": { 369 "schema": { 370 "$ref": "#/components/schemas/Error" 371 } 372 } 373 } 374 } 375 } 376 }, 377 "get": { 378 "description": "Retrieves the list of labels of the account/organization/subscription.\n\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of labels\nof the account/organization/subscription.", 379 "parameters": [ 380 { 381 "name": "account_id", 382 "in": "path", 383 "schema": { 384 "type": "string" 385 }, 386 "required": true 387 }, 388 { 389 "name": "page", 390 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 391 "in": "query", 392 "schema": { 393 "type": "integer", 394 "format": "int32" 395 } 396 }, 397 { 398 "name": "size", 399 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nlabels of the account/organization/subscription.", 400 "in": "query", 401 "schema": { 402 "type": "integer", 403 "format": "int32" 404 } 405 } 406 ], 407 "responses": { 408 "200": { 409 "description": "Success.", 410 "content": { 411 "application/json": { 412 "schema": { 413 "type": "object", 414 "properties": { 415 "items": { 416 "description": "Retrieved list of cloud providers.", 417 "type": "array", 418 "items": { 419 "$ref": "#/components/schemas/Label" 420 } 421 }, 422 "page": { 423 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 424 "type": "integer", 425 "format": "int32" 426 }, 427 "size": { 428 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nlabels of the account/organization/subscription.", 429 "type": "integer", 430 "format": "int32" 431 }, 432 "total": { 433 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of labels of the account/organization/subscription.", 434 "type": "integer", 435 "format": "int32" 436 } 437 } 438 } 439 } 440 } 441 }, 442 "default": { 443 "description": "Error.", 444 "content": { 445 "application/json": { 446 "schema": { 447 "$ref": "#/components/schemas/Error" 448 } 449 } 450 } 451 } 452 } 453 } 454 }, 455 "/api/accounts_mgmt/v1/accounts/{account_id}/labels/{label_id}": { 456 "delete": { 457 "description": "Deletes the account label.", 458 "parameters": [ 459 { 460 "name": "account_id", 461 "in": "path", 462 "schema": { 463 "type": "string" 464 }, 465 "required": true 466 }, 467 { 468 "name": "label_id", 469 "in": "path", 470 "schema": { 471 "type": "string" 472 }, 473 "required": true 474 } 475 ], 476 "responses": { 477 "204": { 478 "description": "Success." 479 }, 480 "default": { 481 "description": "Error.", 482 "content": { 483 "application/json": { 484 "schema": { 485 "$ref": "#/components/schemas/Error" 486 } 487 } 488 } 489 } 490 } 491 }, 492 "get": { 493 "description": "Retrieves the details of the label.", 494 "parameters": [ 495 { 496 "name": "account_id", 497 "in": "path", 498 "schema": { 499 "type": "string" 500 }, 501 "required": true 502 }, 503 { 504 "name": "label_id", 505 "in": "path", 506 "schema": { 507 "type": "string" 508 }, 509 "required": true 510 } 511 ], 512 "responses": { 513 "200": { 514 "description": "Success.", 515 "content": { 516 "application/json": { 517 "schema": { 518 "$ref": "#/components/schemas/Label" 519 } 520 } 521 } 522 }, 523 "default": { 524 "description": "Error.", 525 "content": { 526 "application/json": { 527 "schema": { 528 "$ref": "#/components/schemas/Error" 529 } 530 } 531 } 532 } 533 } 534 }, 535 "patch": { 536 "description": "Updates the account label.", 537 "parameters": [ 538 { 539 "name": "account_id", 540 "in": "path", 541 "schema": { 542 "type": "string" 543 }, 544 "required": true 545 }, 546 { 547 "name": "label_id", 548 "in": "path", 549 "schema": { 550 "type": "string" 551 }, 552 "required": true 553 } 554 ], 555 "requestBody": { 556 "content": { 557 "application/json": { 558 "schema": { 559 "$ref": "#/components/schemas/Label" 560 } 561 } 562 } 563 }, 564 "responses": { 565 "200": { 566 "description": "Success.", 567 "content": { 568 "application/json": { 569 "schema": { 570 "$ref": "#/components/schemas/Label" 571 } 572 } 573 } 574 }, 575 "default": { 576 "description": "Error.", 577 "content": { 578 "application/json": { 579 "schema": { 580 "$ref": "#/components/schemas/Error" 581 } 582 } 583 } 584 } 585 } 586 } 587 }, 588 "/api/accounts_mgmt/v1/accounts/{account_id}/labels/{labels_id}": { 589 "delete": { 590 "description": "Deletes the account label.", 591 "parameters": [ 592 { 593 "name": "account_id", 594 "in": "path", 595 "schema": { 596 "type": "string" 597 }, 598 "required": true 599 }, 600 { 601 "name": "labels_id", 602 "in": "path", 603 "schema": { 604 "type": "string" 605 }, 606 "required": true 607 } 608 ], 609 "responses": { 610 "204": { 611 "description": "Success." 612 }, 613 "default": { 614 "description": "Error.", 615 "content": { 616 "application/json": { 617 "schema": { 618 "$ref": "#/components/schemas/Error" 619 } 620 } 621 } 622 } 623 } 624 }, 625 "get": { 626 "description": "Retrieves the details of the label.", 627 "parameters": [ 628 { 629 "name": "account_id", 630 "in": "path", 631 "schema": { 632 "type": "string" 633 }, 634 "required": true 635 }, 636 { 637 "name": "labels_id", 638 "in": "path", 639 "schema": { 640 "type": "string" 641 }, 642 "required": true 643 } 644 ], 645 "responses": { 646 "200": { 647 "description": "Success.", 648 "content": { 649 "application/json": { 650 "schema": { 651 "$ref": "#/components/schemas/Label" 652 } 653 } 654 } 655 }, 656 "default": { 657 "description": "Error.", 658 "content": { 659 "application/json": { 660 "schema": { 661 "$ref": "#/components/schemas/Error" 662 } 663 } 664 } 665 } 666 } 667 }, 668 "patch": { 669 "description": "Updates the account label.", 670 "parameters": [ 671 { 672 "name": "account_id", 673 "in": "path", 674 "schema": { 675 "type": "string" 676 }, 677 "required": true 678 }, 679 { 680 "name": "labels_id", 681 "in": "path", 682 "schema": { 683 "type": "string" 684 }, 685 "required": true 686 } 687 ], 688 "requestBody": { 689 "content": { 690 "application/json": { 691 "schema": { 692 "$ref": "#/components/schemas/Label" 693 } 694 } 695 } 696 }, 697 "responses": { 698 "200": { 699 "description": "Success.", 700 "content": { 701 "application/json": { 702 "schema": { 703 "$ref": "#/components/schemas/Label" 704 } 705 } 706 } 707 }, 708 "default": { 709 "description": "Error.", 710 "content": { 711 "application/json": { 712 "schema": { 713 "$ref": "#/components/schemas/Error" 714 } 715 } 716 } 717 } 718 } 719 } 720 }, 721 "/api/accounts_mgmt/v1/billing_models": { 722 "get": { 723 "description": "Retrieves a list of BillingModels.", 724 "parameters": [ 725 { 726 "name": "page", 727 "description": "Index of the requested page, where one corresponds to the first page.", 728 "in": "query", 729 "schema": { 730 "type": "integer", 731 "format": "int32" 732 } 733 }, 734 { 735 "name": "size", 736 "description": "Maximum number of items that will be contained in the returned page.", 737 "in": "query", 738 "schema": { 739 "type": "integer", 740 "format": "int32" 741 } 742 } 743 ], 744 "responses": { 745 "200": { 746 "description": "Success.", 747 "content": { 748 "application/json": { 749 "schema": { 750 "type": "object", 751 "properties": { 752 "items": { 753 "description": "Retrieve list of Billing Models.", 754 "type": "array", 755 "items": { 756 "$ref": "#/components/schemas/BillingModelItem" 757 } 758 }, 759 "page": { 760 "description": "Index of the requested page, where one corresponds to the first page.", 761 "type": "integer", 762 "format": "int32" 763 }, 764 "size": { 765 "description": "Maximum number of items that will be contained in the returned page.", 766 "type": "integer", 767 "format": "int32" 768 }, 769 "total": { 770 "description": "Total number of items of the collection, regardless of the size of the page.", 771 "type": "integer", 772 "format": "int32" 773 } 774 } 775 } 776 } 777 } 778 }, 779 "default": { 780 "description": "Error.", 781 "content": { 782 "application/json": { 783 "schema": { 784 "$ref": "#/components/schemas/Error" 785 } 786 } 787 } 788 } 789 } 790 } 791 }, 792 "/api/accounts_mgmt/v1/billing_models/{billing_model_id}": { 793 "get": { 794 "description": "Retrieves the details of the billing model", 795 "parameters": [ 796 { 797 "name": "billing_model_id", 798 "in": "path", 799 "schema": { 800 "type": "string" 801 }, 802 "required": true 803 } 804 ], 805 "responses": { 806 "200": { 807 "description": "Success.", 808 "content": { 809 "application/json": { 810 "schema": { 811 "$ref": "#/components/schemas/BillingModelItem" 812 } 813 } 814 } 815 }, 816 "default": { 817 "description": "Error.", 818 "content": { 819 "application/json": { 820 "schema": { 821 "$ref": "#/components/schemas/Error" 822 } 823 } 824 } 825 } 826 } 827 } 828 }, 829 "/api/accounts_mgmt/v1/capabilities": { 830 "get": { 831 "description": "Retrieves a list of Capabilities.", 832 "parameters": [ 833 { 834 "name": "page", 835 "description": "Index of the requested page, where one corresponds to the first page.", 836 "in": "query", 837 "schema": { 838 "type": "integer", 839 "format": "int32" 840 } 841 }, 842 { 843 "name": "search", 844 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the organization\ninstead of the names of the columns of a table. For example, in order to\nretrieve organizations with name starting with my:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 845 "in": "query", 846 "schema": { 847 "type": "string" 848 } 849 }, 850 { 851 "name": "size", 852 "description": "Maximum number of items that will be contained in the returned page.", 853 "in": "query", 854 "schema": { 855 "type": "integer", 856 "format": "int32" 857 } 858 } 859 ], 860 "responses": { 861 "200": { 862 "description": "Success.", 863 "content": { 864 "application/json": { 865 "schema": { 866 "type": "object", 867 "properties": { 868 "items": { 869 "description": "Retrieved list of Capabilities.", 870 "type": "array", 871 "items": { 872 "$ref": "#/components/schemas/Capability" 873 } 874 }, 875 "page": { 876 "description": "Index of the requested page, where one corresponds to the first page.", 877 "type": "integer", 878 "format": "int32" 879 }, 880 "size": { 881 "description": "Maximum number of items that will be contained in the returned page.", 882 "type": "integer", 883 "format": "int32" 884 }, 885 "total": { 886 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 887 "type": "integer", 888 "format": "int32" 889 } 890 } 891 } 892 } 893 } 894 }, 895 "default": { 896 "description": "Error.", 897 "content": { 898 "application/json": { 899 "schema": { 900 "$ref": "#/components/schemas/Error" 901 } 902 } 903 } 904 } 905 } 906 } 907 }, 908 "/api/accounts_mgmt/v1/cloud_resources": { 909 "post": { 910 "description": "Creates a new cloud resource", 911 "requestBody": { 912 "content": { 913 "application/json": { 914 "schema": { 915 "$ref": "#/components/schemas/CloudResource" 916 } 917 } 918 } 919 }, 920 "responses": { 921 "201": { 922 "description": "Success.", 923 "content": { 924 "application/json": { 925 "schema": { 926 "$ref": "#/components/schemas/CloudResource" 927 } 928 } 929 } 930 }, 931 "default": { 932 "description": "Error.", 933 "content": { 934 "application/json": { 935 "schema": { 936 "$ref": "#/components/schemas/Error" 937 } 938 } 939 } 940 } 941 } 942 }, 943 "get": { 944 "description": "Retrieves the list of cloud resources.", 945 "parameters": [ 946 { 947 "name": "page", 948 "description": "Index of the requested page, where one corresponds to the first page.", 949 "in": "query", 950 "schema": { 951 "type": "integer", 952 "format": "int32" 953 } 954 }, 955 { 956 "name": "search", 957 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the cloud resource\ninstead of the names of the columns of a table.\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 958 "in": "query", 959 "schema": { 960 "type": "string" 961 } 962 }, 963 { 964 "name": "size", 965 "description": "Maximum number of items that will be contained in the returned page.", 966 "in": "query", 967 "schema": { 968 "type": "integer", 969 "format": "int32" 970 } 971 } 972 ], 973 "responses": { 974 "200": { 975 "description": "Success.", 976 "content": { 977 "application/json": { 978 "schema": { 979 "type": "object", 980 "properties": { 981 "items": { 982 "description": "Retrieved list of cloud resources.", 983 "type": "array", 984 "items": { 985 "$ref": "#/components/schemas/CloudResource" 986 } 987 }, 988 "page": { 989 "description": "Index of the requested page, where one corresponds to the first page.", 990 "type": "integer", 991 "format": "int32" 992 }, 993 "size": { 994 "description": "Maximum number of items that will be contained in the returned page.", 995 "type": "integer", 996 "format": "int32" 997 }, 998 "total": { 999 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1000 "type": "integer", 1001 "format": "int32" 1002 } 1003 } 1004 } 1005 } 1006 } 1007 }, 1008 "default": { 1009 "description": "Error.", 1010 "content": { 1011 "application/json": { 1012 "schema": { 1013 "$ref": "#/components/schemas/Error" 1014 } 1015 } 1016 } 1017 } 1018 } 1019 } 1020 }, 1021 "/api/accounts_mgmt/v1/cloud_resources/{cloud_resource_id}": { 1022 "delete": { 1023 "description": "Deletes the cloud resource.", 1024 "parameters": [ 1025 { 1026 "name": "cloud_resource_id", 1027 "in": "path", 1028 "schema": { 1029 "type": "string" 1030 }, 1031 "required": true 1032 } 1033 ], 1034 "responses": { 1035 "204": { 1036 "description": "Success." 1037 }, 1038 "default": { 1039 "description": "Error.", 1040 "content": { 1041 "application/json": { 1042 "schema": { 1043 "$ref": "#/components/schemas/Error" 1044 } 1045 } 1046 } 1047 } 1048 } 1049 }, 1050 "get": { 1051 "description": "Retrieves the details of the cloud resource.", 1052 "parameters": [ 1053 { 1054 "name": "cloud_resource_id", 1055 "in": "path", 1056 "schema": { 1057 "type": "string" 1058 }, 1059 "required": true 1060 } 1061 ], 1062 "responses": { 1063 "200": { 1064 "description": "Success.", 1065 "content": { 1066 "application/json": { 1067 "schema": { 1068 "$ref": "#/components/schemas/CloudResource" 1069 } 1070 } 1071 } 1072 }, 1073 "default": { 1074 "description": "Error.", 1075 "content": { 1076 "application/json": { 1077 "schema": { 1078 "$ref": "#/components/schemas/Error" 1079 } 1080 } 1081 } 1082 } 1083 } 1084 }, 1085 "patch": { 1086 "description": "Updates the cloud resource.", 1087 "parameters": [ 1088 { 1089 "name": "cloud_resource_id", 1090 "in": "path", 1091 "schema": { 1092 "type": "string" 1093 }, 1094 "required": true 1095 } 1096 ], 1097 "requestBody": { 1098 "content": { 1099 "application/json": { 1100 "schema": { 1101 "$ref": "#/components/schemas/CloudResource" 1102 } 1103 } 1104 } 1105 }, 1106 "responses": { 1107 "200": { 1108 "description": "Success.", 1109 "content": { 1110 "application/json": { 1111 "schema": { 1112 "$ref": "#/components/schemas/CloudResource" 1113 } 1114 } 1115 } 1116 }, 1117 "default": { 1118 "description": "Error.", 1119 "content": { 1120 "application/json": { 1121 "schema": { 1122 "$ref": "#/components/schemas/Error" 1123 } 1124 } 1125 } 1126 } 1127 } 1128 } 1129 }, 1130 "/api/accounts_mgmt/v1/cluster_authorizations": { 1131 "post": { 1132 "description": "Authorizes new cluster creation against an existing subscription.", 1133 "requestBody": { 1134 "content": { 1135 "application/json": { 1136 "schema": { 1137 "$ref": "#/components/schemas/ClusterAuthorizationRequest" 1138 } 1139 } 1140 } 1141 }, 1142 "responses": { 1143 "201": { 1144 "description": "Success.", 1145 "content": { 1146 "application/json": { 1147 "schema": { 1148 "$ref": "#/components/schemas/ClusterAuthorizationResponse" 1149 } 1150 } 1151 } 1152 }, 1153 "default": { 1154 "description": "Error.", 1155 "content": { 1156 "application/json": { 1157 "schema": { 1158 "$ref": "#/components/schemas/Error" 1159 } 1160 } 1161 } 1162 } 1163 } 1164 } 1165 }, 1166 "/api/accounts_mgmt/v1/cluster_registrations": { 1167 "post": { 1168 "description": "Finds or creates a cluster registration with a registry credential\ntoken and cluster identifier.", 1169 "requestBody": { 1170 "content": { 1171 "application/json": { 1172 "schema": { 1173 "$ref": "#/components/schemas/ClusterRegistrationRequest" 1174 } 1175 } 1176 } 1177 }, 1178 "responses": { 1179 "201": { 1180 "description": "Success.", 1181 "content": { 1182 "application/json": { 1183 "schema": { 1184 "$ref": "#/components/schemas/ClusterRegistrationResponse" 1185 } 1186 } 1187 } 1188 }, 1189 "default": { 1190 "description": "Error.", 1191 "content": { 1192 "application/json": { 1193 "schema": { 1194 "$ref": "#/components/schemas/Error" 1195 } 1196 } 1197 } 1198 } 1199 } 1200 } 1201 }, 1202 "/api/accounts_mgmt/v1/current_access": { 1203 "post": { 1204 "description": "Creates a new role.", 1205 "requestBody": { 1206 "content": { 1207 "application/json": { 1208 "schema": { 1209 "$ref": "#/components/schemas/Role" 1210 } 1211 } 1212 } 1213 }, 1214 "responses": { 1215 "201": { 1216 "description": "Success.", 1217 "content": { 1218 "application/json": { 1219 "schema": { 1220 "$ref": "#/components/schemas/Role" 1221 } 1222 } 1223 } 1224 }, 1225 "default": { 1226 "description": "Error.", 1227 "content": { 1228 "application/json": { 1229 "schema": { 1230 "$ref": "#/components/schemas/Error" 1231 } 1232 } 1233 } 1234 } 1235 } 1236 }, 1237 "get": { 1238 "description": "Retrieves a list of roles.", 1239 "parameters": [ 1240 { 1241 "name": "page", 1242 "description": "Index of the requested page, where one corresponds to the first page.", 1243 "in": "query", 1244 "schema": { 1245 "type": "integer", 1246 "format": "int32" 1247 } 1248 }, 1249 { 1250 "name": "search", 1251 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the role\ninstead of the names of the columns of a table. For example, in order to\nretrieve roles named starting with `Organization`:\n\n```sql\nname like 'Organization%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 1252 "in": "query", 1253 "schema": { 1254 "type": "string" 1255 } 1256 }, 1257 { 1258 "name": "size", 1259 "description": "Maximum number of items that will be contained in the returned page.", 1260 "in": "query", 1261 "schema": { 1262 "type": "integer", 1263 "format": "int32" 1264 } 1265 } 1266 ], 1267 "responses": { 1268 "200": { 1269 "description": "Success.", 1270 "content": { 1271 "application/json": { 1272 "schema": { 1273 "type": "object", 1274 "properties": { 1275 "items": { 1276 "description": "Retrieved list of roles.", 1277 "type": "array", 1278 "items": { 1279 "$ref": "#/components/schemas/Role" 1280 } 1281 }, 1282 "page": { 1283 "description": "Index of the requested page, where one corresponds to the first page.", 1284 "type": "integer", 1285 "format": "int32" 1286 }, 1287 "size": { 1288 "description": "Maximum number of items that will be contained in the returned page.", 1289 "type": "integer", 1290 "format": "int32" 1291 }, 1292 "total": { 1293 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1294 "type": "integer", 1295 "format": "int32" 1296 } 1297 } 1298 } 1299 } 1300 } 1301 }, 1302 "default": { 1303 "description": "Error.", 1304 "content": { 1305 "application/json": { 1306 "schema": { 1307 "$ref": "#/components/schemas/Error" 1308 } 1309 } 1310 } 1311 } 1312 } 1313 } 1314 }, 1315 "/api/accounts_mgmt/v1/current_access/{role_id}": { 1316 "delete": { 1317 "description": "Deletes the role.", 1318 "parameters": [ 1319 { 1320 "name": "role_id", 1321 "in": "path", 1322 "schema": { 1323 "type": "string" 1324 }, 1325 "required": true 1326 } 1327 ], 1328 "responses": { 1329 "204": { 1330 "description": "Success." 1331 }, 1332 "default": { 1333 "description": "Error.", 1334 "content": { 1335 "application/json": { 1336 "schema": { 1337 "$ref": "#/components/schemas/Error" 1338 } 1339 } 1340 } 1341 } 1342 } 1343 }, 1344 "get": { 1345 "description": "Retrieves the details of the role.", 1346 "parameters": [ 1347 { 1348 "name": "role_id", 1349 "in": "path", 1350 "schema": { 1351 "type": "string" 1352 }, 1353 "required": true 1354 } 1355 ], 1356 "responses": { 1357 "200": { 1358 "description": "Success.", 1359 "content": { 1360 "application/json": { 1361 "schema": { 1362 "$ref": "#/components/schemas/Role" 1363 } 1364 } 1365 } 1366 }, 1367 "default": { 1368 "description": "Error.", 1369 "content": { 1370 "application/json": { 1371 "schema": { 1372 "$ref": "#/components/schemas/Error" 1373 } 1374 } 1375 } 1376 } 1377 } 1378 }, 1379 "patch": { 1380 "description": "Updates the role.", 1381 "parameters": [ 1382 { 1383 "name": "role_id", 1384 "in": "path", 1385 "schema": { 1386 "type": "string" 1387 }, 1388 "required": true 1389 } 1390 ], 1391 "requestBody": { 1392 "content": { 1393 "application/json": { 1394 "schema": { 1395 "$ref": "#/components/schemas/Role" 1396 } 1397 } 1398 } 1399 }, 1400 "responses": { 1401 "200": { 1402 "description": "Success.", 1403 "content": { 1404 "application/json": { 1405 "schema": { 1406 "$ref": "#/components/schemas/Role" 1407 } 1408 } 1409 } 1410 }, 1411 "default": { 1412 "description": "Error.", 1413 "content": { 1414 "application/json": { 1415 "schema": { 1416 "$ref": "#/components/schemas/Error" 1417 } 1418 } 1419 } 1420 } 1421 } 1422 } 1423 }, 1424 "/api/accounts_mgmt/v1/current_account": { 1425 "get": { 1426 "description": "Retrieves the details of the account.", 1427 "responses": { 1428 "200": { 1429 "description": "Success.", 1430 "content": { 1431 "application/json": { 1432 "schema": { 1433 "$ref": "#/components/schemas/Account" 1434 } 1435 } 1436 } 1437 }, 1438 "default": { 1439 "description": "Error.", 1440 "content": { 1441 "application/json": { 1442 "schema": { 1443 "$ref": "#/components/schemas/Error" 1444 } 1445 } 1446 } 1447 } 1448 } 1449 } 1450 }, 1451 "/api/accounts_mgmt/v1/default_capabilities": { 1452 "post": { 1453 "description": "Creates a new default capability.", 1454 "requestBody": { 1455 "content": { 1456 "application/json": { 1457 "schema": { 1458 "$ref": "#/components/schemas/DefaultCapability" 1459 } 1460 } 1461 } 1462 }, 1463 "responses": { 1464 "201": { 1465 "description": "Success.", 1466 "content": { 1467 "application/json": { 1468 "schema": { 1469 "$ref": "#/components/schemas/DefaultCapability" 1470 } 1471 } 1472 } 1473 }, 1474 "default": { 1475 "description": "Error.", 1476 "content": { 1477 "application/json": { 1478 "schema": { 1479 "$ref": "#/components/schemas/Error" 1480 } 1481 } 1482 } 1483 } 1484 } 1485 }, 1486 "get": { 1487 "description": "Retrieves a list of Dedfault Capabilities.", 1488 "parameters": [ 1489 { 1490 "name": "page", 1491 "description": "Index of the requested page, where one corresponds to the first page.", 1492 "in": "query", 1493 "schema": { 1494 "type": "integer", 1495 "format": "int32" 1496 } 1497 }, 1498 { 1499 "name": "search", 1500 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the organization\ninstead of the names of the columns of a table. For example, in order to\nretrieve organizations with name starting with my:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 1501 "in": "query", 1502 "schema": { 1503 "type": "string" 1504 } 1505 }, 1506 { 1507 "name": "size", 1508 "description": "Maximum number of items that will be contained in the returned page.", 1509 "in": "query", 1510 "schema": { 1511 "type": "integer", 1512 "format": "int32" 1513 } 1514 } 1515 ], 1516 "responses": { 1517 "200": { 1518 "description": "Success.", 1519 "content": { 1520 "application/json": { 1521 "schema": { 1522 "type": "object", 1523 "properties": { 1524 "items": { 1525 "description": "Retrieved list of Default Capabilities.", 1526 "type": "array", 1527 "items": { 1528 "$ref": "#/components/schemas/DefaultCapability" 1529 } 1530 }, 1531 "page": { 1532 "description": "Index of the requested page, where one corresponds to the first page.", 1533 "type": "integer", 1534 "format": "int32" 1535 }, 1536 "size": { 1537 "description": "Maximum number of items that will be contained in the returned page.", 1538 "type": "integer", 1539 "format": "int32" 1540 }, 1541 "total": { 1542 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1543 "type": "integer", 1544 "format": "int32" 1545 } 1546 } 1547 } 1548 } 1549 } 1550 }, 1551 "default": { 1552 "description": "Error.", 1553 "content": { 1554 "application/json": { 1555 "schema": { 1556 "$ref": "#/components/schemas/Error" 1557 } 1558 } 1559 } 1560 } 1561 } 1562 } 1563 }, 1564 "/api/accounts_mgmt/v1/default_capabilities/{default_capability_id}": { 1565 "delete": { 1566 "parameters": [ 1567 { 1568 "name": "default_capability_id", 1569 "in": "path", 1570 "schema": { 1571 "type": "string" 1572 }, 1573 "required": true 1574 } 1575 ], 1576 "responses": { 1577 "204": { 1578 "description": "Success." 1579 }, 1580 "default": { 1581 "description": "Error.", 1582 "content": { 1583 "application/json": { 1584 "schema": { 1585 "$ref": "#/components/schemas/Error" 1586 } 1587 } 1588 } 1589 } 1590 } 1591 }, 1592 "get": { 1593 "description": "Retrieves the details of the default capability.", 1594 "parameters": [ 1595 { 1596 "name": "default_capability_id", 1597 "in": "path", 1598 "schema": { 1599 "type": "string" 1600 }, 1601 "required": true 1602 } 1603 ], 1604 "responses": { 1605 "200": { 1606 "description": "Success.", 1607 "content": { 1608 "application/json": { 1609 "schema": { 1610 "$ref": "#/components/schemas/DefaultCapability" 1611 } 1612 } 1613 } 1614 }, 1615 "default": { 1616 "description": "Error.", 1617 "content": { 1618 "application/json": { 1619 "schema": { 1620 "$ref": "#/components/schemas/Error" 1621 } 1622 } 1623 } 1624 } 1625 } 1626 }, 1627 "patch": { 1628 "description": "Updates the default capability.", 1629 "parameters": [ 1630 { 1631 "name": "default_capability_id", 1632 "in": "path", 1633 "schema": { 1634 "type": "string" 1635 }, 1636 "required": true 1637 } 1638 ], 1639 "requestBody": { 1640 "content": { 1641 "application/json": { 1642 "schema": { 1643 "$ref": "#/components/schemas/DefaultCapability" 1644 } 1645 } 1646 } 1647 }, 1648 "responses": { 1649 "200": { 1650 "description": "Success.", 1651 "content": { 1652 "application/json": { 1653 "schema": { 1654 "$ref": "#/components/schemas/DefaultCapability" 1655 } 1656 } 1657 } 1658 }, 1659 "default": { 1660 "description": "Error.", 1661 "content": { 1662 "application/json": { 1663 "schema": { 1664 "$ref": "#/components/schemas/Error" 1665 } 1666 } 1667 } 1668 } 1669 } 1670 } 1671 }, 1672 "/api/accounts_mgmt/v1/deleted_subscriptions": { 1673 "get": { 1674 "description": "Retrieves a list of DeletedSubscriptions.", 1675 "parameters": [ 1676 { 1677 "name": "order", 1678 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement. For example, in order to sort the\nDeletedSubscriptions descending by name identifier the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 1679 "in": "query", 1680 "schema": { 1681 "type": "string" 1682 } 1683 }, 1684 { 1685 "name": "page", 1686 "description": "Index of the requested page, where one corresponds to the first page.", 1687 "in": "query", 1688 "schema": { 1689 "type": "integer", 1690 "format": "int32" 1691 } 1692 }, 1693 { 1694 "name": "search", 1695 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the DeletedSubscription instead\nof the names of the columns of a table. For example, in order to retrieve all the\nDeletedSubscriptions for managed clusters the value should be:\n\n```sql\nmanaged = 't'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nclusters that the user has permission to see will be returned.", 1696 "in": "query", 1697 "schema": { 1698 "type": "string" 1699 } 1700 }, 1701 { 1702 "name": "size", 1703 "description": "Maximum number of items that will be contained in the returned page.", 1704 "in": "query", 1705 "schema": { 1706 "type": "integer", 1707 "format": "int32" 1708 } 1709 } 1710 ], 1711 "responses": { 1712 "200": { 1713 "description": "Success.", 1714 "content": { 1715 "application/json": { 1716 "schema": { 1717 "type": "object", 1718 "properties": { 1719 "items": { 1720 "description": "Retrieved list of DeletedSubscriptions.", 1721 "type": "array", 1722 "items": { 1723 "$ref": "#/components/schemas/DeletedSubscription" 1724 } 1725 }, 1726 "page": { 1727 "description": "Index of the requested page, where one corresponds to the first page.", 1728 "type": "integer", 1729 "format": "int32" 1730 }, 1731 "size": { 1732 "description": "Maximum number of items that will be contained in the returned page.", 1733 "type": "integer", 1734 "format": "int32" 1735 }, 1736 "total": { 1737 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1738 "type": "integer", 1739 "format": "int32" 1740 } 1741 } 1742 } 1743 } 1744 } 1745 }, 1746 "default": { 1747 "description": "Error.", 1748 "content": { 1749 "application/json": { 1750 "schema": { 1751 "$ref": "#/components/schemas/Error" 1752 } 1753 } 1754 } 1755 } 1756 } 1757 } 1758 }, 1759 "/api/accounts_mgmt/v1/feature_toggles/{feature_toggle_id}/query": { 1760 "post": { 1761 "description": "Retrieves the details of the feature toggle by providing query context", 1762 "parameters": [ 1763 { 1764 "name": "feature_toggle_id", 1765 "in": "path", 1766 "schema": { 1767 "type": "string" 1768 }, 1769 "required": true 1770 } 1771 ], 1772 "requestBody": { 1773 "content": { 1774 "application/json": { 1775 "schema": { 1776 "$ref": "#/components/schemas/FeatureToggleQueryRequest" 1777 } 1778 } 1779 } 1780 }, 1781 "responses": { 1782 "201": { 1783 "description": "Success.", 1784 "content": { 1785 "application/json": { 1786 "schema": { 1787 "$ref": "#/components/schemas/FeatureToggle" 1788 } 1789 } 1790 } 1791 }, 1792 "default": { 1793 "description": "Error.", 1794 "content": { 1795 "application/json": { 1796 "schema": { 1797 "$ref": "#/components/schemas/Error" 1798 } 1799 } 1800 } 1801 } 1802 } 1803 } 1804 }, 1805 "/api/accounts_mgmt/v1/labels": { 1806 "get": { 1807 "description": "Retrieves a list of labels.", 1808 "parameters": [ 1809 { 1810 "name": "page", 1811 "description": "Index of the requested page, where one corresponds to the first page.", 1812 "in": "query", 1813 "schema": { 1814 "type": "integer", 1815 "format": "int32" 1816 } 1817 }, 1818 { 1819 "name": "search", 1820 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the organization\ninstead of the names of the columns of a table. For example, in order to\nretrieve labels with name starting with my:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 1821 "in": "query", 1822 "schema": { 1823 "type": "string" 1824 } 1825 }, 1826 { 1827 "name": "size", 1828 "description": "Maximum number of items that will be contained in the returned page.", 1829 "in": "query", 1830 "schema": { 1831 "type": "integer", 1832 "format": "int32" 1833 } 1834 } 1835 ], 1836 "responses": { 1837 "200": { 1838 "description": "Success.", 1839 "content": { 1840 "application/json": { 1841 "schema": { 1842 "type": "object", 1843 "properties": { 1844 "items": { 1845 "description": "Retrieved list of labels.", 1846 "type": "array", 1847 "items": { 1848 "$ref": "#/components/schemas/Label" 1849 } 1850 }, 1851 "page": { 1852 "description": "Index of the requested page, where one corresponds to the first page.", 1853 "type": "integer", 1854 "format": "int32" 1855 }, 1856 "size": { 1857 "description": "Maximum number of items that will be contained in the returned page.", 1858 "type": "integer", 1859 "format": "int32" 1860 }, 1861 "total": { 1862 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 1863 "type": "integer", 1864 "format": "int32" 1865 } 1866 } 1867 } 1868 } 1869 } 1870 }, 1871 "default": { 1872 "description": "Error.", 1873 "content": { 1874 "application/json": { 1875 "schema": { 1876 "$ref": "#/components/schemas/Error" 1877 } 1878 } 1879 } 1880 } 1881 } 1882 } 1883 }, 1884 "/api/accounts_mgmt/v1/notify_details": { 1885 "post": { 1886 "description": "Post Notification details about user related to subscription/cluster via email and get the data associated with it.", 1887 "requestBody": { 1888 "content": { 1889 "application/json": { 1890 "schema": { 1891 "$ref": "#/components/schemas/NotificationDetailsRequest" 1892 } 1893 } 1894 } 1895 }, 1896 "responses": { 1897 "201": { 1898 "description": "Success.", 1899 "content": { 1900 "application/json": { 1901 "schema": { 1902 "$ref": "#/components/schemas/GenericNotifyDetailsResponse" 1903 } 1904 } 1905 } 1906 }, 1907 "default": { 1908 "description": "Error.", 1909 "content": { 1910 "application/json": { 1911 "schema": { 1912 "$ref": "#/components/schemas/Error" 1913 } 1914 } 1915 } 1916 } 1917 } 1918 } 1919 }, 1920 "/api/accounts_mgmt/v1/organizations": { 1921 "post": { 1922 "description": "Creates a new organization.", 1923 "requestBody": { 1924 "content": { 1925 "application/json": { 1926 "schema": { 1927 "$ref": "#/components/schemas/Organization" 1928 } 1929 } 1930 } 1931 }, 1932 "responses": { 1933 "201": { 1934 "description": "Success.", 1935 "content": { 1936 "application/json": { 1937 "schema": { 1938 "$ref": "#/components/schemas/Organization" 1939 } 1940 } 1941 } 1942 }, 1943 "default": { 1944 "description": "Error.", 1945 "content": { 1946 "application/json": { 1947 "schema": { 1948 "$ref": "#/components/schemas/Error" 1949 } 1950 } 1951 } 1952 } 1953 } 1954 }, 1955 "get": { 1956 "description": "Retrieves a list of organizations.", 1957 "parameters": [ 1958 { 1959 "name": "fetchLabels", 1960 "description": "If true, includes the labels on an organization in the output. Could slow request response time.", 1961 "in": "query", 1962 "schema": { 1963 "type": "boolean" 1964 } 1965 }, 1966 { 1967 "name": "fields", 1968 "description": "Projection\nThis field contains a comma-separated list of fields you'd like to get in\na result. No new fields can be added, only existing ones can be filtered.\nTo specify a field 'id' of a structure 'plan' use 'plan.id'.\nTo specify all fields of a structure 'labels' use 'labels.*'.\n", 1969 "in": "query", 1970 "schema": { 1971 "type": "string" 1972 } 1973 }, 1974 { 1975 "name": "page", 1976 "description": "Index of the requested page, where one corresponds to the first page.", 1977 "in": "query", 1978 "schema": { 1979 "type": "integer", 1980 "format": "int32" 1981 } 1982 }, 1983 { 1984 "name": "search", 1985 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the organization\ninstead of the names of the columns of a table. For example, in order to\nretrieve organizations with name starting with my:\n\n```sql\nname like 'my%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 1986 "in": "query", 1987 "schema": { 1988 "type": "string" 1989 } 1990 }, 1991 { 1992 "name": "size", 1993 "description": "Maximum number of items that will be contained in the returned page.", 1994 "in": "query", 1995 "schema": { 1996 "type": "integer", 1997 "format": "int32" 1998 } 1999 } 2000 ], 2001 "responses": { 2002 "200": { 2003 "description": "Success.", 2004 "content": { 2005 "application/json": { 2006 "schema": { 2007 "type": "object", 2008 "properties": { 2009 "items": { 2010 "description": "Retrieved list of organizations.", 2011 "type": "array", 2012 "items": { 2013 "$ref": "#/components/schemas/Organization" 2014 } 2015 }, 2016 "page": { 2017 "description": "Index of the requested page, where one corresponds to the first page.", 2018 "type": "integer", 2019 "format": "int32" 2020 }, 2021 "size": { 2022 "description": "Maximum number of items that will be contained in the returned page.", 2023 "type": "integer", 2024 "format": "int32" 2025 }, 2026 "total": { 2027 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 2028 "type": "integer", 2029 "format": "int32" 2030 } 2031 } 2032 } 2033 } 2034 } 2035 }, 2036 "default": { 2037 "description": "Error.", 2038 "content": { 2039 "application/json": { 2040 "schema": { 2041 "$ref": "#/components/schemas/Error" 2042 } 2043 } 2044 } 2045 } 2046 } 2047 } 2048 }, 2049 "/api/accounts_mgmt/v1/organizations/{organization_id}": { 2050 "get": { 2051 "description": "Retrieves the details of the organization.", 2052 "parameters": [ 2053 { 2054 "name": "organization_id", 2055 "in": "path", 2056 "schema": { 2057 "type": "string" 2058 }, 2059 "required": true 2060 } 2061 ], 2062 "responses": { 2063 "200": { 2064 "description": "Success.", 2065 "content": { 2066 "application/json": { 2067 "schema": { 2068 "$ref": "#/components/schemas/Organization" 2069 } 2070 } 2071 } 2072 }, 2073 "default": { 2074 "description": "Error.", 2075 "content": { 2076 "application/json": { 2077 "schema": { 2078 "$ref": "#/components/schemas/Error" 2079 } 2080 } 2081 } 2082 } 2083 } 2084 }, 2085 "patch": { 2086 "description": "Updates the organization.", 2087 "parameters": [ 2088 { 2089 "name": "organization_id", 2090 "in": "path", 2091 "schema": { 2092 "type": "string" 2093 }, 2094 "required": true 2095 } 2096 ], 2097 "requestBody": { 2098 "content": { 2099 "application/json": { 2100 "schema": { 2101 "$ref": "#/components/schemas/Organization" 2102 } 2103 } 2104 } 2105 }, 2106 "responses": { 2107 "200": { 2108 "description": "Success.", 2109 "content": { 2110 "application/json": { 2111 "schema": { 2112 "$ref": "#/components/schemas/Organization" 2113 } 2114 } 2115 } 2116 }, 2117 "default": { 2118 "description": "Error.", 2119 "content": { 2120 "application/json": { 2121 "schema": { 2122 "$ref": "#/components/schemas/Error" 2123 } 2124 } 2125 } 2126 } 2127 } 2128 } 2129 }, 2130 "/api/accounts_mgmt/v1/organizations/{organization_id}/labels": { 2131 "post": { 2132 "description": "Create a new account/organization/subscription label.", 2133 "parameters": [ 2134 { 2135 "name": "organization_id", 2136 "in": "path", 2137 "schema": { 2138 "type": "string" 2139 }, 2140 "required": true 2141 } 2142 ], 2143 "requestBody": { 2144 "content": { 2145 "application/json": { 2146 "schema": { 2147 "$ref": "#/components/schemas/Label" 2148 } 2149 } 2150 } 2151 }, 2152 "responses": { 2153 "201": { 2154 "description": "Success.", 2155 "content": { 2156 "application/json": { 2157 "schema": { 2158 "$ref": "#/components/schemas/Label" 2159 } 2160 } 2161 } 2162 }, 2163 "default": { 2164 "description": "Error.", 2165 "content": { 2166 "application/json": { 2167 "schema": { 2168 "$ref": "#/components/schemas/Error" 2169 } 2170 } 2171 } 2172 } 2173 } 2174 }, 2175 "get": { 2176 "description": "Retrieves the list of labels of the account/organization/subscription.\n\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of labels\nof the account/organization/subscription.", 2177 "parameters": [ 2178 { 2179 "name": "organization_id", 2180 "in": "path", 2181 "schema": { 2182 "type": "string" 2183 }, 2184 "required": true 2185 }, 2186 { 2187 "name": "page", 2188 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 2189 "in": "query", 2190 "schema": { 2191 "type": "integer", 2192 "format": "int32" 2193 } 2194 }, 2195 { 2196 "name": "size", 2197 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nlabels of the account/organization/subscription.", 2198 "in": "query", 2199 "schema": { 2200 "type": "integer", 2201 "format": "int32" 2202 } 2203 } 2204 ], 2205 "responses": { 2206 "200": { 2207 "description": "Success.", 2208 "content": { 2209 "application/json": { 2210 "schema": { 2211 "type": "object", 2212 "properties": { 2213 "items": { 2214 "description": "Retrieved list of cloud providers.", 2215 "type": "array", 2216 "items": { 2217 "$ref": "#/components/schemas/Label" 2218 } 2219 }, 2220 "page": { 2221 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 2222 "type": "integer", 2223 "format": "int32" 2224 }, 2225 "size": { 2226 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nlabels of the account/organization/subscription.", 2227 "type": "integer", 2228 "format": "int32" 2229 }, 2230 "total": { 2231 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of labels of the account/organization/subscription.", 2232 "type": "integer", 2233 "format": "int32" 2234 } 2235 } 2236 } 2237 } 2238 } 2239 }, 2240 "default": { 2241 "description": "Error.", 2242 "content": { 2243 "application/json": { 2244 "schema": { 2245 "$ref": "#/components/schemas/Error" 2246 } 2247 } 2248 } 2249 } 2250 } 2251 } 2252 }, 2253 "/api/accounts_mgmt/v1/organizations/{organization_id}/labels/{label_id}": { 2254 "delete": { 2255 "description": "Deletes the account label.", 2256 "parameters": [ 2257 { 2258 "name": "organization_id", 2259 "in": "path", 2260 "schema": { 2261 "type": "string" 2262 }, 2263 "required": true 2264 }, 2265 { 2266 "name": "label_id", 2267 "in": "path", 2268 "schema": { 2269 "type": "string" 2270 }, 2271 "required": true 2272 } 2273 ], 2274 "responses": { 2275 "204": { 2276 "description": "Success." 2277 }, 2278 "default": { 2279 "description": "Error.", 2280 "content": { 2281 "application/json": { 2282 "schema": { 2283 "$ref": "#/components/schemas/Error" 2284 } 2285 } 2286 } 2287 } 2288 } 2289 }, 2290 "get": { 2291 "description": "Retrieves the details of the label.", 2292 "parameters": [ 2293 { 2294 "name": "organization_id", 2295 "in": "path", 2296 "schema": { 2297 "type": "string" 2298 }, 2299 "required": true 2300 }, 2301 { 2302 "name": "label_id", 2303 "in": "path", 2304 "schema": { 2305 "type": "string" 2306 }, 2307 "required": true 2308 } 2309 ], 2310 "responses": { 2311 "200": { 2312 "description": "Success.", 2313 "content": { 2314 "application/json": { 2315 "schema": { 2316 "$ref": "#/components/schemas/Label" 2317 } 2318 } 2319 } 2320 }, 2321 "default": { 2322 "description": "Error.", 2323 "content": { 2324 "application/json": { 2325 "schema": { 2326 "$ref": "#/components/schemas/Error" 2327 } 2328 } 2329 } 2330 } 2331 } 2332 }, 2333 "patch": { 2334 "description": "Updates the account label.", 2335 "parameters": [ 2336 { 2337 "name": "organization_id", 2338 "in": "path", 2339 "schema": { 2340 "type": "string" 2341 }, 2342 "required": true 2343 }, 2344 { 2345 "name": "label_id", 2346 "in": "path", 2347 "schema": { 2348 "type": "string" 2349 }, 2350 "required": true 2351 } 2352 ], 2353 "requestBody": { 2354 "content": { 2355 "application/json": { 2356 "schema": { 2357 "$ref": "#/components/schemas/Label" 2358 } 2359 } 2360 } 2361 }, 2362 "responses": { 2363 "200": { 2364 "description": "Success.", 2365 "content": { 2366 "application/json": { 2367 "schema": { 2368 "$ref": "#/components/schemas/Label" 2369 } 2370 } 2371 } 2372 }, 2373 "default": { 2374 "description": "Error.", 2375 "content": { 2376 "application/json": { 2377 "schema": { 2378 "$ref": "#/components/schemas/Error" 2379 } 2380 } 2381 } 2382 } 2383 } 2384 } 2385 }, 2386 "/api/accounts_mgmt/v1/organizations/{organization_id}/labels/{labels_id}": { 2387 "delete": { 2388 "description": "Deletes the account label.", 2389 "parameters": [ 2390 { 2391 "name": "organization_id", 2392 "in": "path", 2393 "schema": { 2394 "type": "string" 2395 }, 2396 "required": true 2397 }, 2398 { 2399 "name": "labels_id", 2400 "in": "path", 2401 "schema": { 2402 "type": "string" 2403 }, 2404 "required": true 2405 } 2406 ], 2407 "responses": { 2408 "204": { 2409 "description": "Success." 2410 }, 2411 "default": { 2412 "description": "Error.", 2413 "content": { 2414 "application/json": { 2415 "schema": { 2416 "$ref": "#/components/schemas/Error" 2417 } 2418 } 2419 } 2420 } 2421 } 2422 }, 2423 "get": { 2424 "description": "Retrieves the details of the label.", 2425 "parameters": [ 2426 { 2427 "name": "organization_id", 2428 "in": "path", 2429 "schema": { 2430 "type": "string" 2431 }, 2432 "required": true 2433 }, 2434 { 2435 "name": "labels_id", 2436 "in": "path", 2437 "schema": { 2438 "type": "string" 2439 }, 2440 "required": true 2441 } 2442 ], 2443 "responses": { 2444 "200": { 2445 "description": "Success.", 2446 "content": { 2447 "application/json": { 2448 "schema": { 2449 "$ref": "#/components/schemas/Label" 2450 } 2451 } 2452 } 2453 }, 2454 "default": { 2455 "description": "Error.", 2456 "content": { 2457 "application/json": { 2458 "schema": { 2459 "$ref": "#/components/schemas/Error" 2460 } 2461 } 2462 } 2463 } 2464 } 2465 }, 2466 "patch": { 2467 "description": "Updates the account label.", 2468 "parameters": [ 2469 { 2470 "name": "organization_id", 2471 "in": "path", 2472 "schema": { 2473 "type": "string" 2474 }, 2475 "required": true 2476 }, 2477 { 2478 "name": "labels_id", 2479 "in": "path", 2480 "schema": { 2481 "type": "string" 2482 }, 2483 "required": true 2484 } 2485 ], 2486 "requestBody": { 2487 "content": { 2488 "application/json": { 2489 "schema": { 2490 "$ref": "#/components/schemas/Label" 2491 } 2492 } 2493 } 2494 }, 2495 "responses": { 2496 "200": { 2497 "description": "Success.", 2498 "content": { 2499 "application/json": { 2500 "schema": { 2501 "$ref": "#/components/schemas/Label" 2502 } 2503 } 2504 } 2505 }, 2506 "default": { 2507 "description": "Error.", 2508 "content": { 2509 "application/json": { 2510 "schema": { 2511 "$ref": "#/components/schemas/Error" 2512 } 2513 } 2514 } 2515 } 2516 } 2517 } 2518 }, 2519 "/api/accounts_mgmt/v1/organizations/{organization_id}/quota_cost": { 2520 "get": { 2521 "description": "Retrieves the quota cost.", 2522 "parameters": [ 2523 { 2524 "name": "organization_id", 2525 "in": "path", 2526 "schema": { 2527 "type": "string" 2528 }, 2529 "required": true 2530 }, 2531 { 2532 "name": "page", 2533 "description": "Index of the requested page, where one corresponds to the first page.", 2534 "in": "query", 2535 "schema": { 2536 "type": "integer", 2537 "format": "int32" 2538 } 2539 }, 2540 { 2541 "name": "search", 2542 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the quota\ncost instead of the names of the columns of a table. For example, in order\nto retrieve the quota cost for all add-ons:\n\n```sql\nquota_id LIKE 'add-on%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 2543 "in": "query", 2544 "schema": { 2545 "type": "string" 2546 } 2547 }, 2548 { 2549 "name": "size", 2550 "description": "Maximum number of items that will be contained in the returned page.", 2551 "in": "query", 2552 "schema": { 2553 "type": "integer", 2554 "format": "int32" 2555 } 2556 } 2557 ], 2558 "responses": { 2559 "200": { 2560 "description": "Success.", 2561 "content": { 2562 "application/json": { 2563 "schema": { 2564 "type": "object", 2565 "properties": { 2566 "items": { 2567 "description": "Retrieved quota cost items.", 2568 "type": "array", 2569 "items": { 2570 "$ref": "#/components/schemas/QuotaCost" 2571 } 2572 }, 2573 "page": { 2574 "description": "Index of the requested page, where one corresponds to the first page.", 2575 "type": "integer", 2576 "format": "int32" 2577 }, 2578 "size": { 2579 "description": "Maximum number of items that will be contained in the returned page.", 2580 "type": "integer", 2581 "format": "int32" 2582 }, 2583 "total": { 2584 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 2585 "type": "integer", 2586 "format": "int32" 2587 } 2588 } 2589 } 2590 } 2591 } 2592 }, 2593 "default": { 2594 "description": "Error.", 2595 "content": { 2596 "application/json": { 2597 "schema": { 2598 "$ref": "#/components/schemas/Error" 2599 } 2600 } 2601 } 2602 } 2603 } 2604 } 2605 }, 2606 "/api/accounts_mgmt/v1/organizations/{organization_id}/resource_quota": { 2607 "post": { 2608 "description": "Creates a new resource quota.", 2609 "parameters": [ 2610 { 2611 "name": "organization_id", 2612 "in": "path", 2613 "schema": { 2614 "type": "string" 2615 }, 2616 "required": true 2617 } 2618 ], 2619 "requestBody": { 2620 "content": { 2621 "application/json": { 2622 "schema": { 2623 "$ref": "#/components/schemas/ResourceQuota" 2624 } 2625 } 2626 } 2627 }, 2628 "responses": { 2629 "201": { 2630 "description": "Success.", 2631 "content": { 2632 "application/json": { 2633 "schema": { 2634 "$ref": "#/components/schemas/ResourceQuota" 2635 } 2636 } 2637 } 2638 }, 2639 "default": { 2640 "description": "Error.", 2641 "content": { 2642 "application/json": { 2643 "schema": { 2644 "$ref": "#/components/schemas/Error" 2645 } 2646 } 2647 } 2648 } 2649 } 2650 }, 2651 "get": { 2652 "description": "Retrieves the list of resource quotas.", 2653 "parameters": [ 2654 { 2655 "name": "organization_id", 2656 "in": "path", 2657 "schema": { 2658 "type": "string" 2659 }, 2660 "required": true 2661 }, 2662 { 2663 "name": "page", 2664 "description": "Index of the requested page, where one corresponds to the first page.", 2665 "in": "query", 2666 "schema": { 2667 "type": "integer", 2668 "format": "int32" 2669 } 2670 }, 2671 { 2672 "name": "search", 2673 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the account\ninstead of the names of the columns of a table. For example, in order to\nretrieve resource quota with resource_type cluster.aws:\n\n```sql\nresource_type = 'cluster.aws'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 2674 "in": "query", 2675 "schema": { 2676 "type": "string" 2677 } 2678 }, 2679 { 2680 "name": "size", 2681 "description": "Maximum number of items that will be contained in the returned page.", 2682 "in": "query", 2683 "schema": { 2684 "type": "integer", 2685 "format": "int32" 2686 } 2687 } 2688 ], 2689 "responses": { 2690 "200": { 2691 "description": "Success.", 2692 "content": { 2693 "application/json": { 2694 "schema": { 2695 "type": "object", 2696 "properties": { 2697 "items": { 2698 "description": "Retrieved list of resource quotas.", 2699 "type": "array", 2700 "items": { 2701 "$ref": "#/components/schemas/ResourceQuota" 2702 } 2703 }, 2704 "page": { 2705 "description": "Index of the requested page, where one corresponds to the first page.", 2706 "type": "integer", 2707 "format": "int32" 2708 }, 2709 "size": { 2710 "description": "Maximum number of items that will be contained in the returned page.", 2711 "type": "integer", 2712 "format": "int32" 2713 }, 2714 "total": { 2715 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 2716 "type": "integer", 2717 "format": "int32" 2718 } 2719 } 2720 } 2721 } 2722 } 2723 }, 2724 "default": { 2725 "description": "Error.", 2726 "content": { 2727 "application/json": { 2728 "schema": { 2729 "$ref": "#/components/schemas/Error" 2730 } 2731 } 2732 } 2733 } 2734 } 2735 } 2736 }, 2737 "/api/accounts_mgmt/v1/organizations/{organization_id}/resource_quota/{resource_quota_id}": { 2738 "delete": { 2739 "description": "Deletes the resource quota.", 2740 "parameters": [ 2741 { 2742 "name": "organization_id", 2743 "in": "path", 2744 "schema": { 2745 "type": "string" 2746 }, 2747 "required": true 2748 }, 2749 { 2750 "name": "resource_quota_id", 2751 "in": "path", 2752 "schema": { 2753 "type": "string" 2754 }, 2755 "required": true 2756 } 2757 ], 2758 "responses": { 2759 "204": { 2760 "description": "Success." 2761 }, 2762 "default": { 2763 "description": "Error.", 2764 "content": { 2765 "application/json": { 2766 "schema": { 2767 "$ref": "#/components/schemas/Error" 2768 } 2769 } 2770 } 2771 } 2772 } 2773 }, 2774 "get": { 2775 "description": "Retrieves the details of the resource quota.", 2776 "parameters": [ 2777 { 2778 "name": "organization_id", 2779 "in": "path", 2780 "schema": { 2781 "type": "string" 2782 }, 2783 "required": true 2784 }, 2785 { 2786 "name": "resource_quota_id", 2787 "in": "path", 2788 "schema": { 2789 "type": "string" 2790 }, 2791 "required": true 2792 } 2793 ], 2794 "responses": { 2795 "200": { 2796 "description": "Success.", 2797 "content": { 2798 "application/json": { 2799 "schema": { 2800 "$ref": "#/components/schemas/ResourceQuota" 2801 } 2802 } 2803 } 2804 }, 2805 "default": { 2806 "description": "Error.", 2807 "content": { 2808 "application/json": { 2809 "schema": { 2810 "$ref": "#/components/schemas/Error" 2811 } 2812 } 2813 } 2814 } 2815 } 2816 }, 2817 "patch": { 2818 "description": "Updates the resource quota.", 2819 "parameters": [ 2820 { 2821 "name": "organization_id", 2822 "in": "path", 2823 "schema": { 2824 "type": "string" 2825 }, 2826 "required": true 2827 }, 2828 { 2829 "name": "resource_quota_id", 2830 "in": "path", 2831 "schema": { 2832 "type": "string" 2833 }, 2834 "required": true 2835 } 2836 ], 2837 "requestBody": { 2838 "content": { 2839 "application/json": { 2840 "schema": { 2841 "$ref": "#/components/schemas/ResourceQuota" 2842 } 2843 } 2844 } 2845 }, 2846 "responses": { 2847 "200": { 2848 "description": "Success.", 2849 "content": { 2850 "application/json": { 2851 "schema": { 2852 "$ref": "#/components/schemas/ResourceQuota" 2853 } 2854 } 2855 } 2856 }, 2857 "default": { 2858 "description": "Error.", 2859 "content": { 2860 "application/json": { 2861 "schema": { 2862 "$ref": "#/components/schemas/Error" 2863 } 2864 } 2865 } 2866 } 2867 } 2868 } 2869 }, 2870 "/api/accounts_mgmt/v1/organizations/{organization_id}/summary_dashboard": { 2871 "get": { 2872 "description": "Retrieves the details of the organization's summary dashboard.", 2873 "parameters": [ 2874 { 2875 "name": "organization_id", 2876 "in": "path", 2877 "schema": { 2878 "type": "string" 2879 }, 2880 "required": true 2881 } 2882 ], 2883 "responses": { 2884 "200": { 2885 "description": "Success.", 2886 "content": { 2887 "application/json": { 2888 "schema": { 2889 "$ref": "#/components/schemas/SummaryDashboard" 2890 } 2891 } 2892 } 2893 }, 2894 "default": { 2895 "description": "Error.", 2896 "content": { 2897 "application/json": { 2898 "schema": { 2899 "$ref": "#/components/schemas/Error" 2900 } 2901 } 2902 } 2903 } 2904 } 2905 } 2906 }, 2907 "/api/accounts_mgmt/v1/permissions": { 2908 "post": { 2909 "description": "Creates a new permission.", 2910 "requestBody": { 2911 "content": { 2912 "application/json": { 2913 "schema": { 2914 "$ref": "#/components/schemas/Permission" 2915 } 2916 } 2917 } 2918 }, 2919 "responses": { 2920 "201": { 2921 "description": "Success.", 2922 "content": { 2923 "application/json": { 2924 "schema": { 2925 "$ref": "#/components/schemas/Permission" 2926 } 2927 } 2928 } 2929 }, 2930 "default": { 2931 "description": "Error.", 2932 "content": { 2933 "application/json": { 2934 "schema": { 2935 "$ref": "#/components/schemas/Error" 2936 } 2937 } 2938 } 2939 } 2940 } 2941 }, 2942 "get": { 2943 "description": "Retrieves a list of permissions.", 2944 "parameters": [ 2945 { 2946 "name": "page", 2947 "description": "Index of the requested page, where one corresponds to the first page.", 2948 "in": "query", 2949 "schema": { 2950 "type": "integer", 2951 "format": "int32" 2952 } 2953 }, 2954 { 2955 "name": "size", 2956 "description": "Maximum number of items that will be contained in the returned page.", 2957 "in": "query", 2958 "schema": { 2959 "type": "integer", 2960 "format": "int32" 2961 } 2962 } 2963 ], 2964 "responses": { 2965 "200": { 2966 "description": "Success.", 2967 "content": { 2968 "application/json": { 2969 "schema": { 2970 "type": "object", 2971 "properties": { 2972 "items": { 2973 "description": "Retrieved list of permissions.", 2974 "type": "array", 2975 "items": { 2976 "$ref": "#/components/schemas/Permission" 2977 } 2978 }, 2979 "page": { 2980 "description": "Index of the requested page, where one corresponds to the first page.", 2981 "type": "integer", 2982 "format": "int32" 2983 }, 2984 "size": { 2985 "description": "Maximum number of items that will be contained in the returned page.", 2986 "type": "integer", 2987 "format": "int32" 2988 }, 2989 "total": { 2990 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 2991 "type": "integer", 2992 "format": "int32" 2993 } 2994 } 2995 } 2996 } 2997 } 2998 }, 2999 "default": { 3000 "description": "Error.", 3001 "content": { 3002 "application/json": { 3003 "schema": { 3004 "$ref": "#/components/schemas/Error" 3005 } 3006 } 3007 } 3008 } 3009 } 3010 } 3011 }, 3012 "/api/accounts_mgmt/v1/permissions/{permission_id}": { 3013 "delete": { 3014 "description": "Deletes the permission.", 3015 "parameters": [ 3016 { 3017 "name": "permission_id", 3018 "in": "path", 3019 "schema": { 3020 "type": "string" 3021 }, 3022 "required": true 3023 } 3024 ], 3025 "responses": { 3026 "204": { 3027 "description": "Success." 3028 }, 3029 "default": { 3030 "description": "Error.", 3031 "content": { 3032 "application/json": { 3033 "schema": { 3034 "$ref": "#/components/schemas/Error" 3035 } 3036 } 3037 } 3038 } 3039 } 3040 }, 3041 "get": { 3042 "description": "Retrieves the details of the permission.", 3043 "parameters": [ 3044 { 3045 "name": "permission_id", 3046 "in": "path", 3047 "schema": { 3048 "type": "string" 3049 }, 3050 "required": true 3051 } 3052 ], 3053 "responses": { 3054 "200": { 3055 "description": "Success.", 3056 "content": { 3057 "application/json": { 3058 "schema": { 3059 "$ref": "#/components/schemas/Permission" 3060 } 3061 } 3062 } 3063 }, 3064 "default": { 3065 "description": "Error.", 3066 "content": { 3067 "application/json": { 3068 "schema": { 3069 "$ref": "#/components/schemas/Error" 3070 } 3071 } 3072 } 3073 } 3074 } 3075 } 3076 }, 3077 "/api/accounts_mgmt/v1/pull_secrets": { 3078 "post": { 3079 "description": "Returns access token generated from registries in docker format.", 3080 "requestBody": { 3081 "content": { 3082 "application/json": { 3083 "schema": { 3084 "$ref": "#/components/schemas/PullSecretsRequest" 3085 } 3086 } 3087 } 3088 }, 3089 "responses": { 3090 "201": { 3091 "description": "Success.", 3092 "content": { 3093 "application/json": { 3094 "schema": { 3095 "$ref": "#/components/schemas/AccessToken" 3096 } 3097 } 3098 } 3099 }, 3100 "default": { 3101 "description": "Error.", 3102 "content": { 3103 "application/json": { 3104 "schema": { 3105 "$ref": "#/components/schemas/Error" 3106 } 3107 } 3108 } 3109 } 3110 } 3111 } 3112 }, 3113 "/api/accounts_mgmt/v1/pull_secrets/{pull_secret_id}": { 3114 "delete": { 3115 "description": "Deletes the pull secret.", 3116 "parameters": [ 3117 { 3118 "name": "pull_secret_id", 3119 "in": "path", 3120 "schema": { 3121 "type": "string" 3122 }, 3123 "required": true 3124 } 3125 ], 3126 "responses": { 3127 "204": { 3128 "description": "Success." 3129 }, 3130 "default": { 3131 "description": "Error.", 3132 "content": { 3133 "application/json": { 3134 "schema": { 3135 "$ref": "#/components/schemas/Error" 3136 } 3137 } 3138 } 3139 } 3140 } 3141 } 3142 }, 3143 "/api/accounts_mgmt/v1/quota_authorizations": { 3144 "post": { 3145 "description": "Authorizes new quota creation against an existing subscription.", 3146 "requestBody": { 3147 "content": { 3148 "application/json": { 3149 "schema": { 3150 "$ref": "#/components/schemas/QuotaAuthorizationRequest" 3151 } 3152 } 3153 } 3154 }, 3155 "responses": { 3156 "201": { 3157 "description": "Success.", 3158 "content": { 3159 "application/json": { 3160 "schema": { 3161 "$ref": "#/components/schemas/QuotaAuthorizationResponse" 3162 } 3163 } 3164 } 3165 }, 3166 "default": { 3167 "description": "Error.", 3168 "content": { 3169 "application/json": { 3170 "schema": { 3171 "$ref": "#/components/schemas/Error" 3172 } 3173 } 3174 } 3175 } 3176 } 3177 } 3178 }, 3179 "/api/accounts_mgmt/v1/registries": { 3180 "get": { 3181 "description": "Retrieves a list of registries.", 3182 "parameters": [ 3183 { 3184 "name": "page", 3185 "description": "Index of the requested page, where one corresponds to the first page.", 3186 "in": "query", 3187 "schema": { 3188 "type": "integer", 3189 "format": "int32" 3190 } 3191 }, 3192 { 3193 "name": "size", 3194 "description": "Maximum number of items that will be contained in the returned page.", 3195 "in": "query", 3196 "schema": { 3197 "type": "integer", 3198 "format": "int32" 3199 } 3200 } 3201 ], 3202 "responses": { 3203 "200": { 3204 "description": "Success.", 3205 "content": { 3206 "application/json": { 3207 "schema": { 3208 "type": "object", 3209 "properties": { 3210 "items": { 3211 "description": "Retrieved list of registries.", 3212 "type": "array", 3213 "items": { 3214 "$ref": "#/components/schemas/Registry" 3215 } 3216 }, 3217 "page": { 3218 "description": "Index of the requested page, where one corresponds to the first page.", 3219 "type": "integer", 3220 "format": "int32" 3221 }, 3222 "size": { 3223 "description": "Maximum number of items that will be contained in the returned page.", 3224 "type": "integer", 3225 "format": "int32" 3226 }, 3227 "total": { 3228 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 3229 "type": "integer", 3230 "format": "int32" 3231 } 3232 } 3233 } 3234 } 3235 } 3236 }, 3237 "default": { 3238 "description": "Error.", 3239 "content": { 3240 "application/json": { 3241 "schema": { 3242 "$ref": "#/components/schemas/Error" 3243 } 3244 } 3245 } 3246 } 3247 } 3248 } 3249 }, 3250 "/api/accounts_mgmt/v1/registries/{registry_id}": { 3251 "get": { 3252 "description": "Retrieves the details of the registry.", 3253 "parameters": [ 3254 { 3255 "name": "registry_id", 3256 "in": "path", 3257 "schema": { 3258 "type": "string" 3259 }, 3260 "required": true 3261 } 3262 ], 3263 "responses": { 3264 "200": { 3265 "description": "Success.", 3266 "content": { 3267 "application/json": { 3268 "schema": { 3269 "$ref": "#/components/schemas/Registry" 3270 } 3271 } 3272 } 3273 }, 3274 "default": { 3275 "description": "Error.", 3276 "content": { 3277 "application/json": { 3278 "schema": { 3279 "$ref": "#/components/schemas/Error" 3280 } 3281 } 3282 } 3283 } 3284 } 3285 } 3286 }, 3287 "/api/accounts_mgmt/v1/registry_credentials": { 3288 "post": { 3289 "description": "Creates a new registry credential.", 3290 "requestBody": { 3291 "content": { 3292 "application/json": { 3293 "schema": { 3294 "$ref": "#/components/schemas/RegistryCredential" 3295 } 3296 } 3297 } 3298 }, 3299 "responses": { 3300 "201": { 3301 "description": "Success.", 3302 "content": { 3303 "application/json": { 3304 "schema": { 3305 "$ref": "#/components/schemas/RegistryCredential" 3306 } 3307 } 3308 } 3309 }, 3310 "default": { 3311 "description": "Error.", 3312 "content": { 3313 "application/json": { 3314 "schema": { 3315 "$ref": "#/components/schemas/Error" 3316 } 3317 } 3318 } 3319 } 3320 } 3321 }, 3322 "get": { 3323 "description": "Retrieves the list of accounts.", 3324 "parameters": [ 3325 { 3326 "name": "order", 3327 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement. For example, in order to sort the\nRegistryCredentials descending by username the value should be:\n\n```sql\nusername desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 3328 "in": "query", 3329 "schema": { 3330 "type": "string" 3331 } 3332 }, 3333 { 3334 "name": "page", 3335 "description": "Index of the requested page, where one corresponds to the first page.", 3336 "in": "query", 3337 "schema": { 3338 "type": "integer", 3339 "format": "int32" 3340 } 3341 }, 3342 { 3343 "name": "search", 3344 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the RegistryCredentials instead\nof the names of the columns of a table. For example, in order to retrieve all the\nRegistryCredentials for a user the value should be:\n\n```sql\nusername = 'abcxyz...'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nRegistryCredentials that the user has permission to see will be returned.", 3345 "in": "query", 3346 "schema": { 3347 "type": "string" 3348 } 3349 }, 3350 { 3351 "name": "size", 3352 "description": "Maximum number of items that will be contained in the returned page.", 3353 "in": "query", 3354 "schema": { 3355 "type": "integer", 3356 "format": "int32" 3357 } 3358 } 3359 ], 3360 "responses": { 3361 "200": { 3362 "description": "Success.", 3363 "content": { 3364 "application/json": { 3365 "schema": { 3366 "type": "object", 3367 "properties": { 3368 "items": { 3369 "description": "Retrieved list of registry credentials.", 3370 "type": "array", 3371 "items": { 3372 "$ref": "#/components/schemas/RegistryCredential" 3373 } 3374 }, 3375 "page": { 3376 "description": "Index of the requested page, where one corresponds to the first page.", 3377 "type": "integer", 3378 "format": "int32" 3379 }, 3380 "size": { 3381 "description": "Maximum number of items that will be contained in the returned page.", 3382 "type": "integer", 3383 "format": "int32" 3384 }, 3385 "total": { 3386 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 3387 "type": "integer", 3388 "format": "int32" 3389 } 3390 } 3391 } 3392 } 3393 } 3394 }, 3395 "default": { 3396 "description": "Error.", 3397 "content": { 3398 "application/json": { 3399 "schema": { 3400 "$ref": "#/components/schemas/Error" 3401 } 3402 } 3403 } 3404 } 3405 } 3406 } 3407 }, 3408 "/api/accounts_mgmt/v1/registry_credentials/{registry_credential_id}": { 3409 "delete": { 3410 "description": "Delete the registry credential", 3411 "parameters": [ 3412 { 3413 "name": "registry_credential_id", 3414 "in": "path", 3415 "schema": { 3416 "type": "string" 3417 }, 3418 "required": true 3419 } 3420 ], 3421 "responses": { 3422 "204": { 3423 "description": "Success." 3424 }, 3425 "default": { 3426 "description": "Error.", 3427 "content": { 3428 "application/json": { 3429 "schema": { 3430 "$ref": "#/components/schemas/Error" 3431 } 3432 } 3433 } 3434 } 3435 } 3436 }, 3437 "get": { 3438 "description": "Retrieves the details of the registry credential.", 3439 "parameters": [ 3440 { 3441 "name": "registry_credential_id", 3442 "in": "path", 3443 "schema": { 3444 "type": "string" 3445 }, 3446 "required": true 3447 } 3448 ], 3449 "responses": { 3450 "200": { 3451 "description": "Success.", 3452 "content": { 3453 "application/json": { 3454 "schema": { 3455 "$ref": "#/components/schemas/RegistryCredential" 3456 } 3457 } 3458 } 3459 }, 3460 "default": { 3461 "description": "Error.", 3462 "content": { 3463 "application/json": { 3464 "schema": { 3465 "$ref": "#/components/schemas/Error" 3466 } 3467 } 3468 } 3469 } 3470 } 3471 } 3472 }, 3473 "/api/accounts_mgmt/v1/resource_quota": { 3474 "post": { 3475 "description": "Creates a new resource quota.", 3476 "requestBody": { 3477 "content": { 3478 "application/json": { 3479 "schema": { 3480 "$ref": "#/components/schemas/ResourceQuota" 3481 } 3482 } 3483 } 3484 }, 3485 "responses": { 3486 "201": { 3487 "description": "Success.", 3488 "content": { 3489 "application/json": { 3490 "schema": { 3491 "$ref": "#/components/schemas/ResourceQuota" 3492 } 3493 } 3494 } 3495 }, 3496 "default": { 3497 "description": "Error.", 3498 "content": { 3499 "application/json": { 3500 "schema": { 3501 "$ref": "#/components/schemas/Error" 3502 } 3503 } 3504 } 3505 } 3506 } 3507 }, 3508 "get": { 3509 "description": "Retrieves the list of resource quotas.", 3510 "parameters": [ 3511 { 3512 "name": "page", 3513 "description": "Index of the requested page, where one corresponds to the first page.", 3514 "in": "query", 3515 "schema": { 3516 "type": "integer", 3517 "format": "int32" 3518 } 3519 }, 3520 { 3521 "name": "search", 3522 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the account\ninstead of the names of the columns of a table. For example, in order to\nretrieve resource quota with resource_type cluster.aws:\n\n```sql\nresource_type = 'cluster.aws'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 3523 "in": "query", 3524 "schema": { 3525 "type": "string" 3526 } 3527 }, 3528 { 3529 "name": "size", 3530 "description": "Maximum number of items that will be contained in the returned page.", 3531 "in": "query", 3532 "schema": { 3533 "type": "integer", 3534 "format": "int32" 3535 } 3536 } 3537 ], 3538 "responses": { 3539 "200": { 3540 "description": "Success.", 3541 "content": { 3542 "application/json": { 3543 "schema": { 3544 "type": "object", 3545 "properties": { 3546 "items": { 3547 "description": "Retrieved list of resource quotas.", 3548 "type": "array", 3549 "items": { 3550 "$ref": "#/components/schemas/ResourceQuota" 3551 } 3552 }, 3553 "page": { 3554 "description": "Index of the requested page, where one corresponds to the first page.", 3555 "type": "integer", 3556 "format": "int32" 3557 }, 3558 "size": { 3559 "description": "Maximum number of items that will be contained in the returned page.", 3560 "type": "integer", 3561 "format": "int32" 3562 }, 3563 "total": { 3564 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 3565 "type": "integer", 3566 "format": "int32" 3567 } 3568 } 3569 } 3570 } 3571 } 3572 }, 3573 "default": { 3574 "description": "Error.", 3575 "content": { 3576 "application/json": { 3577 "schema": { 3578 "$ref": "#/components/schemas/Error" 3579 } 3580 } 3581 } 3582 } 3583 } 3584 } 3585 }, 3586 "/api/accounts_mgmt/v1/resource_quota/{resource_quota_id}": { 3587 "delete": { 3588 "description": "Deletes the resource quota.", 3589 "parameters": [ 3590 { 3591 "name": "resource_quota_id", 3592 "in": "path", 3593 "schema": { 3594 "type": "string" 3595 }, 3596 "required": true 3597 } 3598 ], 3599 "responses": { 3600 "204": { 3601 "description": "Success." 3602 }, 3603 "default": { 3604 "description": "Error.", 3605 "content": { 3606 "application/json": { 3607 "schema": { 3608 "$ref": "#/components/schemas/Error" 3609 } 3610 } 3611 } 3612 } 3613 } 3614 }, 3615 "get": { 3616 "description": "Retrieves the details of the resource quota.", 3617 "parameters": [ 3618 { 3619 "name": "resource_quota_id", 3620 "in": "path", 3621 "schema": { 3622 "type": "string" 3623 }, 3624 "required": true 3625 } 3626 ], 3627 "responses": { 3628 "200": { 3629 "description": "Success.", 3630 "content": { 3631 "application/json": { 3632 "schema": { 3633 "$ref": "#/components/schemas/ResourceQuota" 3634 } 3635 } 3636 } 3637 }, 3638 "default": { 3639 "description": "Error.", 3640 "content": { 3641 "application/json": { 3642 "schema": { 3643 "$ref": "#/components/schemas/Error" 3644 } 3645 } 3646 } 3647 } 3648 } 3649 }, 3650 "patch": { 3651 "description": "Updates the resource quota.", 3652 "parameters": [ 3653 { 3654 "name": "resource_quota_id", 3655 "in": "path", 3656 "schema": { 3657 "type": "string" 3658 }, 3659 "required": true 3660 } 3661 ], 3662 "requestBody": { 3663 "content": { 3664 "application/json": { 3665 "schema": { 3666 "$ref": "#/components/schemas/ResourceQuota" 3667 } 3668 } 3669 } 3670 }, 3671 "responses": { 3672 "200": { 3673 "description": "Success.", 3674 "content": { 3675 "application/json": { 3676 "schema": { 3677 "$ref": "#/components/schemas/ResourceQuota" 3678 } 3679 } 3680 } 3681 }, 3682 "default": { 3683 "description": "Error.", 3684 "content": { 3685 "application/json": { 3686 "schema": { 3687 "$ref": "#/components/schemas/Error" 3688 } 3689 } 3690 } 3691 } 3692 } 3693 } 3694 }, 3695 "/api/accounts_mgmt/v1/role_bindings": { 3696 "post": { 3697 "description": "Creates a new role binding.", 3698 "requestBody": { 3699 "content": { 3700 "application/json": { 3701 "schema": { 3702 "$ref": "#/components/schemas/RoleBinding" 3703 } 3704 } 3705 } 3706 }, 3707 "responses": { 3708 "201": { 3709 "description": "Success.", 3710 "content": { 3711 "application/json": { 3712 "schema": { 3713 "$ref": "#/components/schemas/RoleBinding" 3714 } 3715 } 3716 } 3717 }, 3718 "default": { 3719 "description": "Error.", 3720 "content": { 3721 "application/json": { 3722 "schema": { 3723 "$ref": "#/components/schemas/Error" 3724 } 3725 } 3726 } 3727 } 3728 } 3729 }, 3730 "get": { 3731 "description": "Retrieves a list of role bindings.", 3732 "parameters": [ 3733 { 3734 "name": "page", 3735 "description": "Index of the requested page, where one corresponds to the first page.", 3736 "in": "query", 3737 "schema": { 3738 "type": "integer", 3739 "format": "int32" 3740 } 3741 }, 3742 { 3743 "name": "search", 3744 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the role binding\ninstead of the names of the columns of a table. For example, in order to\nretrieve role bindings with role_id AuthenticatedUser:\n\n```sql\nrole_id = 'AuthenticatedUser'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 3745 "in": "query", 3746 "schema": { 3747 "type": "string" 3748 } 3749 }, 3750 { 3751 "name": "size", 3752 "description": "Maximum number of items that will be contained in the returned page.", 3753 "in": "query", 3754 "schema": { 3755 "type": "integer", 3756 "format": "int32" 3757 } 3758 } 3759 ], 3760 "responses": { 3761 "200": { 3762 "description": "Success.", 3763 "content": { 3764 "application/json": { 3765 "schema": { 3766 "type": "object", 3767 "properties": { 3768 "items": { 3769 "description": "Retrieved list of role bindings.", 3770 "type": "array", 3771 "items": { 3772 "$ref": "#/components/schemas/RoleBinding" 3773 } 3774 }, 3775 "page": { 3776 "description": "Index of the requested page, where one corresponds to the first page.", 3777 "type": "integer", 3778 "format": "int32" 3779 }, 3780 "size": { 3781 "description": "Maximum number of items that will be contained in the returned page.", 3782 "type": "integer", 3783 "format": "int32" 3784 }, 3785 "total": { 3786 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 3787 "type": "integer", 3788 "format": "int32" 3789 } 3790 } 3791 } 3792 } 3793 } 3794 }, 3795 "default": { 3796 "description": "Error.", 3797 "content": { 3798 "application/json": { 3799 "schema": { 3800 "$ref": "#/components/schemas/Error" 3801 } 3802 } 3803 } 3804 } 3805 } 3806 } 3807 }, 3808 "/api/accounts_mgmt/v1/role_bindings/{role_binding_id}": { 3809 "delete": { 3810 "description": "Deletes the role binding.", 3811 "parameters": [ 3812 { 3813 "name": "role_binding_id", 3814 "in": "path", 3815 "schema": { 3816 "type": "string" 3817 }, 3818 "required": true 3819 } 3820 ], 3821 "responses": { 3822 "204": { 3823 "description": "Success." 3824 }, 3825 "default": { 3826 "description": "Error.", 3827 "content": { 3828 "application/json": { 3829 "schema": { 3830 "$ref": "#/components/schemas/Error" 3831 } 3832 } 3833 } 3834 } 3835 } 3836 }, 3837 "get": { 3838 "description": "Retrieves the details of the role binding.", 3839 "parameters": [ 3840 { 3841 "name": "role_binding_id", 3842 "in": "path", 3843 "schema": { 3844 "type": "string" 3845 }, 3846 "required": true 3847 } 3848 ], 3849 "responses": { 3850 "200": { 3851 "description": "Success.", 3852 "content": { 3853 "application/json": { 3854 "schema": { 3855 "$ref": "#/components/schemas/RoleBinding" 3856 } 3857 } 3858 } 3859 }, 3860 "default": { 3861 "description": "Error.", 3862 "content": { 3863 "application/json": { 3864 "schema": { 3865 "$ref": "#/components/schemas/Error" 3866 } 3867 } 3868 } 3869 } 3870 } 3871 }, 3872 "patch": { 3873 "description": "Updates the account.", 3874 "parameters": [ 3875 { 3876 "name": "role_binding_id", 3877 "in": "path", 3878 "schema": { 3879 "type": "string" 3880 }, 3881 "required": true 3882 } 3883 ], 3884 "requestBody": { 3885 "content": { 3886 "application/json": { 3887 "schema": { 3888 "$ref": "#/components/schemas/RoleBinding" 3889 } 3890 } 3891 } 3892 }, 3893 "responses": { 3894 "200": { 3895 "description": "Success.", 3896 "content": { 3897 "application/json": { 3898 "schema": { 3899 "$ref": "#/components/schemas/RoleBinding" 3900 } 3901 } 3902 } 3903 }, 3904 "default": { 3905 "description": "Error.", 3906 "content": { 3907 "application/json": { 3908 "schema": { 3909 "$ref": "#/components/schemas/Error" 3910 } 3911 } 3912 } 3913 } 3914 } 3915 } 3916 }, 3917 "/api/accounts_mgmt/v1/roles": { 3918 "post": { 3919 "description": "Creates a new role.", 3920 "requestBody": { 3921 "content": { 3922 "application/json": { 3923 "schema": { 3924 "$ref": "#/components/schemas/Role" 3925 } 3926 } 3927 } 3928 }, 3929 "responses": { 3930 "201": { 3931 "description": "Success.", 3932 "content": { 3933 "application/json": { 3934 "schema": { 3935 "$ref": "#/components/schemas/Role" 3936 } 3937 } 3938 } 3939 }, 3940 "default": { 3941 "description": "Error.", 3942 "content": { 3943 "application/json": { 3944 "schema": { 3945 "$ref": "#/components/schemas/Error" 3946 } 3947 } 3948 } 3949 } 3950 } 3951 }, 3952 "get": { 3953 "description": "Retrieves a list of roles.", 3954 "parameters": [ 3955 { 3956 "name": "page", 3957 "description": "Index of the requested page, where one corresponds to the first page.", 3958 "in": "query", 3959 "schema": { 3960 "type": "integer", 3961 "format": "int32" 3962 } 3963 }, 3964 { 3965 "name": "search", 3966 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the role\ninstead of the names of the columns of a table. For example, in order to\nretrieve roles named starting with `Organization`:\n\n```sql\nname like 'Organization%'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 3967 "in": "query", 3968 "schema": { 3969 "type": "string" 3970 } 3971 }, 3972 { 3973 "name": "size", 3974 "description": "Maximum number of items that will be contained in the returned page.", 3975 "in": "query", 3976 "schema": { 3977 "type": "integer", 3978 "format": "int32" 3979 } 3980 } 3981 ], 3982 "responses": { 3983 "200": { 3984 "description": "Success.", 3985 "content": { 3986 "application/json": { 3987 "schema": { 3988 "type": "object", 3989 "properties": { 3990 "items": { 3991 "description": "Retrieved list of roles.", 3992 "type": "array", 3993 "items": { 3994 "$ref": "#/components/schemas/Role" 3995 } 3996 }, 3997 "page": { 3998 "description": "Index of the requested page, where one corresponds to the first page.", 3999 "type": "integer", 4000 "format": "int32" 4001 }, 4002 "size": { 4003 "description": "Maximum number of items that will be contained in the returned page.", 4004 "type": "integer", 4005 "format": "int32" 4006 }, 4007 "total": { 4008 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 4009 "type": "integer", 4010 "format": "int32" 4011 } 4012 } 4013 } 4014 } 4015 } 4016 }, 4017 "default": { 4018 "description": "Error.", 4019 "content": { 4020 "application/json": { 4021 "schema": { 4022 "$ref": "#/components/schemas/Error" 4023 } 4024 } 4025 } 4026 } 4027 } 4028 } 4029 }, 4030 "/api/accounts_mgmt/v1/roles/{role_id}": { 4031 "delete": { 4032 "description": "Deletes the role.", 4033 "parameters": [ 4034 { 4035 "name": "role_id", 4036 "in": "path", 4037 "schema": { 4038 "type": "string" 4039 }, 4040 "required": true 4041 } 4042 ], 4043 "responses": { 4044 "204": { 4045 "description": "Success." 4046 }, 4047 "default": { 4048 "description": "Error.", 4049 "content": { 4050 "application/json": { 4051 "schema": { 4052 "$ref": "#/components/schemas/Error" 4053 } 4054 } 4055 } 4056 } 4057 } 4058 }, 4059 "get": { 4060 "description": "Retrieves the details of the role.", 4061 "parameters": [ 4062 { 4063 "name": "role_id", 4064 "in": "path", 4065 "schema": { 4066 "type": "string" 4067 }, 4068 "required": true 4069 } 4070 ], 4071 "responses": { 4072 "200": { 4073 "description": "Success.", 4074 "content": { 4075 "application/json": { 4076 "schema": { 4077 "$ref": "#/components/schemas/Role" 4078 } 4079 } 4080 } 4081 }, 4082 "default": { 4083 "description": "Error.", 4084 "content": { 4085 "application/json": { 4086 "schema": { 4087 "$ref": "#/components/schemas/Error" 4088 } 4089 } 4090 } 4091 } 4092 } 4093 }, 4094 "patch": { 4095 "description": "Updates the role.", 4096 "parameters": [ 4097 { 4098 "name": "role_id", 4099 "in": "path", 4100 "schema": { 4101 "type": "string" 4102 }, 4103 "required": true 4104 } 4105 ], 4106 "requestBody": { 4107 "content": { 4108 "application/json": { 4109 "schema": { 4110 "$ref": "#/components/schemas/Role" 4111 } 4112 } 4113 } 4114 }, 4115 "responses": { 4116 "200": { 4117 "description": "Success.", 4118 "content": { 4119 "application/json": { 4120 "schema": { 4121 "$ref": "#/components/schemas/Role" 4122 } 4123 } 4124 } 4125 }, 4126 "default": { 4127 "description": "Error.", 4128 "content": { 4129 "application/json": { 4130 "schema": { 4131 "$ref": "#/components/schemas/Error" 4132 } 4133 } 4134 } 4135 } 4136 } 4137 } 4138 }, 4139 "/api/accounts_mgmt/v1/sku_rules": { 4140 "get": { 4141 "description": "Retrieves a list of Sku Rules.", 4142 "parameters": [ 4143 { 4144 "name": "page", 4145 "description": "Index of the requested page, where one corresponds to the first page.", 4146 "in": "query", 4147 "schema": { 4148 "type": "integer", 4149 "format": "int32" 4150 } 4151 }, 4152 { 4153 "name": "search", 4154 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the SKU\ninstead of the names of the columns of a table. For example, in order to\nretrieve SKUS large sized resources:\n\n```sql\nresource_name like '%large'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 4155 "in": "query", 4156 "schema": { 4157 "type": "string" 4158 } 4159 }, 4160 { 4161 "name": "size", 4162 "description": "Maximum number of items that will be contained in the returned page.", 4163 "in": "query", 4164 "schema": { 4165 "type": "integer", 4166 "format": "int32" 4167 } 4168 } 4169 ], 4170 "responses": { 4171 "200": { 4172 "description": "Success.", 4173 "content": { 4174 "application/json": { 4175 "schema": { 4176 "type": "object", 4177 "properties": { 4178 "items": { 4179 "description": "Retrieved list of Sku Rules.", 4180 "type": "array", 4181 "items": { 4182 "$ref": "#/components/schemas/SkuRule" 4183 } 4184 }, 4185 "page": { 4186 "description": "Index of the requested page, where one corresponds to the first page.", 4187 "type": "integer", 4188 "format": "int32" 4189 }, 4190 "size": { 4191 "description": "Maximum number of items that will be contained in the returned page.", 4192 "type": "integer", 4193 "format": "int32" 4194 }, 4195 "total": { 4196 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 4197 "type": "integer", 4198 "format": "int32" 4199 } 4200 } 4201 } 4202 } 4203 } 4204 }, 4205 "default": { 4206 "description": "Error.", 4207 "content": { 4208 "application/json": { 4209 "schema": { 4210 "$ref": "#/components/schemas/Error" 4211 } 4212 } 4213 } 4214 } 4215 } 4216 } 4217 }, 4218 "/api/accounts_mgmt/v1/sku_rules/{sku_rule_id}": { 4219 "get": { 4220 "description": "Retrieves the details of the Sku Rule.", 4221 "parameters": [ 4222 { 4223 "name": "sku_rule_id", 4224 "in": "path", 4225 "schema": { 4226 "type": "string" 4227 }, 4228 "required": true 4229 } 4230 ], 4231 "responses": { 4232 "200": { 4233 "description": "Success.", 4234 "content": { 4235 "application/json": { 4236 "schema": { 4237 "$ref": "#/components/schemas/SkuRule" 4238 } 4239 } 4240 } 4241 }, 4242 "default": { 4243 "description": "Error.", 4244 "content": { 4245 "application/json": { 4246 "schema": { 4247 "$ref": "#/components/schemas/Error" 4248 } 4249 } 4250 } 4251 } 4252 } 4253 } 4254 }, 4255 "/api/accounts_mgmt/v1/subscriptions": { 4256 "get": { 4257 "description": "Retrieves a list of subscriptions.", 4258 "parameters": [ 4259 { 4260 "name": "fetchAccounts", 4261 "description": "If true, includes the account reference information in the output. Could slow request response time.", 4262 "in": "query", 4263 "schema": { 4264 "type": "boolean" 4265 } 4266 }, 4267 { 4268 "name": "fetchLabels", 4269 "description": "If true, includes the labels on a subscription in the output. Could slow request response time.", 4270 "in": "query", 4271 "schema": { 4272 "type": "boolean" 4273 } 4274 }, 4275 { 4276 "name": "fields", 4277 "description": "Projection\nThis field contains a comma-separated list of fields you'd like to get in\na result. No new fields can be added, only existing ones can be filtered.\nTo specify a field 'id' of a structure 'plan' use 'plan.id'.\nTo specify all fields of a structure 'labels' use 'labels.*'.\n", 4278 "in": "query", 4279 "schema": { 4280 "type": "string" 4281 } 4282 }, 4283 { 4284 "name": "labels", 4285 "description": "Filter subscriptions by a comma separated list of labels:\n\n[source]\n----\nenv=staging,department=sales\n----\n", 4286 "in": "query", 4287 "schema": { 4288 "type": "string" 4289 } 4290 }, 4291 { 4292 "name": "order", 4293 "description": "Order criteria.\n\nThe syntax of this parameter is similar to the syntax of the _order by_ clause of\na SQL statement. For example, in order to sort the\nsubscriptions descending by name identifier the value should be:\n\n```sql\nname desc\n```\n\nIf the parameter isn't provided, or if the value is empty, then the order of the\nresults is undefined.", 4294 "in": "query", 4295 "schema": { 4296 "type": "string" 4297 } 4298 }, 4299 { 4300 "name": "page", 4301 "description": "Index of the requested page, where one corresponds to the first page.", 4302 "in": "query", 4303 "schema": { 4304 "type": "integer", 4305 "format": "int32" 4306 } 4307 }, 4308 { 4309 "name": "search", 4310 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause of a\nSQL statement, but using the names of the attributes of the subscription instead\nof the names of the columns of a table. For example, in order to retrieve all the\nsubscriptions for managed clusters the value should be:\n\n```sql\nmanaged = 't'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nclusters that the user has permission to see will be returned.", 4311 "in": "query", 4312 "schema": { 4313 "type": "string" 4314 } 4315 }, 4316 { 4317 "name": "size", 4318 "description": "Maximum number of items that will be contained in the returned page.", 4319 "in": "query", 4320 "schema": { 4321 "type": "integer", 4322 "format": "int32" 4323 } 4324 } 4325 ], 4326 "responses": { 4327 "200": { 4328 "description": "Success.", 4329 "content": { 4330 "application/json": { 4331 "schema": { 4332 "type": "object", 4333 "properties": { 4334 "items": { 4335 "description": "Retrieved list of subscriptions.", 4336 "type": "array", 4337 "items": { 4338 "$ref": "#/components/schemas/Subscription" 4339 } 4340 }, 4341 "page": { 4342 "description": "Index of the requested page, where one corresponds to the first page.", 4343 "type": "integer", 4344 "format": "int32" 4345 }, 4346 "size": { 4347 "description": "Maximum number of items that will be contained in the returned page.", 4348 "type": "integer", 4349 "format": "int32" 4350 }, 4351 "total": { 4352 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 4353 "type": "integer", 4354 "format": "int32" 4355 } 4356 } 4357 } 4358 } 4359 } 4360 }, 4361 "default": { 4362 "description": "Error.", 4363 "content": { 4364 "application/json": { 4365 "schema": { 4366 "$ref": "#/components/schemas/Error" 4367 } 4368 } 4369 } 4370 } 4371 } 4372 }, 4373 "post": { 4374 "description": "Create a new subscription and register a cluster for it.", 4375 "requestBody": { 4376 "content": { 4377 "application/json": { 4378 "schema": { 4379 "$ref": "#/components/schemas/SubscriptionRegistration" 4380 } 4381 } 4382 } 4383 }, 4384 "responses": { 4385 "201": { 4386 "description": "Success.", 4387 "content": { 4388 "application/json": { 4389 "schema": { 4390 "$ref": "#/components/schemas/Subscription" 4391 } 4392 } 4393 } 4394 }, 4395 "default": { 4396 "description": "Error.", 4397 "content": { 4398 "application/json": { 4399 "schema": { 4400 "$ref": "#/components/schemas/Error" 4401 } 4402 } 4403 } 4404 } 4405 } 4406 } 4407 }, 4408 "/api/accounts_mgmt/v1/subscriptions/labels": { 4409 "post": { 4410 "description": "Create a new account/organization/subscription label.", 4411 "requestBody": { 4412 "content": { 4413 "application/json": { 4414 "schema": { 4415 "$ref": "#/components/schemas/Label" 4416 } 4417 } 4418 } 4419 }, 4420 "responses": { 4421 "201": { 4422 "description": "Success.", 4423 "content": { 4424 "application/json": { 4425 "schema": { 4426 "$ref": "#/components/schemas/Label" 4427 } 4428 } 4429 } 4430 }, 4431 "default": { 4432 "description": "Error.", 4433 "content": { 4434 "application/json": { 4435 "schema": { 4436 "$ref": "#/components/schemas/Error" 4437 } 4438 } 4439 } 4440 } 4441 } 4442 }, 4443 "get": { 4444 "description": "Retrieves the list of labels of the account/organization/subscription.\n\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of labels\nof the account/organization/subscription.", 4445 "parameters": [ 4446 { 4447 "name": "page", 4448 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 4449 "in": "query", 4450 "schema": { 4451 "type": "integer", 4452 "format": "int32" 4453 } 4454 }, 4455 { 4456 "name": "size", 4457 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nlabels of the account/organization/subscription.", 4458 "in": "query", 4459 "schema": { 4460 "type": "integer", 4461 "format": "int32" 4462 } 4463 } 4464 ], 4465 "responses": { 4466 "200": { 4467 "description": "Success.", 4468 "content": { 4469 "application/json": { 4470 "schema": { 4471 "type": "object", 4472 "properties": { 4473 "items": { 4474 "description": "Retrieved list of cloud providers.", 4475 "type": "array", 4476 "items": { 4477 "$ref": "#/components/schemas/Label" 4478 } 4479 }, 4480 "page": { 4481 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 4482 "type": "integer", 4483 "format": "int32" 4484 }, 4485 "size": { 4486 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nlabels of the account/organization/subscription.", 4487 "type": "integer", 4488 "format": "int32" 4489 }, 4490 "total": { 4491 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of labels of the account/organization/subscription.", 4492 "type": "integer", 4493 "format": "int32" 4494 } 4495 } 4496 } 4497 } 4498 } 4499 }, 4500 "default": { 4501 "description": "Error.", 4502 "content": { 4503 "application/json": { 4504 "schema": { 4505 "$ref": "#/components/schemas/Error" 4506 } 4507 } 4508 } 4509 } 4510 } 4511 } 4512 }, 4513 "/api/accounts_mgmt/v1/subscriptions/labels/{label_id}": { 4514 "delete": { 4515 "description": "Deletes the account label.", 4516 "parameters": [ 4517 { 4518 "name": "label_id", 4519 "in": "path", 4520 "schema": { 4521 "type": "string" 4522 }, 4523 "required": true 4524 } 4525 ], 4526 "responses": { 4527 "204": { 4528 "description": "Success." 4529 }, 4530 "default": { 4531 "description": "Error.", 4532 "content": { 4533 "application/json": { 4534 "schema": { 4535 "$ref": "#/components/schemas/Error" 4536 } 4537 } 4538 } 4539 } 4540 } 4541 }, 4542 "get": { 4543 "description": "Retrieves the details of the label.", 4544 "parameters": [ 4545 { 4546 "name": "label_id", 4547 "in": "path", 4548 "schema": { 4549 "type": "string" 4550 }, 4551 "required": true 4552 } 4553 ], 4554 "responses": { 4555 "200": { 4556 "description": "Success.", 4557 "content": { 4558 "application/json": { 4559 "schema": { 4560 "$ref": "#/components/schemas/Label" 4561 } 4562 } 4563 } 4564 }, 4565 "default": { 4566 "description": "Error.", 4567 "content": { 4568 "application/json": { 4569 "schema": { 4570 "$ref": "#/components/schemas/Error" 4571 } 4572 } 4573 } 4574 } 4575 } 4576 }, 4577 "patch": { 4578 "description": "Updates the account label.", 4579 "parameters": [ 4580 { 4581 "name": "label_id", 4582 "in": "path", 4583 "schema": { 4584 "type": "string" 4585 }, 4586 "required": true 4587 } 4588 ], 4589 "requestBody": { 4590 "content": { 4591 "application/json": { 4592 "schema": { 4593 "$ref": "#/components/schemas/Label" 4594 } 4595 } 4596 } 4597 }, 4598 "responses": { 4599 "200": { 4600 "description": "Success.", 4601 "content": { 4602 "application/json": { 4603 "schema": { 4604 "$ref": "#/components/schemas/Label" 4605 } 4606 } 4607 } 4608 }, 4609 "default": { 4610 "description": "Error.", 4611 "content": { 4612 "application/json": { 4613 "schema": { 4614 "$ref": "#/components/schemas/Error" 4615 } 4616 } 4617 } 4618 } 4619 } 4620 } 4621 }, 4622 "/api/accounts_mgmt/v1/subscriptions/labels/{labels_id}": { 4623 "delete": { 4624 "description": "Deletes the account label.", 4625 "parameters": [ 4626 { 4627 "name": "labels_id", 4628 "in": "path", 4629 "schema": { 4630 "type": "string" 4631 }, 4632 "required": true 4633 } 4634 ], 4635 "responses": { 4636 "204": { 4637 "description": "Success." 4638 }, 4639 "default": { 4640 "description": "Error.", 4641 "content": { 4642 "application/json": { 4643 "schema": { 4644 "$ref": "#/components/schemas/Error" 4645 } 4646 } 4647 } 4648 } 4649 } 4650 }, 4651 "get": { 4652 "description": "Retrieves the details of the label.", 4653 "parameters": [ 4654 { 4655 "name": "labels_id", 4656 "in": "path", 4657 "schema": { 4658 "type": "string" 4659 }, 4660 "required": true 4661 } 4662 ], 4663 "responses": { 4664 "200": { 4665 "description": "Success.", 4666 "content": { 4667 "application/json": { 4668 "schema": { 4669 "$ref": "#/components/schemas/Label" 4670 } 4671 } 4672 } 4673 }, 4674 "default": { 4675 "description": "Error.", 4676 "content": { 4677 "application/json": { 4678 "schema": { 4679 "$ref": "#/components/schemas/Error" 4680 } 4681 } 4682 } 4683 } 4684 } 4685 }, 4686 "patch": { 4687 "description": "Updates the account label.", 4688 "parameters": [ 4689 { 4690 "name": "labels_id", 4691 "in": "path", 4692 "schema": { 4693 "type": "string" 4694 }, 4695 "required": true 4696 } 4697 ], 4698 "requestBody": { 4699 "content": { 4700 "application/json": { 4701 "schema": { 4702 "$ref": "#/components/schemas/Label" 4703 } 4704 } 4705 } 4706 }, 4707 "responses": { 4708 "200": { 4709 "description": "Success.", 4710 "content": { 4711 "application/json": { 4712 "schema": { 4713 "$ref": "#/components/schemas/Label" 4714 } 4715 } 4716 } 4717 }, 4718 "default": { 4719 "description": "Error.", 4720 "content": { 4721 "application/json": { 4722 "schema": { 4723 "$ref": "#/components/schemas/Error" 4724 } 4725 } 4726 } 4727 } 4728 } 4729 } 4730 }, 4731 "/api/accounts_mgmt/v1/subscriptions/{subscription_id}": { 4732 "delete": { 4733 "description": "Deletes the subscription by ID.", 4734 "parameters": [ 4735 { 4736 "name": "subscription_id", 4737 "in": "path", 4738 "schema": { 4739 "type": "string" 4740 }, 4741 "required": true 4742 } 4743 ], 4744 "responses": { 4745 "204": { 4746 "description": "Success." 4747 }, 4748 "default": { 4749 "description": "Error.", 4750 "content": { 4751 "application/json": { 4752 "schema": { 4753 "$ref": "#/components/schemas/Error" 4754 } 4755 } 4756 } 4757 } 4758 } 4759 }, 4760 "get": { 4761 "description": "Retrieves the details of the subscription by ID.", 4762 "parameters": [ 4763 { 4764 "name": "subscription_id", 4765 "in": "path", 4766 "schema": { 4767 "type": "string" 4768 }, 4769 "required": true 4770 } 4771 ], 4772 "responses": { 4773 "200": { 4774 "description": "Success.", 4775 "content": { 4776 "application/json": { 4777 "schema": { 4778 "$ref": "#/components/schemas/Subscription" 4779 } 4780 } 4781 } 4782 }, 4783 "default": { 4784 "description": "Error.", 4785 "content": { 4786 "application/json": { 4787 "schema": { 4788 "$ref": "#/components/schemas/Error" 4789 } 4790 } 4791 } 4792 } 4793 } 4794 }, 4795 "patch": { 4796 "description": "Update a subscription", 4797 "parameters": [ 4798 { 4799 "name": "subscription_id", 4800 "in": "path", 4801 "schema": { 4802 "type": "string" 4803 }, 4804 "required": true 4805 } 4806 ], 4807 "requestBody": { 4808 "content": { 4809 "application/json": { 4810 "schema": { 4811 "$ref": "#/components/schemas/Subscription" 4812 } 4813 } 4814 } 4815 }, 4816 "responses": { 4817 "200": { 4818 "description": "Success.", 4819 "content": { 4820 "application/json": { 4821 "schema": { 4822 "$ref": "#/components/schemas/Subscription" 4823 } 4824 } 4825 } 4826 }, 4827 "default": { 4828 "description": "Error.", 4829 "content": { 4830 "application/json": { 4831 "schema": { 4832 "$ref": "#/components/schemas/Error" 4833 } 4834 } 4835 } 4836 } 4837 } 4838 } 4839 }, 4840 "/api/accounts_mgmt/v1/subscriptions/{subscription_id}/labels": { 4841 "post": { 4842 "description": "Create a new account/organization/subscription label.", 4843 "parameters": [ 4844 { 4845 "name": "subscription_id", 4846 "in": "path", 4847 "schema": { 4848 "type": "string" 4849 }, 4850 "required": true 4851 } 4852 ], 4853 "requestBody": { 4854 "content": { 4855 "application/json": { 4856 "schema": { 4857 "$ref": "#/components/schemas/Label" 4858 } 4859 } 4860 } 4861 }, 4862 "responses": { 4863 "201": { 4864 "description": "Success.", 4865 "content": { 4866 "application/json": { 4867 "schema": { 4868 "$ref": "#/components/schemas/Label" 4869 } 4870 } 4871 } 4872 }, 4873 "default": { 4874 "description": "Error.", 4875 "content": { 4876 "application/json": { 4877 "schema": { 4878 "$ref": "#/components/schemas/Error" 4879 } 4880 } 4881 } 4882 } 4883 } 4884 }, 4885 "get": { 4886 "description": "Retrieves the list of labels of the account/organization/subscription.\n\nIMPORTANT: This collection doesn't currently support paging or searching, so the returned\n`page` will always be 1 and `size` and `total` will always be the total number of labels\nof the account/organization/subscription.", 4887 "parameters": [ 4888 { 4889 "name": "subscription_id", 4890 "in": "path", 4891 "schema": { 4892 "type": "string" 4893 }, 4894 "required": true 4895 }, 4896 { 4897 "name": "page", 4898 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 4899 "in": "query", 4900 "schema": { 4901 "type": "integer", 4902 "format": "int32" 4903 } 4904 }, 4905 { 4906 "name": "size", 4907 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nlabels of the account/organization/subscription.", 4908 "in": "query", 4909 "schema": { 4910 "type": "integer", 4911 "format": "int32" 4912 } 4913 } 4914 ], 4915 "responses": { 4916 "200": { 4917 "description": "Success.", 4918 "content": { 4919 "application/json": { 4920 "schema": { 4921 "type": "object", 4922 "properties": { 4923 "items": { 4924 "description": "Retrieved list of cloud providers.", 4925 "type": "array", 4926 "items": { 4927 "$ref": "#/components/schemas/Label" 4928 } 4929 }, 4930 "page": { 4931 "description": "Index of the returned page, where one corresponds to the first page. As this\ncollection doesn't support paging the result will always be `1`.", 4932 "type": "integer", 4933 "format": "int32" 4934 }, 4935 "size": { 4936 "description": "Number of items that will be contained in the returned page. As this collection\ndoesn't support paging or searching the result will always be the total number of\nlabels of the account/organization/subscription.", 4937 "type": "integer", 4938 "format": "int32" 4939 }, 4940 "total": { 4941 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page. As this collection doesn't support paging or\nsearching the result will always be the total number of labels of the account/organization/subscription.", 4942 "type": "integer", 4943 "format": "int32" 4944 } 4945 } 4946 } 4947 } 4948 } 4949 }, 4950 "default": { 4951 "description": "Error.", 4952 "content": { 4953 "application/json": { 4954 "schema": { 4955 "$ref": "#/components/schemas/Error" 4956 } 4957 } 4958 } 4959 } 4960 } 4961 } 4962 }, 4963 "/api/accounts_mgmt/v1/subscriptions/{subscription_id}/labels/{label_id}": { 4964 "delete": { 4965 "description": "Deletes the account label.", 4966 "parameters": [ 4967 { 4968 "name": "subscription_id", 4969 "in": "path", 4970 "schema": { 4971 "type": "string" 4972 }, 4973 "required": true 4974 }, 4975 { 4976 "name": "label_id", 4977 "in": "path", 4978 "schema": { 4979 "type": "string" 4980 }, 4981 "required": true 4982 } 4983 ], 4984 "responses": { 4985 "204": { 4986 "description": "Success." 4987 }, 4988 "default": { 4989 "description": "Error.", 4990 "content": { 4991 "application/json": { 4992 "schema": { 4993 "$ref": "#/components/schemas/Error" 4994 } 4995 } 4996 } 4997 } 4998 } 4999 }, 5000 "get": { 5001 "description": "Retrieves the details of the label.", 5002 "parameters": [ 5003 { 5004 "name": "subscription_id", 5005 "in": "path", 5006 "schema": { 5007 "type": "string" 5008 }, 5009 "required": true 5010 }, 5011 { 5012 "name": "label_id", 5013 "in": "path", 5014 "schema": { 5015 "type": "string" 5016 }, 5017 "required": true 5018 } 5019 ], 5020 "responses": { 5021 "200": { 5022 "description": "Success.", 5023 "content": { 5024 "application/json": { 5025 "schema": { 5026 "$ref": "#/components/schemas/Label" 5027 } 5028 } 5029 } 5030 }, 5031 "default": { 5032 "description": "Error.", 5033 "content": { 5034 "application/json": { 5035 "schema": { 5036 "$ref": "#/components/schemas/Error" 5037 } 5038 } 5039 } 5040 } 5041 } 5042 }, 5043 "patch": { 5044 "description": "Updates the account label.", 5045 "parameters": [ 5046 { 5047 "name": "subscription_id", 5048 "in": "path", 5049 "schema": { 5050 "type": "string" 5051 }, 5052 "required": true 5053 }, 5054 { 5055 "name": "label_id", 5056 "in": "path", 5057 "schema": { 5058 "type": "string" 5059 }, 5060 "required": true 5061 } 5062 ], 5063 "requestBody": { 5064 "content": { 5065 "application/json": { 5066 "schema": { 5067 "$ref": "#/components/schemas/Label" 5068 } 5069 } 5070 } 5071 }, 5072 "responses": { 5073 "200": { 5074 "description": "Success.", 5075 "content": { 5076 "application/json": { 5077 "schema": { 5078 "$ref": "#/components/schemas/Label" 5079 } 5080 } 5081 } 5082 }, 5083 "default": { 5084 "description": "Error.", 5085 "content": { 5086 "application/json": { 5087 "schema": { 5088 "$ref": "#/components/schemas/Error" 5089 } 5090 } 5091 } 5092 } 5093 } 5094 } 5095 }, 5096 "/api/accounts_mgmt/v1/subscriptions/{subscription_id}/labels/{labels_id}": { 5097 "delete": { 5098 "description": "Deletes the account label.", 5099 "parameters": [ 5100 { 5101 "name": "subscription_id", 5102 "in": "path", 5103 "schema": { 5104 "type": "string" 5105 }, 5106 "required": true 5107 }, 5108 { 5109 "name": "labels_id", 5110 "in": "path", 5111 "schema": { 5112 "type": "string" 5113 }, 5114 "required": true 5115 } 5116 ], 5117 "responses": { 5118 "204": { 5119 "description": "Success." 5120 }, 5121 "default": { 5122 "description": "Error.", 5123 "content": { 5124 "application/json": { 5125 "schema": { 5126 "$ref": "#/components/schemas/Error" 5127 } 5128 } 5129 } 5130 } 5131 } 5132 }, 5133 "get": { 5134 "description": "Retrieves the details of the label.", 5135 "parameters": [ 5136 { 5137 "name": "subscription_id", 5138 "in": "path", 5139 "schema": { 5140 "type": "string" 5141 }, 5142 "required": true 5143 }, 5144 { 5145 "name": "labels_id", 5146 "in": "path", 5147 "schema": { 5148 "type": "string" 5149 }, 5150 "required": true 5151 } 5152 ], 5153 "responses": { 5154 "200": { 5155 "description": "Success.", 5156 "content": { 5157 "application/json": { 5158 "schema": { 5159 "$ref": "#/components/schemas/Label" 5160 } 5161 } 5162 } 5163 }, 5164 "default": { 5165 "description": "Error.", 5166 "content": { 5167 "application/json": { 5168 "schema": { 5169 "$ref": "#/components/schemas/Error" 5170 } 5171 } 5172 } 5173 } 5174 } 5175 }, 5176 "patch": { 5177 "description": "Updates the account label.", 5178 "parameters": [ 5179 { 5180 "name": "subscription_id", 5181 "in": "path", 5182 "schema": { 5183 "type": "string" 5184 }, 5185 "required": true 5186 }, 5187 { 5188 "name": "labels_id", 5189 "in": "path", 5190 "schema": { 5191 "type": "string" 5192 }, 5193 "required": true 5194 } 5195 ], 5196 "requestBody": { 5197 "content": { 5198 "application/json": { 5199 "schema": { 5200 "$ref": "#/components/schemas/Label" 5201 } 5202 } 5203 } 5204 }, 5205 "responses": { 5206 "200": { 5207 "description": "Success.", 5208 "content": { 5209 "application/json": { 5210 "schema": { 5211 "$ref": "#/components/schemas/Label" 5212 } 5213 } 5214 } 5215 }, 5216 "default": { 5217 "description": "Error.", 5218 "content": { 5219 "application/json": { 5220 "schema": { 5221 "$ref": "#/components/schemas/Error" 5222 } 5223 } 5224 } 5225 } 5226 } 5227 } 5228 }, 5229 "/api/accounts_mgmt/v1/subscriptions/{subscription_id}/reserved_resources": { 5230 "get": { 5231 "description": "Retrieves items of the collection of reserved resources by the subscription.", 5232 "parameters": [ 5233 { 5234 "name": "subscription_id", 5235 "in": "path", 5236 "schema": { 5237 "type": "string" 5238 }, 5239 "required": true 5240 }, 5241 { 5242 "name": "page", 5243 "description": "Index of the requested page, where one corresponds to the first page.", 5244 "in": "query", 5245 "schema": { 5246 "type": "integer", 5247 "format": "int32" 5248 } 5249 }, 5250 { 5251 "name": "size", 5252 "description": "Maximum number of items that will be contained in the returned page.", 5253 "in": "query", 5254 "schema": { 5255 "type": "integer", 5256 "format": "int32" 5257 } 5258 } 5259 ], 5260 "responses": { 5261 "200": { 5262 "description": "Success.", 5263 "content": { 5264 "application/json": { 5265 "schema": { 5266 "type": "object", 5267 "properties": { 5268 "items": { 5269 "description": "Retrieved list of reserved resources.", 5270 "type": "array", 5271 "items": { 5272 "$ref": "#/components/schemas/ReservedResource" 5273 } 5274 }, 5275 "page": { 5276 "description": "Index of the requested page, where one corresponds to the first page.", 5277 "type": "integer", 5278 "format": "int32" 5279 }, 5280 "size": { 5281 "description": "Maximum number of items that will be contained in the returned page.", 5282 "type": "integer", 5283 "format": "int32" 5284 }, 5285 "total": { 5286 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 5287 "type": "integer", 5288 "format": "int32" 5289 } 5290 } 5291 } 5292 } 5293 } 5294 }, 5295 "default": { 5296 "description": "Error.", 5297 "content": { 5298 "application/json": { 5299 "schema": { 5300 "$ref": "#/components/schemas/Error" 5301 } 5302 } 5303 } 5304 } 5305 } 5306 } 5307 }, 5308 "/api/accounts_mgmt/v1/subscriptions/{subscription_id}/reserved_resources/{reserved_resource_id}": { 5309 "get": { 5310 "description": "Retrieves the reserved resource.", 5311 "parameters": [ 5312 { 5313 "name": "subscription_id", 5314 "in": "path", 5315 "schema": { 5316 "type": "string" 5317 }, 5318 "required": true 5319 }, 5320 { 5321 "name": "reserved_resource_id", 5322 "in": "path", 5323 "schema": { 5324 "type": "string" 5325 }, 5326 "required": true 5327 } 5328 ], 5329 "responses": { 5330 "200": { 5331 "description": "Success.", 5332 "content": { 5333 "application/json": { 5334 "schema": { 5335 "$ref": "#/components/schemas/ReservedResource" 5336 } 5337 } 5338 } 5339 }, 5340 "default": { 5341 "description": "Error.", 5342 "content": { 5343 "application/json": { 5344 "schema": { 5345 "$ref": "#/components/schemas/Error" 5346 } 5347 } 5348 } 5349 } 5350 } 5351 } 5352 }, 5353 "/api/accounts_mgmt/v1/subscriptions/{subscription_id}/role_bindings": { 5354 "post": { 5355 "description": "Creates a new role binding.", 5356 "parameters": [ 5357 { 5358 "name": "subscription_id", 5359 "in": "path", 5360 "schema": { 5361 "type": "string" 5362 }, 5363 "required": true 5364 } 5365 ], 5366 "requestBody": { 5367 "content": { 5368 "application/json": { 5369 "schema": { 5370 "$ref": "#/components/schemas/RoleBinding" 5371 } 5372 } 5373 } 5374 }, 5375 "responses": { 5376 "201": { 5377 "description": "Success.", 5378 "content": { 5379 "application/json": { 5380 "schema": { 5381 "$ref": "#/components/schemas/RoleBinding" 5382 } 5383 } 5384 } 5385 }, 5386 "default": { 5387 "description": "Error.", 5388 "content": { 5389 "application/json": { 5390 "schema": { 5391 "$ref": "#/components/schemas/Error" 5392 } 5393 } 5394 } 5395 } 5396 } 5397 }, 5398 "get": { 5399 "description": "Retrieves a list of role bindings.", 5400 "parameters": [ 5401 { 5402 "name": "subscription_id", 5403 "in": "path", 5404 "schema": { 5405 "type": "string" 5406 }, 5407 "required": true 5408 }, 5409 { 5410 "name": "page", 5411 "description": "Index of the requested page, where one corresponds to the first page.", 5412 "in": "query", 5413 "schema": { 5414 "type": "integer", 5415 "format": "int32" 5416 } 5417 }, 5418 { 5419 "name": "search", 5420 "description": "Search criteria.\n\nThe syntax of this parameter is similar to the syntax of the _where_ clause\nof an SQL statement, but using the names of the attributes of the role binding\ninstead of the names of the columns of a table. For example, in order to\nretrieve role bindings with role_id AuthenticatedUser:\n\n```sql\nrole_id = 'AuthenticatedUser'\n```\n\nIf the parameter isn't provided, or if the value is empty, then all the\nitems that the user has permission to see will be returned.", 5421 "in": "query", 5422 "schema": { 5423 "type": "string" 5424 } 5425 }, 5426 { 5427 "name": "size", 5428 "description": "Maximum number of items that will be contained in the returned page.", 5429 "in": "query", 5430 "schema": { 5431 "type": "integer", 5432 "format": "int32" 5433 } 5434 } 5435 ], 5436 "responses": { 5437 "200": { 5438 "description": "Success.", 5439 "content": { 5440 "application/json": { 5441 "schema": { 5442 "type": "object", 5443 "properties": { 5444 "items": { 5445 "description": "Retrieved list of role bindings.", 5446 "type": "array", 5447 "items": { 5448 "$ref": "#/components/schemas/RoleBinding" 5449 } 5450 }, 5451 "page": { 5452 "description": "Index of the requested page, where one corresponds to the first page.", 5453 "type": "integer", 5454 "format": "int32" 5455 }, 5456 "size": { 5457 "description": "Maximum number of items that will be contained in the returned page.", 5458 "type": "integer", 5459 "format": "int32" 5460 }, 5461 "total": { 5462 "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.", 5463 "type": "integer", 5464 "format": "int32" 5465 } 5466 } 5467 } 5468 } 5469 } 5470 }, 5471 "default": { 5472 "description": "Error.", 5473 "content": { 5474 "application/json": { 5475 "schema": { 5476 "$ref": "#/components/schemas/Error" 5477 } 5478 } 5479 } 5480 } 5481 } 5482 } 5483 }, 5484 "/api/accounts_mgmt/v1/subscriptions/{subscription_id}/role_bindings/{role_binding_id}": { 5485 "delete": { 5486 "description": "Deletes the role binding.", 5487 "parameters": [ 5488 { 5489 "name": "subscription_id", 5490 "in": "path", 5491 "schema": { 5492 "type": "string" 5493 }, 5494 "required": true 5495 }, 5496 { 5497 "name": "role_binding_id", 5498 "in": "path", 5499 "schema": { 5500 "type": "string" 5501 }, 5502 "required": true 5503 } 5504 ], 5505 "responses": { 5506 "204": { 5507 "description": "Success." 5508 }, 5509 "default": { 5510 "description": "Error.", 5511 "content": { 5512 "application/json": { 5513 "schema": { 5514 "$ref": "#/components/schemas/Error" 5515 } 5516 } 5517 } 5518 } 5519 } 5520 }, 5521 "get": { 5522 "description": "Retrieves the details of the role binding.", 5523 "parameters": [ 5524 { 5525 "name": "subscription_id", 5526 "in": "path", 5527 "schema": { 5528 "type": "string" 5529 }, 5530 "required": true 5531 }, 5532 { 5533 "name": "role_binding_id", 5534 "in": "path", 5535 "schema": { 5536 "type": "string" 5537 }, 5538 "required": true 5539 } 5540 ], 5541 "responses": { 5542 "200": { 5543 "description": "Success.", 5544 "content": { 5545 "application/json": { 5546 "schema": { 5547 "$ref": "#/components/schemas/RoleBinding" 5548 } 5549 } 5550 } 5551 }, 5552 "default": { 5553 "description": "Error.", 5554 "content": { 5555 "application/json": { 5556 "schema": { 5557 "$ref": "#/components/schemas/Error" 5558 } 5559 } 5560 } 5561 } 5562 } 5563 }, 5564 "patch": { 5565 "description": "Updates the account.", 5566 "parameters": [ 5567 { 5568 "name": "subscription_id", 5569 "in": "path", 5570 "schema": { 5571 "type": "string" 5572 }, 5573 "required": true 5574 }, 5575 { 5576 "name": "role_binding_id", 5577 "in": "path", 5578 "schema": { 5579 "type": "string" 5580 }, 5581 "required": true 5582 } 5583 ], 5584 "requestBody": { 5585 "content": { 5586 "application/json": { 5587 "schema": { 5588 "$ref": "#/components/schemas/RoleBinding" 5589 } 5590 } 5591 } 5592 }, 5593 "responses": { 5594 "200": { 5595 "description": "Success.", 5596 "content": { 5597 "application/json": { 5598 "schema": { 5599 "$ref": "#/components/schemas/RoleBinding" 5600 } 5601 } 5602 } 5603 }, 5604 "default": { 5605 "description": "Error.", 5606 "content": { 5607 "application/json": { 5608 "schema": { 5609 "$ref": "#/components/schemas/Error" 5610 } 5611 } 5612 } 5613 } 5614 } 5615 } 5616 }, 5617 "/api/accounts_mgmt/v1/support_cases": { 5618 "post": { 5619 "description": "Create a support case related to Hydra", 5620 "requestBody": { 5621 "content": { 5622 "application/json": { 5623 "schema": { 5624 "$ref": "#/components/schemas/SupportCaseRequest" 5625 } 5626 } 5627 } 5628 }, 5629 "responses": { 5630 "201": { 5631 "description": "Success.", 5632 "content": { 5633 "application/json": { 5634 "schema": { 5635 "$ref": "#/components/schemas/SupportCaseResponse" 5636 } 5637 } 5638 } 5639 }, 5640 "default": { 5641 "description": "Error.", 5642 "content": { 5643 "application/json": { 5644 "schema": { 5645 "$ref": "#/components/schemas/Error" 5646 } 5647 } 5648 } 5649 } 5650 } 5651 } 5652 }, 5653 "/api/accounts_mgmt/v1/support_cases/{support_case_id}": { 5654 "delete": { 5655 "description": "Deletes the support case by Case ID.", 5656 "parameters": [ 5657 { 5658 "name": "support_case_id", 5659 "in": "path", 5660 "schema": { 5661 "type": "string" 5662 }, 5663 "required": true 5664 } 5665 ], 5666 "responses": { 5667 "204": { 5668 "description": "Success." 5669 }, 5670 "default": { 5671 "description": "Error.", 5672 "content": { 5673 "application/json": { 5674 "schema": { 5675 "$ref": "#/components/schemas/Error" 5676 } 5677 } 5678 } 5679 } 5680 } 5681 } 5682 }, 5683 "/api/accounts_mgmt/v1/token_authorization": { 5684 "post": { 5685 "description": "Returns a specific account based on the given pull secret", 5686 "requestBody": { 5687 "content": { 5688 "application/json": { 5689 "schema": { 5690 "$ref": "#/components/schemas/TokenAuthorizationRequest" 5691 } 5692 } 5693 } 5694 }, 5695 "responses": { 5696 "201": { 5697 "description": "Success.", 5698 "content": { 5699 "application/json": { 5700 "schema": { 5701 "$ref": "#/components/schemas/TokenAuthorizationResponse" 5702 } 5703 } 5704 } 5705 }, 5706 "default": { 5707 "description": "Error.", 5708 "content": { 5709 "application/json": { 5710 "schema": { 5711 "$ref": "#/components/schemas/Error" 5712 } 5713 } 5714 } 5715 } 5716 } 5717 } 5718 } 5719 }, 5720 "components": { 5721 "schemas": { 5722 "Metadata": { 5723 "description": "Version metadata.", 5724 "properties": { 5725 "server_version": { 5726 "description": "Version of the server.", 5727 "type": "string" 5728 } 5729 } 5730 }, 5731 "AccessToken": { 5732 "properties": { 5733 "auths": { 5734 "type": "object", 5735 "additionalProperties": { 5736 "$ref": "#/components/schemas/AccessTokenAuth" 5737 } 5738 } 5739 } 5740 }, 5741 "AccessTokenAuth": { 5742 "properties": { 5743 "auth": { 5744 "type": "string" 5745 }, 5746 "email": { 5747 "type": "string" 5748 } 5749 } 5750 }, 5751 "Account": { 5752 "properties": { 5753 "kind": { 5754 "description": "Indicates the type of this object. Will be 'Account' if this is a complete object or 'AccountLink' if it is just a link.", 5755 "type": "string" 5756 }, 5757 "id": { 5758 "description": "Unique identifier of the object.", 5759 "type": "string" 5760 }, 5761 "href": { 5762 "description": "Self link.", 5763 "type": "string" 5764 }, 5765 "ban_code": { 5766 "type": "string" 5767 }, 5768 "ban_description": { 5769 "type": "string" 5770 }, 5771 "banned": { 5772 "type": "boolean" 5773 }, 5774 "capabilities": { 5775 "type": "array", 5776 "items": { 5777 "$ref": "#/components/schemas/Capability" 5778 } 5779 }, 5780 "created_at": { 5781 "type": "string", 5782 "format": "date-time" 5783 }, 5784 "email": { 5785 "type": "string" 5786 }, 5787 "first_name": { 5788 "type": "string" 5789 }, 5790 "labels": { 5791 "type": "array", 5792 "items": { 5793 "$ref": "#/components/schemas/Label" 5794 } 5795 }, 5796 "last_name": { 5797 "type": "string" 5798 }, 5799 "organization": { 5800 "$ref": "#/components/schemas/Organization" 5801 }, 5802 "rhit_account_id": { 5803 "description": "RhitAccountID will be deprecated in favor of RhitWebUserId", 5804 "type": "string" 5805 }, 5806 "rhit_web_user_id": { 5807 "type": "string" 5808 }, 5809 "service_account": { 5810 "type": "boolean" 5811 }, 5812 "updated_at": { 5813 "type": "string", 5814 "format": "date-time" 5815 }, 5816 "username": { 5817 "type": "string" 5818 } 5819 } 5820 }, 5821 "Action": { 5822 "description": "Possible actions for a permission.", 5823 "type": "string", 5824 "enum": [ 5825 "create", 5826 "delete", 5827 "get", 5828 "list", 5829 "update" 5830 ] 5831 }, 5832 "BillingModel": { 5833 "description": "Billing model for subscripiton and reserved_resource resources.", 5834 "type": "string", 5835 "enum": [ 5836 "marketplace", 5837 "marketplace-aws", 5838 "marketplace-gcp", 5839 "marketplace-rhm", 5840 "marketplace-azure", 5841 "standard" 5842 ] 5843 }, 5844 "BillingModelItem": { 5845 "description": "BillingModelItem represents a billing model", 5846 "properties": { 5847 "kind": { 5848 "description": "Indicates the type of this object. Will be 'BillingModelItem' if this is a complete object or 'BillingModelItemLink' if it is just a link.", 5849 "type": "string" 5850 }, 5851 "id": { 5852 "description": "Unique identifier of the object.", 5853 "type": "string" 5854 }, 5855 "href": { 5856 "description": "Self link.", 5857 "type": "string" 5858 }, 5859 "billing_model_type": { 5860 "description": "BillingModelType is the type of the BillingModel. e.g. standard, marketplace.", 5861 "type": "string" 5862 }, 5863 "description": { 5864 "description": "Single line description of the billing model.", 5865 "type": "string" 5866 }, 5867 "display_name": { 5868 "description": "User friendly display name of the billing model.", 5869 "type": "string" 5870 }, 5871 "marketplace": { 5872 "description": "Indicates the marketplace of the billing model. e.g. gcp, aws, etc.", 5873 "type": "string" 5874 } 5875 } 5876 }, 5877 "Capability": { 5878 "description": "Capability model that represents internal labels with a key that matches a set list defined in AMS (defined in pkg/api/capability_types.go).", 5879 "properties": { 5880 "inherited": { 5881 "description": "Dynamic attribute of the capability that tells us that this capability was inherited from the subscription's organization. ", 5882 "type": "boolean" 5883 }, 5884 "name": { 5885 "description": "Name of the capability label.", 5886 "type": "string" 5887 }, 5888 "value": { 5889 "description": "Value that can be assigned to the capability (eg. \"true\", \"false\" etc).", 5890 "type": "string" 5891 } 5892 } 5893 }, 5894 "CloudAccount": { 5895 "properties": { 5896 "cloud_account_id": { 5897 "type": "string" 5898 }, 5899 "cloud_provider_id": { 5900 "type": "string" 5901 }, 5902 "contracts": { 5903 "type": "array", 5904 "items": { 5905 "$ref": "#/components/schemas/Contract" 5906 } 5907 } 5908 } 5909 }, 5910 "CloudResource": { 5911 "properties": { 5912 "kind": { 5913 "description": "Indicates the type of this object. Will be 'CloudResource' if this is a complete object or 'CloudResourceLink' if it is just a link.", 5914 "type": "string" 5915 }, 5916 "id": { 5917 "description": "Unique identifier of the object.", 5918 "type": "string" 5919 }, 5920 "href": { 5921 "description": "Self link.", 5922 "type": "string" 5923 }, 5924 "active": { 5925 "type": "boolean" 5926 }, 5927 "category": { 5928 "type": "string" 5929 }, 5930 "category_pretty": { 5931 "type": "string" 5932 }, 5933 "cloud_provider": { 5934 "type": "string" 5935 }, 5936 "cpu_cores": { 5937 "type": "integer", 5938 "format": "int32" 5939 }, 5940 "created_at": { 5941 "type": "string", 5942 "format": "date-time" 5943 }, 5944 "generic_name": { 5945 "type": "string" 5946 }, 5947 "memory": { 5948 "type": "integer", 5949 "format": "int32" 5950 }, 5951 "memory_pretty": { 5952 "type": "string" 5953 }, 5954 "name_pretty": { 5955 "type": "string" 5956 }, 5957 "resource_type": { 5958 "type": "string" 5959 }, 5960 "size_pretty": { 5961 "type": "string" 5962 }, 5963 "updated_at": { 5964 "type": "string", 5965 "format": "date-time" 5966 } 5967 } 5968 }, 5969 "ClusterAuthorizationRequest": { 5970 "properties": { 5971 "byoc": { 5972 "type": "boolean" 5973 }, 5974 "account_username": { 5975 "type": "string" 5976 }, 5977 "availability_zone": { 5978 "type": "string" 5979 }, 5980 "cloud_account_id": { 5981 "type": "string" 5982 }, 5983 "cloud_provider_id": { 5984 "type": "string" 5985 }, 5986 "cluster_id": { 5987 "type": "string" 5988 }, 5989 "disconnected": { 5990 "type": "boolean" 5991 }, 5992 "display_name": { 5993 "type": "string" 5994 }, 5995 "external_cluster_id": { 5996 "type": "string" 5997 }, 5998 "managed": { 5999 "type": "boolean" 6000 }, 6001 "product_id": { 6002 "type": "string" 6003 }, 6004 "product_category": { 6005 "type": "string" 6006 }, 6007 "quota_version": { 6008 "type": "string" 6009 }, 6010 "reserve": { 6011 "type": "boolean" 6012 }, 6013 "resources": { 6014 "type": "array", 6015 "items": { 6016 "$ref": "#/components/schemas/ReservedResource" 6017 } 6018 }, 6019 "rh_region_id": { 6020 "type": "string" 6021 }, 6022 "scope": { 6023 "type": "string" 6024 } 6025 } 6026 }, 6027 "ClusterAuthorizationResponse": { 6028 "properties": { 6029 "allowed": { 6030 "type": "boolean" 6031 }, 6032 "excess_resources": { 6033 "type": "array", 6034 "items": { 6035 "$ref": "#/components/schemas/ReservedResource" 6036 } 6037 }, 6038 "subscription": { 6039 "$ref": "#/components/schemas/Subscription" 6040 } 6041 } 6042 }, 6043 "ClusterMetricsNodes": { 6044 "properties": { 6045 "compute": { 6046 "type": "number", 6047 "format": "float" 6048 }, 6049 "infra": { 6050 "type": "number", 6051 "format": "float" 6052 }, 6053 "master": { 6054 "type": "number", 6055 "format": "float" 6056 }, 6057 "total": { 6058 "type": "number", 6059 "format": "float" 6060 } 6061 } 6062 }, 6063 "ClusterRegistrationRequest": { 6064 "properties": { 6065 "authorization_token": { 6066 "type": "string" 6067 }, 6068 "cluster_id": { 6069 "type": "string" 6070 } 6071 } 6072 }, 6073 "ClusterRegistrationResponse": { 6074 "properties": { 6075 "account_id": { 6076 "type": "string" 6077 }, 6078 "authorization_token": { 6079 "type": "string" 6080 }, 6081 "cluster_id": { 6082 "type": "string" 6083 }, 6084 "expires_at": { 6085 "description": "Cluster registration expiration.", 6086 "type": "string" 6087 } 6088 } 6089 }, 6090 "ClusterResource": { 6091 "properties": { 6092 "total": { 6093 "$ref": "#/components/schemas/ValueUnit" 6094 }, 6095 "updated_timestamp": { 6096 "type": "string", 6097 "format": "date-time" 6098 }, 6099 "used": { 6100 "$ref": "#/components/schemas/ValueUnit" 6101 } 6102 } 6103 }, 6104 "ClusterUpgrade": { 6105 "properties": { 6106 "available": { 6107 "type": "boolean" 6108 }, 6109 "state": { 6110 "type": "string" 6111 }, 6112 "updated_timestamp": { 6113 "type": "string", 6114 "format": "date-time" 6115 }, 6116 "version": { 6117 "type": "string" 6118 } 6119 } 6120 }, 6121 "Contract": { 6122 "properties": { 6123 "dimensions": { 6124 "type": "array", 6125 "items": { 6126 "$ref": "#/components/schemas/ContractDimension" 6127 } 6128 }, 6129 "end_date": { 6130 "type": "string", 6131 "format": "date-time" 6132 }, 6133 "start_date": { 6134 "type": "string", 6135 "format": "date-time" 6136 } 6137 } 6138 }, 6139 "ContractDimension": { 6140 "properties": { 6141 "name": { 6142 "type": "string" 6143 }, 6144 "value": { 6145 "type": "string" 6146 } 6147 } 6148 }, 6149 "DefaultCapability": { 6150 "properties": { 6151 "name": { 6152 "description": "Name of the default capability (the key).", 6153 "type": "string" 6154 }, 6155 "value": { 6156 "description": "Value of the default capability.", 6157 "type": "string" 6158 } 6159 } 6160 }, 6161 "DeletedSubscription": { 6162 "properties": { 6163 "kind": { 6164 "description": "Indicates the type of this object. Will be 'DeletedSubscription' if this is a complete object or 'DeletedSubscriptionLink' if it is just a link.", 6165 "type": "string" 6166 }, 6167 "id": { 6168 "description": "Unique identifier of the object.", 6169 "type": "string" 6170 }, 6171 "href": { 6172 "description": "Self link.", 6173 "type": "string" 6174 }, 6175 "billing_expiration_date": { 6176 "type": "string", 6177 "format": "date-time" 6178 }, 6179 "billing_marketplace_account": { 6180 "type": "string" 6181 }, 6182 "cloud_account_id": { 6183 "type": "string" 6184 }, 6185 "cloud_provider_id": { 6186 "type": "string" 6187 }, 6188 "cluster_id": { 6189 "type": "string" 6190 }, 6191 "cluster_billing_model": { 6192 "$ref": "#/components/schemas/BillingModel" 6193 }, 6194 "console_url": { 6195 "type": "string" 6196 }, 6197 "consumer_uuid": { 6198 "type": "string" 6199 }, 6200 "cpu_total": { 6201 "type": "integer", 6202 "format": "int32" 6203 }, 6204 "created_at": { 6205 "type": "string", 6206 "format": "date-time" 6207 }, 6208 "creator_id": { 6209 "type": "string" 6210 }, 6211 "display_name": { 6212 "type": "string" 6213 }, 6214 "external_cluster_id": { 6215 "type": "string" 6216 }, 6217 "last_reconcile_date": { 6218 "type": "string", 6219 "format": "date-time" 6220 }, 6221 "last_released_at": { 6222 "type": "string", 6223 "format": "date-time" 6224 }, 6225 "last_telemetry_date": { 6226 "type": "string", 6227 "format": "date-time" 6228 }, 6229 "managed": { 6230 "type": "boolean" 6231 }, 6232 "metrics": { 6233 "type": "string" 6234 }, 6235 "organization_id": { 6236 "type": "string" 6237 }, 6238 "plan_id": { 6239 "type": "string" 6240 }, 6241 "product_bundle": { 6242 "type": "string" 6243 }, 6244 "provenance": { 6245 "type": "string" 6246 }, 6247 "query_timestamp": { 6248 "type": "string", 6249 "format": "date-time" 6250 }, 6251 "region_id": { 6252 "type": "string" 6253 }, 6254 "released": { 6255 "type": "boolean" 6256 }, 6257 "service_level": { 6258 "type": "string" 6259 }, 6260 "socket_total": { 6261 "type": "integer", 6262 "format": "int32" 6263 }, 6264 "status": { 6265 "type": "string" 6266 }, 6267 "support_level": { 6268 "type": "string" 6269 }, 6270 "system_units": { 6271 "type": "string" 6272 }, 6273 "trial_end_date": { 6274 "type": "string", 6275 "format": "date-time" 6276 }, 6277 "usage": { 6278 "type": "string" 6279 } 6280 } 6281 }, 6282 "FeatureToggle": { 6283 "properties": { 6284 "kind": { 6285 "description": "Indicates the type of this object. Will be 'FeatureToggle' if this is a complete object or 'FeatureToggleLink' if it is just a link.", 6286 "type": "string" 6287 }, 6288 "id": { 6289 "description": "Unique identifier of the object.", 6290 "type": "string" 6291 }, 6292 "href": { 6293 "description": "Self link.", 6294 "type": "string" 6295 }, 6296 "enabled": { 6297 "type": "boolean" 6298 } 6299 } 6300 }, 6301 "FeatureToggleQueryRequest": { 6302 "properties": { 6303 "organization_id": { 6304 "type": "string" 6305 } 6306 } 6307 }, 6308 "GenericNotifyDetailsResponse": { 6309 "description": "class that defines notify details response in general.", 6310 "properties": { 6311 "kind": { 6312 "description": "Indicates the type of this object. Will be 'GenericNotifyDetailsResponse' if this is a complete object or 'GenericNotifyDetailsResponseLink' if it is just a link.", 6313 "type": "string" 6314 }, 6315 "id": { 6316 "description": "Unique identifier of the object.", 6317 "type": "string" 6318 }, 6319 "href": { 6320 "description": "Self link.", 6321 "type": "string" 6322 }, 6323 "associates": { 6324 "description": "Retrieved List of associates email address.", 6325 "type": "array", 6326 "items": { 6327 "type": "string" 6328 } 6329 }, 6330 "items": { 6331 "description": "Retrieved list of additional notify details parameters key-value.", 6332 "type": "array", 6333 "items": { 6334 "$ref": "#/components/schemas/NotificationDetailsResponse" 6335 } 6336 }, 6337 "recipients": { 6338 "description": "Retrieved List of recipients username.", 6339 "type": "array", 6340 "items": { 6341 "type": "string" 6342 } 6343 } 6344 } 6345 }, 6346 "Label": { 6347 "properties": { 6348 "kind": { 6349 "description": "Indicates the type of this object. Will be 'Label' if this is a complete object or 'LabelLink' if it is just a link.", 6350 "type": "string" 6351 }, 6352 "id": { 6353 "description": "Unique identifier of the object.", 6354 "type": "string" 6355 }, 6356 "href": { 6357 "description": "Self link.", 6358 "type": "string" 6359 }, 6360 "account_id": { 6361 "type": "string" 6362 }, 6363 "created_at": { 6364 "type": "string", 6365 "format": "date-time" 6366 }, 6367 "internal": { 6368 "type": "boolean" 6369 }, 6370 "key": { 6371 "type": "string" 6372 }, 6373 "managed_by": { 6374 "type": "string" 6375 }, 6376 "organization_id": { 6377 "type": "string" 6378 }, 6379 "subscription_id": { 6380 "type": "string" 6381 }, 6382 "type": { 6383 "type": "string" 6384 }, 6385 "updated_at": { 6386 "type": "string", 6387 "format": "date-time" 6388 }, 6389 "value": { 6390 "type": "string" 6391 } 6392 } 6393 }, 6394 "NotificationDetailsRequest": { 6395 "description": "This struct is a request to get a templated email to a user related to this.\nsubscription/cluster.", 6396 "properties": { 6397 "bcc_address": { 6398 "description": "The BCC address to be included on the email that is sent.", 6399 "type": "string" 6400 }, 6401 "cluster_id": { 6402 "description": "Indicates which Cluster (internal id) the resource type belongs to.", 6403 "type": "string" 6404 }, 6405 "cluster_uuid": { 6406 "description": "Indicates which Cluster (external id) the resource type belongs to.", 6407 "type": "string" 6408 }, 6409 "include_red_hat_associates": { 6410 "description": "Indicates whether to include red hat associates in the email notification.", 6411 "type": "boolean" 6412 }, 6413 "internal_only": { 6414 "description": "Indicates whether the service log is internal only to RH.", 6415 "type": "boolean" 6416 }, 6417 "log_type": { 6418 "description": "Indicates the type of the service log.", 6419 "type": "string" 6420 }, 6421 "subject": { 6422 "description": "The email subject.", 6423 "type": "string" 6424 }, 6425 "subscription_id": { 6426 "description": "Indicates which Subscription the resource type belongs to.", 6427 "type": "string" 6428 } 6429 } 6430 }, 6431 "NotificationDetailsResponse": { 6432 "description": "This class is a single response item for the notify details list.", 6433 "properties": { 6434 "kind": { 6435 "description": "Indicates the type of this object. Will be 'NotificationDetailsResponse' if this is a complete object or 'NotificationDetailsResponseLink' if it is just a link.", 6436 "type": "string" 6437 }, 6438 "id": { 6439 "description": "Unique identifier of the object.", 6440 "type": "string" 6441 }, 6442 "href": { 6443 "description": "Self link.", 6444 "type": "string" 6445 }, 6446 "key": { 6447 "description": "Indicates the key of the response parameter.", 6448 "type": "string" 6449 }, 6450 "value": { 6451 "description": "Indicates the value of the response parameter.", 6452 "type": "string" 6453 } 6454 } 6455 }, 6456 "Organization": { 6457 "properties": { 6458 "kind": { 6459 "description": "Indicates the type of this object. Will be 'Organization' if this is a complete object or 'OrganizationLink' if it is just a link.", 6460 "type": "string" 6461 }, 6462 "id": { 6463 "description": "Unique identifier of the object.", 6464 "type": "string" 6465 }, 6466 "href": { 6467 "description": "Self link.", 6468 "type": "string" 6469 }, 6470 "capabilities": { 6471 "type": "array", 6472 "items": { 6473 "$ref": "#/components/schemas/Capability" 6474 } 6475 }, 6476 "created_at": { 6477 "type": "string", 6478 "format": "date-time" 6479 }, 6480 "ebs_account_id": { 6481 "type": "string" 6482 }, 6483 "external_id": { 6484 "type": "string" 6485 }, 6486 "labels": { 6487 "type": "array", 6488 "items": { 6489 "$ref": "#/components/schemas/Label" 6490 } 6491 }, 6492 "name": { 6493 "type": "string" 6494 }, 6495 "updated_at": { 6496 "type": "string", 6497 "format": "date-time" 6498 } 6499 } 6500 }, 6501 "Permission": { 6502 "properties": { 6503 "kind": { 6504 "description": "Indicates the type of this object. Will be 'Permission' if this is a complete object or 'PermissionLink' if it is just a link.", 6505 "type": "string" 6506 }, 6507 "id": { 6508 "description": "Unique identifier of the object.", 6509 "type": "string" 6510 }, 6511 "href": { 6512 "description": "Self link.", 6513 "type": "string" 6514 }, 6515 "action": { 6516 "$ref": "#/components/schemas/Action" 6517 }, 6518 "resource": { 6519 "type": "string" 6520 } 6521 } 6522 }, 6523 "Plan": { 6524 "properties": { 6525 "kind": { 6526 "description": "Indicates the type of this object. Will be 'Plan' if this is a complete object or 'PlanLink' if it is just a link.", 6527 "type": "string" 6528 }, 6529 "id": { 6530 "description": "Unique identifier of the object.", 6531 "type": "string" 6532 }, 6533 "href": { 6534 "description": "Self link.", 6535 "type": "string" 6536 }, 6537 "category": { 6538 "type": "string" 6539 }, 6540 "name": { 6541 "type": "string" 6542 }, 6543 "type": { 6544 "type": "string" 6545 } 6546 } 6547 }, 6548 "PlanID": { 6549 "description": "Plan ID of subscription.", 6550 "type": "string", 6551 "enum": [ 6552 "ocp" 6553 ] 6554 }, 6555 "PullSecretsRequest": { 6556 "properties": { 6557 "external_resource_id": { 6558 "type": "string" 6559 } 6560 } 6561 }, 6562 "QuotaAuthorizationRequest": { 6563 "properties": { 6564 "account_username": { 6565 "type": "string" 6566 }, 6567 "availability_zone": { 6568 "type": "string" 6569 }, 6570 "display_name": { 6571 "type": "string" 6572 }, 6573 "product_id": { 6574 "type": "string" 6575 }, 6576 "product_category": { 6577 "type": "string" 6578 }, 6579 "quota_version": { 6580 "type": "string" 6581 }, 6582 "reserve": { 6583 "type": "boolean" 6584 }, 6585 "resources": { 6586 "type": "array", 6587 "items": { 6588 "$ref": "#/components/schemas/ReservedResource" 6589 } 6590 } 6591 } 6592 }, 6593 "QuotaAuthorizationResponse": { 6594 "properties": { 6595 "allowed": { 6596 "type": "boolean" 6597 }, 6598 "excess_resources": { 6599 "type": "array", 6600 "items": { 6601 "$ref": "#/components/schemas/ReservedResource" 6602 } 6603 }, 6604 "subscription": { 6605 "$ref": "#/components/schemas/Subscription" 6606 } 6607 } 6608 }, 6609 "QuotaCost": { 6610 "properties": { 6611 "allowed": { 6612 "type": "integer", 6613 "format": "int32" 6614 }, 6615 "cloud_accounts": { 6616 "type": "array", 6617 "items": { 6618 "$ref": "#/components/schemas/CloudAccount" 6619 } 6620 }, 6621 "consumed": { 6622 "type": "integer", 6623 "format": "int32" 6624 }, 6625 "organization_id": { 6626 "type": "string" 6627 }, 6628 "quota_id": { 6629 "type": "string" 6630 }, 6631 "related_resources": { 6632 "type": "array", 6633 "items": { 6634 "$ref": "#/components/schemas/RelatedResource" 6635 } 6636 }, 6637 "version": { 6638 "type": "string" 6639 } 6640 } 6641 }, 6642 "QuotaRules": { 6643 "properties": { 6644 "availability_zone": { 6645 "type": "string" 6646 }, 6647 "billing_model": { 6648 "type": "string" 6649 }, 6650 "byoc": { 6651 "type": "string" 6652 }, 6653 "cloud": { 6654 "type": "string" 6655 }, 6656 "cost": { 6657 "type": "integer", 6658 "format": "int32" 6659 }, 6660 "name": { 6661 "type": "string" 6662 }, 6663 "product": { 6664 "type": "string" 6665 }, 6666 "quota_id": { 6667 "type": "string" 6668 } 6669 } 6670 }, 6671 "Registry": { 6672 "properties": { 6673 "kind": { 6674 "description": "Indicates the type of this object. Will be 'Registry' if this is a complete object or 'RegistryLink' if it is just a link.", 6675 "type": "string" 6676 }, 6677 "id": { 6678 "description": "Unique identifier of the object.", 6679 "type": "string" 6680 }, 6681 "href": { 6682 "description": "Self link.", 6683 "type": "string" 6684 }, 6685 "url": { 6686 "type": "string" 6687 }, 6688 "cloud_alias": { 6689 "type": "boolean" 6690 }, 6691 "created_at": { 6692 "type": "string", 6693 "format": "date-time" 6694 }, 6695 "name": { 6696 "type": "string" 6697 }, 6698 "org_name": { 6699 "type": "string" 6700 }, 6701 "team_name": { 6702 "type": "string" 6703 }, 6704 "type": { 6705 "type": "string" 6706 }, 6707 "updated_at": { 6708 "type": "string", 6709 "format": "date-time" 6710 } 6711 } 6712 }, 6713 "RegistryCredential": { 6714 "properties": { 6715 "kind": { 6716 "description": "Indicates the type of this object. Will be 'RegistryCredential' if this is a complete object or 'RegistryCredentialLink' if it is just a link.", 6717 "type": "string" 6718 }, 6719 "id": { 6720 "description": "Unique identifier of the object.", 6721 "type": "string" 6722 }, 6723 "href": { 6724 "description": "Self link.", 6725 "type": "string" 6726 }, 6727 "account": { 6728 "$ref": "#/components/schemas/Account" 6729 }, 6730 "created_at": { 6731 "type": "string", 6732 "format": "date-time" 6733 }, 6734 "external_resource_id": { 6735 "type": "string" 6736 }, 6737 "registry": { 6738 "$ref": "#/components/schemas/Registry" 6739 }, 6740 "token": { 6741 "type": "string" 6742 }, 6743 "updated_at": { 6744 "type": "string", 6745 "format": "date-time" 6746 }, 6747 "username": { 6748 "type": "string" 6749 } 6750 } 6751 }, 6752 "RelatedResource": { 6753 "description": "Resource which can be provisioned using the allowed quota.", 6754 "properties": { 6755 "byoc": { 6756 "type": "string" 6757 }, 6758 "availability_zone_type": { 6759 "type": "string" 6760 }, 6761 "billing_model": { 6762 "type": "string" 6763 }, 6764 "cloud_provider": { 6765 "type": "string" 6766 }, 6767 "cost": { 6768 "type": "integer", 6769 "format": "int32" 6770 }, 6771 "product": { 6772 "type": "string" 6773 }, 6774 "resource_name": { 6775 "type": "string" 6776 }, 6777 "resource_type": { 6778 "type": "string" 6779 } 6780 } 6781 }, 6782 "ReservedResource": { 6783 "properties": { 6784 "byoc": { 6785 "type": "boolean" 6786 }, 6787 "availability_zone_type": { 6788 "type": "string" 6789 }, 6790 "billing_marketplace_account": { 6791 "type": "string" 6792 }, 6793 "billing_model": { 6794 "$ref": "#/components/schemas/BillingModel" 6795 }, 6796 "count": { 6797 "type": "integer", 6798 "format": "int32" 6799 }, 6800 "created_at": { 6801 "type": "string", 6802 "format": "date-time" 6803 }, 6804 "resource_name": { 6805 "type": "string" 6806 }, 6807 "resource_type": { 6808 "type": "string" 6809 }, 6810 "scope": { 6811 "type": "string" 6812 }, 6813 "updated_at": { 6814 "type": "string", 6815 "format": "date-time" 6816 } 6817 } 6818 }, 6819 "Resource": { 6820 "description": "Identifies computing resources", 6821 "properties": { 6822 "kind": { 6823 "description": "Indicates the type of this object. Will be 'Resource' if this is a complete object or 'ResourceLink' if it is just a link.", 6824 "type": "string" 6825 }, 6826 "id": { 6827 "description": "Unique identifier of the object.", 6828 "type": "string" 6829 }, 6830 "href": { 6831 "description": "Self link.", 6832 "type": "string" 6833 }, 6834 "byoc": { 6835 "type": "boolean" 6836 }, 6837 "sku": { 6838 "type": "string" 6839 }, 6840 "allowed": { 6841 "description": "Number of allowed nodes", 6842 "type": "integer", 6843 "format": "int32" 6844 }, 6845 "availability_zone_type": { 6846 "type": "string" 6847 }, 6848 "resource_name": { 6849 "description": "platform-specific name, such as \"M5.2Xlarge\" for a type of EC2 node", 6850 "type": "string" 6851 }, 6852 "resource_type": { 6853 "type": "string" 6854 } 6855 } 6856 }, 6857 "ResourceQuota": { 6858 "properties": { 6859 "kind": { 6860 "description": "Indicates the type of this object. Will be 'ResourceQuota' if this is a complete object or 'ResourceQuotaLink' if it is just a link.", 6861 "type": "string" 6862 }, 6863 "id": { 6864 "description": "Unique identifier of the object.", 6865 "type": "string" 6866 }, 6867 "href": { 6868 "description": "Self link.", 6869 "type": "string" 6870 }, 6871 "sku": { 6872 "type": "string" 6873 }, 6874 "created_at": { 6875 "type": "string", 6876 "format": "date-time" 6877 }, 6878 "organization_id": { 6879 "type": "string" 6880 }, 6881 "sku_count": { 6882 "type": "integer", 6883 "format": "int32" 6884 }, 6885 "type": { 6886 "type": "string" 6887 }, 6888 "updated_at": { 6889 "type": "string", 6890 "format": "date-time" 6891 } 6892 } 6893 }, 6894 "Role": { 6895 "properties": { 6896 "kind": { 6897 "description": "Indicates the type of this object. Will be 'Role' if this is a complete object or 'RoleLink' if it is just a link.", 6898 "type": "string" 6899 }, 6900 "id": { 6901 "description": "Unique identifier of the object.", 6902 "type": "string" 6903 }, 6904 "href": { 6905 "description": "Self link.", 6906 "type": "string" 6907 }, 6908 "name": { 6909 "type": "string" 6910 }, 6911 "permissions": { 6912 "type": "array", 6913 "items": { 6914 "$ref": "#/components/schemas/Permission" 6915 } 6916 } 6917 } 6918 }, 6919 "RoleBinding": { 6920 "properties": { 6921 "kind": { 6922 "description": "Indicates the type of this object. Will be 'RoleBinding' if this is a complete object or 'RoleBindingLink' if it is just a link.", 6923 "type": "string" 6924 }, 6925 "id": { 6926 "description": "Unique identifier of the object.", 6927 "type": "string" 6928 }, 6929 "href": { 6930 "description": "Self link.", 6931 "type": "string" 6932 }, 6933 "account": { 6934 "$ref": "#/components/schemas/Account" 6935 }, 6936 "account_id": { 6937 "type": "string" 6938 }, 6939 "config_managed": { 6940 "type": "boolean" 6941 }, 6942 "created_at": { 6943 "type": "string", 6944 "format": "date-time" 6945 }, 6946 "managed_by": { 6947 "type": "string" 6948 }, 6949 "organization": { 6950 "$ref": "#/components/schemas/Organization" 6951 }, 6952 "organization_id": { 6953 "type": "string" 6954 }, 6955 "role": { 6956 "$ref": "#/components/schemas/Role" 6957 }, 6958 "role_id": { 6959 "type": "string" 6960 }, 6961 "subscription": { 6962 "$ref": "#/components/schemas/Subscription" 6963 }, 6964 "subscription_id": { 6965 "type": "string" 6966 }, 6967 "type": { 6968 "type": "string" 6969 }, 6970 "updated_at": { 6971 "type": "string", 6972 "format": "date-time" 6973 } 6974 } 6975 }, 6976 "SkuRule": { 6977 "description": "Identifies sku rule", 6978 "properties": { 6979 "kind": { 6980 "description": "Indicates the type of this object. Will be 'SkuRule' if this is a complete object or 'SkuRuleLink' if it is just a link.", 6981 "type": "string" 6982 }, 6983 "id": { 6984 "description": "Unique identifier of the object.", 6985 "type": "string" 6986 }, 6987 "href": { 6988 "description": "Self link.", 6989 "type": "string" 6990 }, 6991 "allowed": { 6992 "description": "Specifies the allowed parameter for calculation", 6993 "type": "integer", 6994 "format": "int32" 6995 }, 6996 "quota_id": { 6997 "description": "Specifies the quota id", 6998 "type": "string" 6999 }, 7000 "sku": { 7001 "description": "Specifies the sku, such as \"\"MW00504\"\"", 7002 "type": "string" 7003 } 7004 } 7005 }, 7006 "Subscription": { 7007 "properties": { 7008 "kind": { 7009 "description": "Indicates the type of this object. Will be 'Subscription' if this is a complete object or 'SubscriptionLink' if it is just a link.", 7010 "type": "string" 7011 }, 7012 "id": { 7013 "description": "Unique identifier of the object.", 7014 "type": "string" 7015 }, 7016 "href": { 7017 "description": "Self link.", 7018 "type": "string" 7019 }, 7020 "billing_marketplace_account": { 7021 "type": "string" 7022 }, 7023 "capabilities": { 7024 "type": "array", 7025 "items": { 7026 "$ref": "#/components/schemas/Capability" 7027 } 7028 }, 7029 "cloud_account_id": { 7030 "type": "string" 7031 }, 7032 "cloud_provider_id": { 7033 "type": "string" 7034 }, 7035 "cluster_id": { 7036 "type": "string" 7037 }, 7038 "cluster_billing_model": { 7039 "$ref": "#/components/schemas/BillingModel" 7040 }, 7041 "console_url": { 7042 "type": "string" 7043 }, 7044 "consumer_uuid": { 7045 "type": "string" 7046 }, 7047 "cpu_total": { 7048 "type": "integer", 7049 "format": "int32" 7050 }, 7051 "created_at": { 7052 "type": "string", 7053 "format": "date-time" 7054 }, 7055 "creator": { 7056 "description": "Link to the account that created the subscription.", 7057 "$ref": "#/components/schemas/Account" 7058 }, 7059 "display_name": { 7060 "type": "string" 7061 }, 7062 "external_cluster_id": { 7063 "type": "string" 7064 }, 7065 "labels": { 7066 "type": "array", 7067 "items": { 7068 "$ref": "#/components/schemas/Label" 7069 } 7070 }, 7071 "last_reconcile_date": { 7072 "description": "Last time this subscription were reconciled about cluster usage.", 7073 "type": "string", 7074 "format": "date-time" 7075 }, 7076 "last_released_at": { 7077 "description": "Last time status was set to Released for this cluster/subscription.", 7078 "type": "string", 7079 "format": "date-time" 7080 }, 7081 "last_telemetry_date": { 7082 "description": "Last telemetry authorization request for this cluster/subscription in Unix time", 7083 "type": "string", 7084 "format": "date-time" 7085 }, 7086 "managed": { 7087 "type": "boolean" 7088 }, 7089 "metrics": { 7090 "description": "Metrics array. One or zero elements will present.", 7091 "type": "array", 7092 "items": { 7093 "$ref": "#/components/schemas/SubscriptionMetrics" 7094 } 7095 }, 7096 "notification_contacts": { 7097 "type": "array", 7098 "items": { 7099 "$ref": "#/components/schemas/Account" 7100 } 7101 }, 7102 "organization_id": { 7103 "type": "string" 7104 }, 7105 "plan": { 7106 "$ref": "#/components/schemas/Plan" 7107 }, 7108 "product_bundle": { 7109 "type": "string" 7110 }, 7111 "provenance": { 7112 "description": "The origin of cluster registration (values are defined in AMS at pkg/api/subscription_types.go).", 7113 "type": "string" 7114 }, 7115 "region_id": { 7116 "type": "string" 7117 }, 7118 "released": { 7119 "description": "Flag used to denote whether or not the owner of the cluster has released the ownership and ready to be transferred to a different user.", 7120 "type": "boolean" 7121 }, 7122 "rh_region_id": { 7123 "type": "string" 7124 }, 7125 "service_level": { 7126 "type": "string" 7127 }, 7128 "socket_total": { 7129 "type": "integer", 7130 "format": "int32" 7131 }, 7132 "status": { 7133 "type": "string" 7134 }, 7135 "support_level": { 7136 "type": "string" 7137 }, 7138 "system_units": { 7139 "type": "string" 7140 }, 7141 "trial_end_date": { 7142 "description": "If the subscription is a trial, date the trial ends.", 7143 "type": "string", 7144 "format": "date-time" 7145 }, 7146 "updated_at": { 7147 "type": "string", 7148 "format": "date-time" 7149 }, 7150 "usage": { 7151 "type": "string" 7152 } 7153 } 7154 }, 7155 "SubscriptionMetrics": { 7156 "description": "Each field is a metric fetched for a specific Subscription's cluster.", 7157 "properties": { 7158 "cloud_provider": { 7159 "type": "string" 7160 }, 7161 "compute_nodes_cpu": { 7162 "$ref": "#/components/schemas/ClusterResource" 7163 }, 7164 "compute_nodes_memory": { 7165 "$ref": "#/components/schemas/ClusterResource" 7166 }, 7167 "compute_nodes_sockets": { 7168 "$ref": "#/components/schemas/ClusterResource" 7169 }, 7170 "console_url": { 7171 "type": "string" 7172 }, 7173 "cpu": { 7174 "$ref": "#/components/schemas/ClusterResource" 7175 }, 7176 "critical_alerts_firing": { 7177 "type": "number", 7178 "format": "float" 7179 }, 7180 "health_state": { 7181 "type": "string" 7182 }, 7183 "memory": { 7184 "$ref": "#/components/schemas/ClusterResource" 7185 }, 7186 "nodes": { 7187 "$ref": "#/components/schemas/ClusterMetricsNodes" 7188 }, 7189 "openshift_version": { 7190 "type": "string" 7191 }, 7192 "operating_system": { 7193 "type": "string" 7194 }, 7195 "operators_condition_failing": { 7196 "type": "number", 7197 "format": "float" 7198 }, 7199 "region": { 7200 "type": "string" 7201 }, 7202 "sockets": { 7203 "$ref": "#/components/schemas/ClusterResource" 7204 }, 7205 "state": { 7206 "type": "string" 7207 }, 7208 "state_description": { 7209 "type": "string" 7210 }, 7211 "storage": { 7212 "$ref": "#/components/schemas/ClusterResource" 7213 }, 7214 "subscription_cpu_total": { 7215 "type": "number", 7216 "format": "float" 7217 }, 7218 "subscription_obligation_exists": { 7219 "type": "number", 7220 "format": "float" 7221 }, 7222 "subscription_socket_total": { 7223 "type": "number", 7224 "format": "float" 7225 }, 7226 "upgrade": { 7227 "$ref": "#/components/schemas/ClusterUpgrade" 7228 } 7229 } 7230 }, 7231 "SubscriptionRegistration": { 7232 "description": "Registration of a new subscription.", 7233 "properties": { 7234 "cluster_uuid": { 7235 "description": "External cluster ID.", 7236 "type": "string" 7237 }, 7238 "console_url": { 7239 "description": "Console URL of subscription (optional).", 7240 "type": "string" 7241 }, 7242 "display_name": { 7243 "description": "Display name of subscription (optional).", 7244 "type": "string" 7245 }, 7246 "plan_id": { 7247 "description": "Plan ID of subscription.", 7248 "$ref": "#/components/schemas/PlanID" 7249 }, 7250 "status": { 7251 "description": "Status of subscription.", 7252 "type": "string" 7253 } 7254 } 7255 }, 7256 "SummaryDashboard": { 7257 "properties": { 7258 "kind": { 7259 "description": "Indicates the type of this object. Will be 'SummaryDashboard' if this is a complete object or 'SummaryDashboardLink' if it is just a link.", 7260 "type": "string" 7261 }, 7262 "id": { 7263 "description": "Unique identifier of the object.", 7264 "type": "string" 7265 }, 7266 "href": { 7267 "description": "Self link.", 7268 "type": "string" 7269 }, 7270 "metrics": { 7271 "type": "array", 7272 "items": { 7273 "$ref": "#/components/schemas/SummaryMetrics" 7274 } 7275 } 7276 } 7277 }, 7278 "SummaryMetrics": { 7279 "properties": { 7280 "name": { 7281 "type": "string" 7282 }, 7283 "vector": { 7284 "type": "array", 7285 "items": { 7286 "$ref": "#/components/schemas/SummarySample" 7287 } 7288 } 7289 } 7290 }, 7291 "SummarySample": { 7292 "properties": { 7293 "time": { 7294 "type": "string" 7295 }, 7296 "value": { 7297 "type": "number", 7298 "format": "float" 7299 } 7300 } 7301 }, 7302 "SupportCaseRequest": { 7303 "properties": { 7304 "kind": { 7305 "description": "Indicates the type of this object. Will be 'SupportCaseRequest' if this is a complete object or 'SupportCaseRequestLink' if it is just a link.", 7306 "type": "string" 7307 }, 7308 "id": { 7309 "description": "Unique identifier of the object.", 7310 "type": "string" 7311 }, 7312 "href": { 7313 "description": "Self link.", 7314 "type": "string" 7315 }, 7316 "cluster_id": { 7317 "description": "(optional) cluster id of the cluster on which we create the support case for.", 7318 "type": "string" 7319 }, 7320 "cluster_uuid": { 7321 "description": "(optional) cluster uuid of the cluster on which we create the support case for.", 7322 "type": "string" 7323 }, 7324 "description": { 7325 "description": "Support case desciption.", 7326 "type": "string" 7327 }, 7328 "event_stream_id": { 7329 "description": "(optional) event stream id for the support case so we could track it.", 7330 "type": "string" 7331 }, 7332 "severity": { 7333 "description": "Support case severity.", 7334 "type": "string" 7335 }, 7336 "subscription_id": { 7337 "description": "(optional) subscription id of the subscription on which we create the support case for.", 7338 "type": "string" 7339 }, 7340 "summary": { 7341 "description": "Support case title.", 7342 "type": "string" 7343 } 7344 } 7345 }, 7346 "SupportCaseResponse": { 7347 "properties": { 7348 "kind": { 7349 "description": "Indicates the type of this object. Will be 'SupportCaseResponse' if this is a complete object or 'SupportCaseResponseLink' if it is just a link.", 7350 "type": "string" 7351 }, 7352 "id": { 7353 "description": "Unique identifier of the object.", 7354 "type": "string" 7355 }, 7356 "href": { 7357 "description": "Self link.", 7358 "type": "string" 7359 }, 7360 "uri": { 7361 "description": "Support case uri.", 7362 "type": "string" 7363 }, 7364 "case_number": { 7365 "description": "Support case number.", 7366 "type": "string" 7367 }, 7368 "cluster_id": { 7369 "description": "(optional) cluster id of the cluster on which we created the support case for.", 7370 "type": "string" 7371 }, 7372 "cluster_uuid": { 7373 "description": "(optional) cluster uuid of the cluster on which we created the support case for.", 7374 "type": "string" 7375 }, 7376 "description": { 7377 "description": "Support case desciption.", 7378 "type": "string" 7379 }, 7380 "severity": { 7381 "description": "Support case severity.", 7382 "type": "string" 7383 }, 7384 "status": { 7385 "description": "Support case status.", 7386 "type": "string" 7387 }, 7388 "subscription_id": { 7389 "description": "(optional) subscription id of the subscription on which we created the support case for.", 7390 "type": "string" 7391 }, 7392 "summary": { 7393 "description": "Support case title.", 7394 "type": "string" 7395 } 7396 } 7397 }, 7398 "TemplateParameter": { 7399 "description": "A template parameter is used in an email to replace placeholder content with\nvalues specific to the email recipient.", 7400 "properties": { 7401 "content": { 7402 "description": "The content that will replace the template parameter in the email", 7403 "type": "string" 7404 }, 7405 "name": { 7406 "description": "Name of the value to be replaced", 7407 "type": "string" 7408 } 7409 } 7410 }, 7411 "TokenAuthorizationRequest": { 7412 "properties": { 7413 "authorization_token": { 7414 "description": "The pull secret of a given account", 7415 "type": "string" 7416 } 7417 } 7418 }, 7419 "TokenAuthorizationResponse": { 7420 "properties": { 7421 "account": { 7422 "$ref": "#/components/schemas/Account" 7423 } 7424 } 7425 }, 7426 "ValueUnit": { 7427 "properties": { 7428 "unit": { 7429 "type": "string" 7430 }, 7431 "value": { 7432 "type": "number", 7433 "format": "float" 7434 } 7435 } 7436 }, 7437 "Error": { 7438 "type": "object", 7439 "properties": { 7440 "kind": { 7441 "description": "Indicates the type of this object. Will always be 'Error'", 7442 "type": "string" 7443 }, 7444 "id": { 7445 "description": "Numeric identifier of the error.", 7446 "type": "integer", 7447 "format": "int32" 7448 }, 7449 "href": { 7450 "description": "Self link.", 7451 "type": "string" 7452 }, 7453 "code": { 7454 "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`.", 7455 "type": "string" 7456 }, 7457 "reason": { 7458 "description": "Human readable description of the error.", 7459 "type": "string" 7460 }, 7461 "details": { 7462 "description": "Extra information about the error.", 7463 "type": "object", 7464 "additionalProperties": true 7465 } 7466 } 7467 } 7468 }, 7469 "securitySchemes": { 7470 "bearer": { 7471 "type": "http", 7472 "scheme": "bearer", 7473 "bearerFormat": "JWT" 7474 } 7475 } 7476 }, 7477 "security": [ 7478 { 7479 "bearer": [ 7480 7481 ] 7482 } 7483 ] 7484 }