github.com/openshift-online/ocm-sdk-go@v0.1.473/openapi/osd_fleet_mgmt/v1/openapi.json (about)

     1  {
     2    "openapi": "3.0.0",
     3    "info": {
     4      "version": "v1",
     5      "title": "osd_fleet_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/osd_fleet_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/osd_fleet_mgmt/v1/management_clusters": {
    54        "get": {
    55          "description": "Retrieves the list of management clusters.",
    56          "parameters": [
    57            {
    58              "name": "page",
    59              "description": "Index of the requested page, where one corresponds to the first page.",
    60              "in": "query",
    61              "schema": {
    62                "type": "integer",
    63                "format": "int32"
    64              }
    65            },
    66            {
    67              "name": "size",
    68              "description": "Maximum number of items that will be contained in the returned page.",
    69              "in": "query",
    70              "schema": {
    71                "type": "integer",
    72                "format": "int32"
    73              }
    74            }
    75          ],
    76          "responses": {
    77            "200": {
    78              "description": "Success.",
    79              "content": {
    80                "application/json": {
    81                  "schema": {
    82                    "type": "object",
    83                    "properties": {
    84                      "items": {
    85                        "description": "Retrieved a list of management clusters.",
    86                        "type": "array",
    87                        "items": {
    88                          "$ref": "#/components/schemas/ManagementCluster"
    89                        }
    90                      },
    91                      "page": {
    92                        "description": "Index of the requested page, where one corresponds to the first page.",
    93                        "type": "integer",
    94                        "format": "int32"
    95                      },
    96                      "size": {
    97                        "description": "Maximum number of items that will be contained in the returned page.",
    98                        "type": "integer",
    99                        "format": "int32"
   100                      },
   101                      "total": {
   102                        "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.",
   103                        "type": "integer",
   104                        "format": "int32"
   105                      }
   106                    }
   107                  }
   108                }
   109              }
   110            },
   111            "default": {
   112              "description": "Error.",
   113              "content": {
   114                "application/json": {
   115                  "schema": {
   116                    "$ref": "#/components/schemas/Error"
   117                  }
   118                }
   119              }
   120            }
   121          }
   122        }
   123      },
   124      "/api/osd_fleet_mgmt/v1/management_clusters/{management_cluster_id}": {
   125        "delete": {
   126          "description": "Deletes the management cluster.",
   127          "parameters": [
   128            {
   129              "name": "management_cluster_id",
   130              "in": "path",
   131              "schema": {
   132                "type": "string"
   133              },
   134              "required": true
   135            }
   136          ],
   137          "responses": {
   138            "204": {
   139              "description": "Success."
   140            },
   141            "default": {
   142              "description": "Error.",
   143              "content": {
   144                "application/json": {
   145                  "schema": {
   146                    "$ref": "#/components/schemas/Error"
   147                  }
   148                }
   149              }
   150            }
   151          }
   152        },
   153        "get": {
   154          "description": "Retrieves the details of the management cluster.",
   155          "parameters": [
   156            {
   157              "name": "management_cluster_id",
   158              "in": "path",
   159              "schema": {
   160                "type": "string"
   161              },
   162              "required": true
   163            }
   164          ],
   165          "responses": {
   166            "200": {
   167              "description": "Success.",
   168              "content": {
   169                "application/json": {
   170                  "schema": {
   171                    "$ref": "#/components/schemas/ManagementCluster"
   172                  }
   173                }
   174              }
   175            },
   176            "default": {
   177              "description": "Error.",
   178              "content": {
   179                "application/json": {
   180                  "schema": {
   181                    "$ref": "#/components/schemas/Error"
   182                  }
   183                }
   184              }
   185            }
   186          }
   187        },
   188        "post": {
   189          "description": "Updates the management cluster.",
   190          "parameters": [
   191            {
   192              "name": "management_cluster_id",
   193              "in": "path",
   194              "schema": {
   195                "type": "string"
   196              },
   197              "required": true
   198            }
   199          ],
   200          "requestBody": {
   201            "content": {
   202              "application/json": {
   203                "schema": {
   204                  "$ref": "#/components/schemas/ManagementClusterRequestPayload"
   205                }
   206              }
   207            }
   208          },
   209          "responses": {
   210            "201": {
   211              "description": "Success.",
   212              "content": {
   213                "application/json": {
   214                  "schema": {
   215                    "$ref": "#/components/schemas/ManagementCluster"
   216                  }
   217                }
   218              }
   219            },
   220            "default": {
   221              "description": "Error.",
   222              "content": {
   223                "application/json": {
   224                  "schema": {
   225                    "$ref": "#/components/schemas/Error"
   226                  }
   227                }
   228              }
   229            }
   230          }
   231        }
   232      },
   233      "/api/osd_fleet_mgmt/v1/management_clusters/{management_cluster_id}/labels": {
   234        "get": {
   235          "description": "Retrieves the list of labels.",
   236          "parameters": [
   237            {
   238              "name": "management_cluster_id",
   239              "in": "path",
   240              "schema": {
   241                "type": "string"
   242              },
   243              "required": true
   244            },
   245            {
   246              "name": "page",
   247              "description": "Index of the requested page, where one corresponds to the first page.",
   248              "in": "query",
   249              "schema": {
   250                "type": "integer",
   251                "format": "int32"
   252              }
   253            },
   254            {
   255              "name": "size",
   256              "description": "Maximum number of items that will be contained in the returned page.",
   257              "in": "query",
   258              "schema": {
   259                "type": "integer",
   260                "format": "int32"
   261              }
   262            }
   263          ],
   264          "responses": {
   265            "200": {
   266              "description": "Success.",
   267              "content": {
   268                "application/json": {
   269                  "schema": {
   270                    "type": "object",
   271                    "properties": {
   272                      "items": {
   273                        "description": "Retrieved a list of labels.",
   274                        "type": "array",
   275                        "items": {
   276                          "$ref": "#/components/schemas/Label"
   277                        }
   278                      },
   279                      "page": {
   280                        "description": "Index of the requested page, where one corresponds to the first page.",
   281                        "type": "integer",
   282                        "format": "int32"
   283                      },
   284                      "size": {
   285                        "description": "Maximum number of items that will be contained in the returned page.",
   286                        "type": "integer",
   287                        "format": "int32"
   288                      },
   289                      "total": {
   290                        "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.",
   291                        "type": "integer",
   292                        "format": "int32"
   293                      }
   294                    }
   295                  }
   296                }
   297              }
   298            },
   299            "default": {
   300              "description": "Error.",
   301              "content": {
   302                "application/json": {
   303                  "schema": {
   304                    "$ref": "#/components/schemas/Error"
   305                  }
   306                }
   307              }
   308            }
   309          }
   310        }
   311      },
   312      "/api/osd_fleet_mgmt/v1/management_clusters/{management_cluster_id}/labels/{label_id}": {
   313        "delete": {
   314          "description": "Deletes the label.",
   315          "parameters": [
   316            {
   317              "name": "management_cluster_id",
   318              "in": "path",
   319              "schema": {
   320                "type": "string"
   321              },
   322              "required": true
   323            },
   324            {
   325              "name": "label_id",
   326              "in": "path",
   327              "schema": {
   328                "type": "string"
   329              },
   330              "required": true
   331            }
   332          ],
   333          "responses": {
   334            "204": {
   335              "description": "Success."
   336            },
   337            "default": {
   338              "description": "Error.",
   339              "content": {
   340                "application/json": {
   341                  "schema": {
   342                    "$ref": "#/components/schemas/Error"
   343                  }
   344                }
   345              }
   346            }
   347          }
   348        },
   349        "get": {
   350          "description": "Retrieves the details of the cluster.",
   351          "parameters": [
   352            {
   353              "name": "management_cluster_id",
   354              "in": "path",
   355              "schema": {
   356                "type": "string"
   357              },
   358              "required": true
   359            },
   360            {
   361              "name": "label_id",
   362              "in": "path",
   363              "schema": {
   364                "type": "string"
   365              },
   366              "required": true
   367            }
   368          ],
   369          "responses": {
   370            "200": {
   371              "description": "Success.",
   372              "content": {
   373                "application/json": {
   374                  "schema": {
   375                    "$ref": "#/components/schemas/Label"
   376                  }
   377                }
   378              }
   379            },
   380            "default": {
   381              "description": "Error.",
   382              "content": {
   383                "application/json": {
   384                  "schema": {
   385                    "$ref": "#/components/schemas/Error"
   386                  }
   387                }
   388              }
   389            }
   390          }
   391        },
   392        "post": {
   393          "description": "Creates the label.",
   394          "parameters": [
   395            {
   396              "name": "management_cluster_id",
   397              "in": "path",
   398              "schema": {
   399                "type": "string"
   400              },
   401              "required": true
   402            },
   403            {
   404              "name": "label_id",
   405              "in": "path",
   406              "schema": {
   407                "type": "string"
   408              },
   409              "required": true
   410            }
   411          ],
   412          "requestBody": {
   413            "content": {
   414              "application/json": {
   415                "schema": {
   416                  "$ref": "#/components/schemas/LabelRequestPayload"
   417                }
   418              }
   419            }
   420          },
   421          "responses": {
   422            "201": {
   423              "description": "Success.",
   424              "content": {
   425                "application/json": {
   426                  "schema": {
   427                    "$ref": "#/components/schemas/Label"
   428                  }
   429                }
   430              }
   431            },
   432            "default": {
   433              "description": "Error.",
   434              "content": {
   435                "application/json": {
   436                  "schema": {
   437                    "$ref": "#/components/schemas/Error"
   438                  }
   439                }
   440              }
   441            }
   442          }
   443        }
   444      },
   445      "/api/osd_fleet_mgmt/v1/service_clusters": {
   446        "get": {
   447          "description": "Retrieves the list of service clusters.",
   448          "parameters": [
   449            {
   450              "name": "page",
   451              "description": "Index of the requested page, where one corresponds to the first page.",
   452              "in": "query",
   453              "schema": {
   454                "type": "integer",
   455                "format": "int32"
   456              }
   457            },
   458            {
   459              "name": "size",
   460              "description": "Maximum number of items that will be contained in the returned page.",
   461              "in": "query",
   462              "schema": {
   463                "type": "integer",
   464                "format": "int32"
   465              }
   466            }
   467          ],
   468          "responses": {
   469            "200": {
   470              "description": "Success.",
   471              "content": {
   472                "application/json": {
   473                  "schema": {
   474                    "type": "object",
   475                    "properties": {
   476                      "items": {
   477                        "description": "Retrieved a list of service clusters.",
   478                        "type": "array",
   479                        "items": {
   480                          "$ref": "#/components/schemas/ServiceCluster"
   481                        }
   482                      },
   483                      "page": {
   484                        "description": "Index of the requested page, where one corresponds to the first page.",
   485                        "type": "integer",
   486                        "format": "int32"
   487                      },
   488                      "size": {
   489                        "description": "Maximum number of items that will be contained in the returned page.",
   490                        "type": "integer",
   491                        "format": "int32"
   492                      },
   493                      "total": {
   494                        "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.",
   495                        "type": "integer",
   496                        "format": "int32"
   497                      }
   498                    }
   499                  }
   500                }
   501              }
   502            },
   503            "default": {
   504              "description": "Error.",
   505              "content": {
   506                "application/json": {
   507                  "schema": {
   508                    "$ref": "#/components/schemas/Error"
   509                  }
   510                }
   511              }
   512            }
   513          }
   514        }
   515      },
   516      "/api/osd_fleet_mgmt/v1/service_clusters/{service_cluster_id}": {
   517        "delete": {
   518          "description": "Deletes the service cluster.",
   519          "parameters": [
   520            {
   521              "name": "service_cluster_id",
   522              "in": "path",
   523              "schema": {
   524                "type": "string"
   525              },
   526              "required": true
   527            }
   528          ],
   529          "responses": {
   530            "204": {
   531              "description": "Success."
   532            },
   533            "default": {
   534              "description": "Error.",
   535              "content": {
   536                "application/json": {
   537                  "schema": {
   538                    "$ref": "#/components/schemas/Error"
   539                  }
   540                }
   541              }
   542            }
   543          }
   544        },
   545        "get": {
   546          "description": "Retrieves the details of the cluster.",
   547          "parameters": [
   548            {
   549              "name": "service_cluster_id",
   550              "in": "path",
   551              "schema": {
   552                "type": "string"
   553              },
   554              "required": true
   555            }
   556          ],
   557          "responses": {
   558            "200": {
   559              "description": "Success.",
   560              "content": {
   561                "application/json": {
   562                  "schema": {
   563                    "$ref": "#/components/schemas/ServiceCluster"
   564                  }
   565                }
   566              }
   567            },
   568            "default": {
   569              "description": "Error.",
   570              "content": {
   571                "application/json": {
   572                  "schema": {
   573                    "$ref": "#/components/schemas/Error"
   574                  }
   575                }
   576              }
   577            }
   578          }
   579        },
   580        "post": {
   581          "description": "Updates the service cluster.",
   582          "parameters": [
   583            {
   584              "name": "service_cluster_id",
   585              "in": "path",
   586              "schema": {
   587                "type": "string"
   588              },
   589              "required": true
   590            }
   591          ],
   592          "requestBody": {
   593            "content": {
   594              "application/json": {
   595                "schema": {
   596                  "$ref": "#/components/schemas/ServiceClusterRequestPayload"
   597                }
   598              }
   599            }
   600          },
   601          "responses": {
   602            "201": {
   603              "description": "Success.",
   604              "content": {
   605                "application/json": {
   606                  "schema": {
   607                    "$ref": "#/components/schemas/ServiceCluster"
   608                  }
   609                }
   610              }
   611            },
   612            "default": {
   613              "description": "Error.",
   614              "content": {
   615                "application/json": {
   616                  "schema": {
   617                    "$ref": "#/components/schemas/Error"
   618                  }
   619                }
   620              }
   621            }
   622          }
   623        }
   624      },
   625      "/api/osd_fleet_mgmt/v1/service_clusters/{service_cluster_id}/labels": {
   626        "get": {
   627          "description": "Retrieves the list of labels.",
   628          "parameters": [
   629            {
   630              "name": "service_cluster_id",
   631              "in": "path",
   632              "schema": {
   633                "type": "string"
   634              },
   635              "required": true
   636            },
   637            {
   638              "name": "page",
   639              "description": "Index of the requested page, where one corresponds to the first page.",
   640              "in": "query",
   641              "schema": {
   642                "type": "integer",
   643                "format": "int32"
   644              }
   645            },
   646            {
   647              "name": "size",
   648              "description": "Maximum number of items that will be contained in the returned page.",
   649              "in": "query",
   650              "schema": {
   651                "type": "integer",
   652                "format": "int32"
   653              }
   654            }
   655          ],
   656          "responses": {
   657            "200": {
   658              "description": "Success.",
   659              "content": {
   660                "application/json": {
   661                  "schema": {
   662                    "type": "object",
   663                    "properties": {
   664                      "items": {
   665                        "description": "Retrieved a list of labels.",
   666                        "type": "array",
   667                        "items": {
   668                          "$ref": "#/components/schemas/Label"
   669                        }
   670                      },
   671                      "page": {
   672                        "description": "Index of the requested page, where one corresponds to the first page.",
   673                        "type": "integer",
   674                        "format": "int32"
   675                      },
   676                      "size": {
   677                        "description": "Maximum number of items that will be contained in the returned page.",
   678                        "type": "integer",
   679                        "format": "int32"
   680                      },
   681                      "total": {
   682                        "description": "Total number of items of the collection that match the search criteria,\nregardless of the size of the page.",
   683                        "type": "integer",
   684                        "format": "int32"
   685                      }
   686                    }
   687                  }
   688                }
   689              }
   690            },
   691            "default": {
   692              "description": "Error.",
   693              "content": {
   694                "application/json": {
   695                  "schema": {
   696                    "$ref": "#/components/schemas/Error"
   697                  }
   698                }
   699              }
   700            }
   701          }
   702        }
   703      },
   704      "/api/osd_fleet_mgmt/v1/service_clusters/{service_cluster_id}/labels/{label_id}": {
   705        "delete": {
   706          "description": "Deletes the label.",
   707          "parameters": [
   708            {
   709              "name": "service_cluster_id",
   710              "in": "path",
   711              "schema": {
   712                "type": "string"
   713              },
   714              "required": true
   715            },
   716            {
   717              "name": "label_id",
   718              "in": "path",
   719              "schema": {
   720                "type": "string"
   721              },
   722              "required": true
   723            }
   724          ],
   725          "responses": {
   726            "204": {
   727              "description": "Success."
   728            },
   729            "default": {
   730              "description": "Error.",
   731              "content": {
   732                "application/json": {
   733                  "schema": {
   734                    "$ref": "#/components/schemas/Error"
   735                  }
   736                }
   737              }
   738            }
   739          }
   740        },
   741        "get": {
   742          "description": "Retrieves the details of the cluster.",
   743          "parameters": [
   744            {
   745              "name": "service_cluster_id",
   746              "in": "path",
   747              "schema": {
   748                "type": "string"
   749              },
   750              "required": true
   751            },
   752            {
   753              "name": "label_id",
   754              "in": "path",
   755              "schema": {
   756                "type": "string"
   757              },
   758              "required": true
   759            }
   760          ],
   761          "responses": {
   762            "200": {
   763              "description": "Success.",
   764              "content": {
   765                "application/json": {
   766                  "schema": {
   767                    "$ref": "#/components/schemas/Label"
   768                  }
   769                }
   770              }
   771            },
   772            "default": {
   773              "description": "Error.",
   774              "content": {
   775                "application/json": {
   776                  "schema": {
   777                    "$ref": "#/components/schemas/Error"
   778                  }
   779                }
   780              }
   781            }
   782          }
   783        },
   784        "post": {
   785          "description": "Creates the label.",
   786          "parameters": [
   787            {
   788              "name": "service_cluster_id",
   789              "in": "path",
   790              "schema": {
   791                "type": "string"
   792              },
   793              "required": true
   794            },
   795            {
   796              "name": "label_id",
   797              "in": "path",
   798              "schema": {
   799                "type": "string"
   800              },
   801              "required": true
   802            }
   803          ],
   804          "requestBody": {
   805            "content": {
   806              "application/json": {
   807                "schema": {
   808                  "$ref": "#/components/schemas/LabelRequestPayload"
   809                }
   810              }
   811            }
   812          },
   813          "responses": {
   814            "201": {
   815              "description": "Success.",
   816              "content": {
   817                "application/json": {
   818                  "schema": {
   819                    "$ref": "#/components/schemas/Label"
   820                  }
   821                }
   822              }
   823            },
   824            "default": {
   825              "description": "Error.",
   826              "content": {
   827                "application/json": {
   828                  "schema": {
   829                    "$ref": "#/components/schemas/Error"
   830                  }
   831                }
   832              }
   833            }
   834          }
   835        }
   836      }
   837    },
   838    "components": {
   839      "schemas": {
   840        "Metadata": {
   841          "description": "Version metadata.",
   842          "properties": {
   843            "server_version": {
   844              "description": "Version of the server.",
   845              "type": "string"
   846            }
   847          }
   848        },
   849        "DNS": {
   850          "description": "DNS settings of the cluster.",
   851          "properties": {
   852            "base_domain": {
   853              "description": "Base DNS domain of the cluster.\n\nDuring the installation of the cluster it is necessary to create multiple DNS records.\nThey will be created as sub-domains of this domain. For example, if the name of the\ncluster is `mycluster` and the base domain is `example.com` then the following DNS\nrecords will be created:\n\n```\nmycluster-api.example.com\nmycluster-etcd-0.example.com\nmycluster-etcd-1.example.com\nmycluster-etcd-3.example.com\n```\n\nThe exact number, type and names of the created DNS record depends on the characteristics\nof the cluster, and may be different for different versions of _OpenShift_. Please don't\nrely on them. For example, to find what is the URL of the Kubernetes API server of the\ncluster don't assume that it will be `mycluster-api.example.com`. Instead of that use\nthis API to retrieve the description of the cluster, and get it from the `api.url`\nattribute. For example, if the identifier of the cluster is `123` send a request like\nthis:\n\n```http\nGET /api/clusters_mgmt/v1/clusters/123 HTTP/1.1\n```\n\nThat will return a response like this, including the `api.url` attribute:\n\n```json\n{\n    \"kind\": \"Cluster\",\n    \"id\": \"123\",\n    \"href\": \"/api/clusters_mgmt/v1/clusters/123\",\n        \"api\": {\n        \"url\": \"https://mycluster-api.example.com:6443\"\n    },\n    ...\n}\n```\n\nWhen the cluster is created in Amazon Web Services it is necessary to create this base\nDNS domain in advance, using AWS Route53 (https://console.aws.amazon.com/route53).",
   854              "type": "string"
   855            }
   856          }
   857        },
   858        "ClusterManagementReference": {
   859          "description": "Cluster Mgmt reference settings of the cluster.",
   860          "properties": {
   861            "cluster_id": {
   862              "description": "Cluster Mgmt ID ",
   863              "type": "string"
   864            },
   865            "href": {
   866              "description": "Reference link to external cluster_mgmt service based on ClusterId field\nClusterId is not the name of the field used by the external cluster_mgmt service",
   867              "type": "string"
   868            }
   869          }
   870        },
   871        "Label": {
   872          "description": "label settings of the cluster.",
   873          "properties": {
   874            "kind": {
   875              "description": "Indicates the type of this object. Will be 'Label' if this is a complete object or 'LabelLink' if it is just a link.",
   876              "type": "string"
   877            },
   878            "id": {
   879              "description": "Unique identifier of the object.",
   880              "type": "string"
   881            },
   882            "href": {
   883              "description": "Self link.",
   884              "type": "string"
   885            },
   886            "key": {
   887              "description": "Label key associated to the OSD FM managed cluster",
   888              "type": "string"
   889            },
   890            "value": {
   891              "description": "Label value associated to the OSD FM managed cluster",
   892              "type": "string"
   893            }
   894          }
   895        },
   896        "LabelReference": {
   897          "description": "label reference settings of the cluster.",
   898          "properties": {
   899            "href": {
   900              "description": "link to the Label associated to the OSD FM managed cluster",
   901              "type": "string"
   902            },
   903            "id": {
   904              "description": "Id of the Label associated to the OSD FM managed cluster",
   905              "type": "string"
   906            }
   907          }
   908        },
   909        "LabelRequestPayload": {
   910          "properties": {
   911            "key": {
   912              "type": "string"
   913            },
   914            "value": {
   915              "type": "string"
   916            }
   917          }
   918        },
   919        "ManagementCluster": {
   920          "description": "Definition of an _OpenShift_ cluster.\n\nThe `cloud_provider` attribute is a reference to the cloud provider. When a\ncluster is retrieved it will be a link to the cloud provider, containing only\nthe kind, id and href attributes:\n\n```json\n{\n  \"cloud_provider\": {\n    \"kind\": \"CloudProviderLink\",\n    \"id\": \"123\",\n    \"href\": \"/api/clusters_mgmt/v1/cloud_providers/123\"\n  }\n}\n```\n\nWhen a cluster is created this is optional, and if used it should contain the\nidentifier of the cloud provider to use:\n\n```json\n{\n  \"cloud_provider\": {\n    \"id\": \"123\",\n  }\n}\n```\n\nIf not included, then the cluster will be created using the default cloud\nprovider, which is currently Amazon Web Services.\n\nThe region attribute is mandatory when a cluster is created.\n\nThe `aws.access_key_id`, `aws.secret_access_key` and `dns.base_domain`\nattributes are mandatory when creation a cluster with your own Amazon Web\nServices account.",
   921          "properties": {
   922            "kind": {
   923              "description": "Indicates the type of this object. Will be 'ManagementCluster' if this is a complete object or 'ManagementClusterLink' if it is just a link.",
   924              "type": "string"
   925            },
   926            "id": {
   927              "description": "Unique identifier of the object.",
   928              "type": "string"
   929            },
   930            "href": {
   931              "description": "Self link.",
   932              "type": "string"
   933            },
   934            "dns": {
   935              "description": "DNS settings of the cluster.",
   936              "$ref": "#/components/schemas/DNS"
   937            },
   938            "cloud_provider": {
   939              "description": "Cloud provider where the cluster is installed.",
   940              "type": "string"
   941            },
   942            "cluster_management_reference": {
   943              "description": "Cluster mgmt reference",
   944              "$ref": "#/components/schemas/ClusterManagementReference"
   945            },
   946            "creation_timestamp": {
   947              "description": "Creation timestamp of the cluster",
   948              "type": "string",
   949              "format": "date-time"
   950            },
   951            "labels": {
   952              "description": "Labels on management cluster",
   953              "type": "array",
   954              "items": {
   955                "$ref": "#/components/schemas/Label"
   956              }
   957            },
   958            "name": {
   959              "description": "Cluster name",
   960              "type": "string"
   961            },
   962            "parent": {
   963              "description": "Service cluster handling the management cluster",
   964              "$ref": "#/components/schemas/ManagementClusterParent"
   965            },
   966            "region": {
   967              "description": "Cloud provider region where the cluster is installed.",
   968              "type": "string"
   969            },
   970            "sector": {
   971              "description": "Sector of cluster",
   972              "type": "string"
   973            },
   974            "status": {
   975              "description": "Status of cluster",
   976              "type": "string"
   977            },
   978            "update_timestamp": {
   979              "description": "Update timestamp of the cluster",
   980              "type": "string",
   981              "format": "date-time"
   982            }
   983          }
   984        },
   985        "ManagementClusterParent": {
   986          "description": "ManagementClusterParent reference settings of the cluster.",
   987          "properties": {
   988            "cluster_id": {
   989              "description": "Parent Cluster ID ",
   990              "type": "string"
   991            },
   992            "href": {
   993              "description": "Reference link to internal parent cluster",
   994              "type": "string"
   995            },
   996            "kind": {
   997              "description": "Kind of internal parent cluster",
   998              "type": "string"
   999            },
  1000            "name": {
  1001              "description": "Parent Cluster Name",
  1002              "type": "string"
  1003            }
  1004          }
  1005        },
  1006        "ManagementClusterRequestPayload": {
  1007          "properties": {
  1008            "service_cluster_id_service_cluster_id_service_cluster_id_service_cluster_id_id": {
  1009              "type": "string"
  1010            }
  1011          }
  1012        },
  1013        "ProvisionShardReference": {
  1014          "description": "Provision Shard Reference of the cluster.",
  1015          "properties": {
  1016            "href": {
  1017              "description": "link to the Provision Shards associated to the cluster",
  1018              "type": "string"
  1019            },
  1020            "id": {
  1021              "description": "Id of the Provision Shards associated to the Ocluster",
  1022              "type": "string"
  1023            }
  1024          }
  1025        },
  1026        "ServiceCluster": {
  1027          "description": "Definition of an _OpenShift_ cluster.\n\nThe `cloud_provider` attribute is a reference to the cloud provider. When a\ncluster is retrieved it will be a link to the cloud provider, containing only\nthe kind, id and href attributes:\n\n```json\n{\n  \"cloud_provider\": {\n    \"kind\": \"CloudProviderLink\",\n    \"id\": \"123\",\n    \"href\": \"/api/clusters_mgmt/v1/cloud_providers/123\"\n  }\n}\n```\n\nWhen a cluster is created this is optional, and if used it should contain the\nidentifier of the cloud provider to use:\n\n```json\n{\n  \"cloud_provider\": {\n    \"id\": \"123\",\n  }\n}\n```\n\nIf not included, then the cluster will be created using the default cloud\nprovider, which is currently Amazon Web Services.\n\nThe region attribute is mandatory when a cluster is created.\n\nThe `aws.access_key_id`, `aws.secret_access_key` and `dns.base_domain`\nattributes are mandatory when creation a cluster with your own Amazon Web\nServices account.",
  1028          "properties": {
  1029            "kind": {
  1030              "description": "Indicates the type of this object. Will be 'ServiceCluster' if this is a complete object or 'ServiceClusterLink' if it is just a link.",
  1031              "type": "string"
  1032            },
  1033            "id": {
  1034              "description": "Unique identifier of the object.",
  1035              "type": "string"
  1036            },
  1037            "href": {
  1038              "description": "Self link.",
  1039              "type": "string"
  1040            },
  1041            "dns": {
  1042              "description": "DNS settings of the cluster.",
  1043              "$ref": "#/components/schemas/DNS"
  1044            },
  1045            "cloud_provider": {
  1046              "description": "Cloud provider where the cluster is installed.",
  1047              "type": "string"
  1048            },
  1049            "cluster_management_reference": {
  1050              "description": "Cluster mgmt reference",
  1051              "$ref": "#/components/schemas/ClusterManagementReference"
  1052            },
  1053            "labels": {
  1054              "description": "Labels on service cluster",
  1055              "type": "array",
  1056              "items": {
  1057                "$ref": "#/components/schemas/Label"
  1058              }
  1059            },
  1060            "name": {
  1061              "description": "Cluster name",
  1062              "type": "string"
  1063            },
  1064            "provision_shard_reference": {
  1065              "description": "Provision shard reference for the service cluster",
  1066              "$ref": "#/components/schemas/ProvisionShardReference"
  1067            },
  1068            "region": {
  1069              "description": "Cloud provider region where the cluster is installed.",
  1070              "type": "string"
  1071            },
  1072            "sector": {
  1073              "description": "Sector of cluster",
  1074              "type": "string"
  1075            },
  1076            "status": {
  1077              "description": "Status of cluster",
  1078              "type": "string"
  1079            }
  1080          }
  1081        },
  1082        "ServiceClusterRequestPayload": {
  1083          "properties": {
  1084            "cloud_provider": {
  1085              "type": "string"
  1086            },
  1087            "labels": {
  1088              "type": "array",
  1089              "items": {
  1090                "$ref": "#/components/schemas/LabelRequestPayload"
  1091              }
  1092            },
  1093            "region": {
  1094              "type": "string"
  1095            }
  1096          }
  1097        },
  1098        "Error": {
  1099          "type": "object",
  1100          "properties": {
  1101            "kind": {
  1102              "description": "Indicates the type of this object. Will always be 'Error'",
  1103              "type": "string"
  1104            },
  1105            "id": {
  1106              "description": "Numeric identifier of the error.",
  1107              "type": "integer",
  1108              "format": "int32"
  1109            },
  1110            "href": {
  1111              "description": "Self link.",
  1112              "type": "string"
  1113            },
  1114            "code": {
  1115              "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`.",
  1116              "type": "string"
  1117            },
  1118            "reason": {
  1119              "description": "Human readable description of the error.",
  1120              "type": "string"
  1121            },
  1122            "details": {
  1123              "description": "Extra information about the error.",
  1124              "type": "object",
  1125              "additionalProperties": true
  1126            }
  1127          }
  1128        }
  1129      },
  1130      "securitySchemes": {
  1131        "bearer": {
  1132          "type": "http",
  1133          "scheme": "bearer",
  1134          "bearerFormat": "JWT"
  1135        }
  1136      }
  1137    },
  1138    "security": [
  1139      {
  1140        "bearer": [
  1141          
  1142        ]
  1143      }
  1144    ]
  1145  }