github.com/kyma-project/kyma-environment-broker@v0.0.1/resources/kcp/charts/kyma-environment-broker/files/swagger.yaml (about)

     1  openapi: 3.0.0
     2  info:
     3    description: These APIs allows to manage kyma runtimes through the Kyma Environment Broker. In case of CORS problems use this [Chrome browser extension](https://chrome.google.com/webstore/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf) to omit them.
     4    version: '2.0'
     5    title: Kyma Environment Broker APIs
     6    license:
     7      name: Apache 2.0
     8      url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
     9  paths:
    10    /upgrade/kyma:
    11      post:
    12        tags:
    13          - Orchestrations
    14        summary: orchestrates Kyma upgrade
    15        operationId: upgradeKyma
    16        description: Starts the processing of Kyma upgrade, returns the orchestration ID
    17        responses:
    18          '202':
    19            description: Upgrade started
    20            content:
    21              application/json:
    22                schema:
    23                  $ref: '#/components/schemas/UpgradeResponse'
    24          '400':
    25            description: Invalid input or object
    26            content:
    27              application/json:
    28                schema:
    29                  $ref: '#/components/schemas/OrchestrationError'
    30        requestBody:
    31          content:
    32            application/json:
    33              schema:
    34                $ref: '#/components/schemas/OrchestrationParameters'
    35          description: Orchestration parameters to configure orchestration
    36  
    37    /upgrade/cluster:
    38      post:
    39        tags:
    40          - Orchestrations
    41        summary: orchestrates cluster (shoot) upgrade
    42        operationId: upgradeCluster
    43        description: Starts the processing of cluster upgrade, returns the orchestration ID
    44        responses:
    45          '202':
    46            description: Upgrade started
    47            content:
    48              application/json:
    49                schema:
    50                  $ref: '#/components/schemas/UpgradeResponse'
    51          '400':
    52            description: Invalid input or object
    53            content:
    54              application/json:
    55                schema:
    56                  $ref: '#/components/schemas/OrchestrationError'
    57        requestBody:
    58          content:
    59            application/json:
    60              schema:
    61                $ref: '#/components/schemas/OrchestrationParameters'
    62          description: Orchestration parameters to configure orchestration
    63  
    64    /orchestrations:
    65      get:
    66        tags:
    67          - Orchestrations
    68        summary: returns a list of orchestrations
    69        operationId: listStatusResponses
    70        description: |
    71          Lists all created orchestrations
    72        parameters:
    73          - in: query
    74            name: page_size
    75            required: false
    76            schema:
    77              type: integer
    78            description: Size of the list
    79          - in: query
    80            name: page
    81            required: false
    82            schema:
    83              type: integer
    84            description: Number of the page
    85        responses:
    86          '200':
    87            description: List of orchestration objects
    88            content:
    89              application/json:
    90                schema:
    91                  $ref: '#/components/schemas/StatusResponseList'
    92  
    93    /orchestrations/{orchestration_id}:
    94      get:
    95        tags:
    96          - Orchestrations
    97        summary: returns a single orchestration
    98        operationId: getOrchestration
    99        description: |
   100          Fetches orchestrations by ID
   101        parameters:
   102          - in: path
   103            name: orchestration_id
   104            required: true
   105            schema:
   106              type: string
   107            description: Orchestration ID
   108        responses:
   109          '200':
   110            description: Orchestration returned
   111            content:
   112              application/json:
   113                schema:
   114                  $ref: '#/components/schemas/StatusResponse'
   115          '404':
   116            description: Orchestration doesn't exist
   117            content:
   118              application/json:
   119                schema:
   120                  $ref: '#/components/schemas/OrchestrationError'
   121  
   122    /orchestrations/{orchestration_id}/cancel:
   123      put:
   124        tags:
   125          - Orchestrations
   126        summary: cancels a given in progress or pending orchestration
   127        operationId: cancelByID
   128        description: |
   129          Cancels a given in progress or pending orchestration
   130        parameters:
   131          - in: path
   132            name: orchestration_id
   133            required: true
   134            schema:
   135              type: string
   136            description: Orchestration ID
   137        responses:
   138          '200':
   139            description: returns Orchestration ID
   140            content:
   141              application/json:
   142                schema:
   143                  $ref: '#/components/schemas/UpgradeResponse'
   144          '404':
   145            description: Orchestration doesn't exist
   146            content:
   147              application/json:
   148                schema:
   149                  $ref: '#/components/schemas/OrchestrationError'
   150  
   151    /orchestrations/{orchestration_id}/operations:
   152      get:
   153        tags:
   154          - Orchestrations
   155        summary: returns a list of operations scheduled by the orchestration
   156        operationId: getOperationsPage
   157        description: |
   158          Lists operations scheduled by a given orchestration
   159        parameters:
   160          - in: path
   161            name: orchestration_id
   162            required: true
   163            schema:
   164              type: string
   165            description: Orchestration ID
   166          - in: query
   167            name: page_size
   168            required: false
   169            schema:
   170              type: integer
   171            description: Size of the list
   172          - in: query
   173            name: page
   174            required: false
   175            schema:
   176              type: integer
   177            description: Number of the page
   178        responses:
   179          '200':
   180            description: Operations found and returned
   181            content:
   182              application/json:
   183                schema:
   184                  $ref: '#/components/schemas/OperationResponseList'
   185  
   186    /orchestrations/{orchestration_id}/operations/{operation_id}:
   187      get:
   188        tags:
   189          - Orchestrations
   190        summary: returns details of the operation scheduled by the orchestration
   191        operationId: getOperationResponse
   192        description: |
   193          Fetches details of the operation with a given ID that was scheduled by the orchestration with a given ID
   194        parameters:
   195          - in: path
   196            name: orchestration_id
   197            required: true
   198            schema:
   199              type: string
   200            description: Orchestration ID
   201          - in: path
   202            name: operation_id
   203            required: true
   204            schema:
   205              type: string
   206            description: Operation ID
   207        responses:
   208          '200':
   209            description: Operation found and returned
   210            content:
   211              application/json:
   212                schema:
   213                  $ref: '#/components/schemas/OperationDetailsResponse'
   214          '404':
   215            description: Operation doesn't exist
   216            content:
   217              application/json:
   218                schema:
   219                  $ref: '#/components/schemas/OrchestrationError'
   220  
   221    /runtimes:
   222      get:
   223        tags:
   224          - Runtimes
   225        summary: returns a list of Runtimes
   226        operationId: listRuntimes
   227        description: |
   228          Lists all Runtimes
   229        parameters:
   230          - in: query
   231            name: page_size
   232            required: false
   233            schema:
   234              type: integer
   235            description: Size of the list
   236          - in: query
   237            name: page
   238            required: false
   239            schema:
   240              type: integer
   241            description: Number of the page
   242          - in: query
   243            name: account
   244            required: false
   245            description: Filter by global account ID
   246            schema:
   247              type: array
   248              items:
   249                type: string
   250          - in: query
   251            name: subaccount
   252            required: false
   253            description: Filter by subaccount ID
   254            schema:
   255              type: array
   256              items:
   257                type: string
   258          - in: query
   259            name: instance_id
   260            required: false
   261            description: Filter by instance ID
   262            schema:
   263              type: array
   264              items:
   265                type: string
   266          - in: query
   267            name: runtime_id
   268            required: false
   269            description: Filter by Runtime ID
   270            schema:
   271              type: array
   272              items:
   273                type: string
   274          - in: query
   275            name: region
   276            required: false
   277            description: Filter by provider region
   278            schema:
   279              type: array
   280              items:
   281                type: string
   282          - in: query
   283            name: shoot
   284            required: false
   285            description: Filter by Shoot name
   286            schema:
   287              type: array
   288              items:
   289                type: string
   290          - in: query
   291            name: state
   292            required: false
   293            description: Filter by Runtime state. By default, if no state(s) are provided, suspended Runtimes are filtered out.
   294            schema:
   295              type: array
   296              items:
   297                type: string
   298                enum: [
   299                  "succeeded",
   300                  "failed",
   301                  "provisioning",
   302                  "deprovisioning",
   303                  "upgrading",
   304                  "suspended",
   305                  "all"
   306                ]
   307        responses:
   308          '200':
   309            description: List of Runtimes
   310            content:
   311              application/json:
   312                schema:
   313                  $ref: '#/components/schemas/RuntimePage'
   314          '400':
   315            description: Wrong parameters
   316            content:
   317              application/json:
   318                schema:
   319                  $ref: '#/components/schemas/OrchestrationError'
   320    
   321    /events:
   322      get:
   323        tags:
   324          - Events
   325        summary: returns a list of tracing events
   326        operationId: listEvents
   327        description: |
   328          Lists all tracing events passing query parameters
   329        parameters:
   330          - in: query
   331            name: runtimeIds
   332            required: false
   333            description: Filter by runtime IDs
   334            schema:
   335              type: array
   336              items:
   337                type: string
   338          - in: query
   339            name: instanceIds
   340            required: false
   341            description: Filter by instance IDs
   342            schema:
   343              type: array
   344              items:
   345                type: string
   346          - in: query
   347            name: operationIds
   348            required: false
   349            description: Filter by operation IDs
   350            schema:
   351              type: array
   352              items:
   353                type: string
   354        responses:
   355          '200':
   356            description: List of events
   357            content:
   358              application/json:
   359                schema:
   360                  type: array
   361                  items:
   362                    $ref: '#/components/schemas/EventDTO'
   363          '404':
   364            description: Not Found
   365            content:
   366              application/json:
   367                schema:
   368                  type: object
   369                  properties:
   370                    error:
   371                      type: string
   372                      example: "runtime_id=test not found"
   373          '503':
   374            description: Service Unavailable
   375            content:
   376              application/json:
   377                schema:
   378                  type: object
   379                  properties:
   380                    error:
   381                      type: string
   382                      example: "internal error"
   383  
   384    /kubeconfig/{instance_id}:
   385      get:
   386        summary: download a kubeconfig for cluster
   387        tags:
   388          - Kubeconfig
   389        parameters:
   390          - name: instance_id
   391            in: path
   392            description: instance id of instance which points to a cluster
   393            required: true
   394            schema:
   395              type: string
   396        responses:
   397          '200':
   398            description: Kubeconfig file will be downloaded
   399          '400':
   400            description: Bad request - wrong instanceID
   401            content:
   402              application/json:
   403                schema:
   404                  type: object
   405                  properties:
   406                    error:
   407                      type: string
   408                      example: "mismatch between operation and instance"
   409          '404':
   410            description: Instance doesn't exist or is not ready yet
   411            content:
   412              application/json:
   413                schema:
   414                  type: object
   415                  properties:
   416                    error:
   417                      type: string
   418                      example: "kubeconfig for instance <instance_id> does not exist. Provisioning could be in progress, please try again later"
   419          '500':
   420            description: Internal error with database or kubeconfig file generator
   421            content:
   422              application/json:
   423                schema:
   424                  type: object
   425                  properties:
   426                    error:
   427                      type: string
   428                      example: "cannot fetch SKR kubeconfig: builder error"
   429  
   430    /oauth/v2/catalog:
   431      get:
   432        summary: get the catalog of services that the service broker offers
   433        security:
   434          - oAuth2ClientCredentials: ["broker:write"]
   435        tags:
   436          - Catalog
   437        operationId: catalog.get
   438        parameters:
   439          - $ref: '#/components/parameters/APIVersion'
   440        responses:
   441          '200':
   442            description: catalog response
   443            content:
   444              application/json:
   445                schema:
   446                  $ref: '#/components/schemas/Catalog'
   447  
   448    /oauth/v2/service_instances/{instance_id}:
   449      put:
   450        summary: provision a service instance
   451        security:
   452          - oAuth2ClientCredentials: ["broker:write"]
   453        tags:
   454          - Instances
   455        operationId: serviceInstance.provision
   456        parameters:
   457          - $ref: '#/components/parameters/APIVersion'
   458          - name: instance_id
   459            in: path
   460            description: instance id of instance to provision
   461            required: true
   462            schema:
   463              type: string
   464        requestBody:
   465          description: parameters for the requested service instance provision
   466          required: true
   467          content:
   468            application/json:
   469              schema:
   470                $ref: '#/components/schemas/ServiceInstanceProvisionRequest'
   471        responses:
   472          '200':
   473            description: OK
   474            content:
   475              application/json:
   476                schema:
   477                  $ref: '#/components/schemas/ServiceInstanceProvision'
   478          '201':
   479            description: Created
   480            content:
   481              application/json:
   482                schema:
   483                  $ref: '#/components/schemas/ServiceInstanceProvision'
   484          '202':
   485            description: Accepted
   486            content:
   487              application/json:
   488                schema:
   489                  $ref: '#/components/schemas/ServiceInstanceAsyncOperation'
   490          '400':
   491            description: Bad Request
   492            content:
   493              application/json:
   494                schema:
   495                  $ref: '#/components/schemas/Error'
   496          '409':
   497            description: Conflict
   498            content:
   499              application/json:
   500                schema:
   501                  $ref: '#/components/schemas/Error'
   502          '422':
   503            description: Unprocessable Entity
   504            content:
   505              application/json:
   506                schema:
   507                  $ref: '#/components/schemas/Error'
   508      patch:
   509        summary: update a service instance
   510        security:
   511          - oAuth2ClientCredentials: ["broker:write"]
   512        tags:
   513          - Instances
   514        operationId: serviceInstance.update
   515        parameters:
   516          - $ref: '#/components/parameters/APIVersion'
   517          - name: instance_id
   518            in: path
   519            description: instance id of instance to update
   520            required: true
   521            schema:
   522              type: string
   523        requestBody:
   524          description: parameters for the requested service instance update
   525          required: true
   526          content:
   527            application/json:
   528              schema:
   529                $ref: '#/components/schemas/ServiceInstanceUpdateRequest'
   530        responses:
   531          '200':
   532            description: OK
   533            content:
   534              application/json:
   535                schema:
   536                  $ref: '#/components/schemas/Object'
   537          '202':
   538            description: Accepted
   539            content:
   540              application/json:
   541                schema:
   542                  $ref: '#/components/schemas/ServiceInstanceAsyncOperation'
   543          '400':
   544            description: Bad Request
   545            content:
   546              application/json:
   547                schema:
   548                  $ref: '#/components/schemas/Error'
   549          '422':
   550            description: Unprocessable entity
   551            content:
   552              application/json:
   553                schema:
   554                  $ref: '#/components/schemas/Error'
   555      delete:
   556        summary: deprovision a service instance
   557        security:
   558          - oAuth2ClientCredentials: ["broker:write"]
   559        tags:
   560          - Instances
   561        operationId: serviceInstance.deprovision
   562        parameters:
   563          - $ref: '#/components/parameters/APIVersion'
   564          - name: instance_id
   565            in: path
   566            description: id of instance being deleted
   567            required: true
   568            schema:
   569              type: string
   570          - name: service_id
   571            in: query
   572            description: id of the service associated with the instance being deleted
   573            required: true
   574            schema:
   575              type: string
   576          - name: plan_id
   577            in: query
   578            description: id of the plan associated with the instance being deleted
   579            required: true
   580            schema:
   581              type: string
   582          - name: force
   583            in: query
   584            schema:
   585              type: boolean
   586        responses:
   587          '200':
   588            description: OK
   589            content:
   590              application/json:
   591                schema:
   592                  $ref: '#/components/schemas/Object'
   593          '202':
   594            description: Accepted
   595            content:
   596              application/json:
   597                schema:
   598                  $ref: '#/components/schemas/AsyncOperation'
   599          '400':
   600            description: Bad Request
   601            content:
   602              application/json:
   603                schema:
   604                  $ref: '#/components/schemas/Error'
   605          '410':
   606            description: Gone
   607            content:
   608              application/json:
   609                schema:
   610                  $ref: '#/components/schemas/Error'
   611          '422':
   612            description: Unprocessable Entity
   613            content:
   614              application/json:
   615                schema:
   616                  $ref: '#/components/schemas/Error'
   617      get:
   618        summary: gets a service instance
   619        security:
   620          - oAuth2ClientCredentials: ["broker:write"]
   621        tags:
   622          - Instances
   623        operationId: serviceInstance.get
   624        parameters:
   625          - $ref: '#/components/parameters/APIVersion'
   626          - name: instance_id
   627            in: path
   628            description: instance id of instance to fetch
   629            required: true
   630            schema:
   631              type: string
   632        responses:
   633          '200':
   634            description: OK
   635            content:
   636              application/json:
   637                schema:
   638                  $ref: '#/components/schemas/ServiceInstanceResource'
   639          '404':
   640            description: Not Found
   641            content:
   642              application/json:
   643                schema:
   644                  $ref: '#/components/schemas/Error'
   645  
   646    /oauth/v2/service_instances/{instance_id}/last_operation:
   647      get:
   648        summary: last requested operation state for service instance
   649        security:
   650          - oAuth2ClientCredentials: ["broker:write"]
   651        tags:
   652          - Instances
   653        operationId: serviceInstance.lastOperation.get
   654        parameters:
   655          - $ref: '#/components/parameters/APIVersion'
   656          - name: instance_id
   657            in: path
   658            description: instance id of instance to find last operation applied to it
   659            required: true
   660            schema:
   661              type: string
   662          - name: service_id
   663            in: query
   664            description: id of the service associated with the instance
   665            schema:
   666              type: string
   667          - name: plan_id
   668            in: query
   669            description: id of the plan associated with the instance
   670            schema:
   671              type: string
   672          - name: operation
   673            in: query
   674            description: a provided identifier for the operation
   675            schema:
   676              type: string
   677        responses:
   678          '200':
   679            description: OK
   680            content:
   681              application/json:
   682                schema:
   683                  $ref: '#/components/schemas/LastOperationResource'
   684          '400':
   685            description: Bad Request
   686            content:
   687              application/json:
   688                schema:
   689                  $ref: '#/components/schemas/Error'
   690          '404':
   691            description: Not Found
   692            content:
   693              application/json:
   694                schema:
   695                  $ref: '#/components/schemas/Error'
   696          '410':
   697            description: Gone
   698            content:
   699              application/json:
   700                schema:
   701                  $ref: '#/components/schemas/Error'
   702  
   703    /oauth/v2/service_instances/{instance_id}/service_bindings/{binding_id}/last_operation:
   704      get:
   705        summary: last requested operation state for service binding
   706        security:
   707          - oAuth2ClientCredentials: ["broker:write"]
   708        tags:
   709          - Bindings (not implemented)
   710        operationId: serviceBinding.lastOperation.get
   711        parameters:
   712          - $ref: '#/components/parameters/APIVersion'
   713          - name: instance_id
   714            in: path
   715            description: instance id of instance to find last operation applied to it
   716            required: true
   717            schema:
   718              type: string
   719          - name: binding_id
   720            in: path
   721            description: binding id of service binding to find last operation applied to it
   722            required: true
   723            schema:
   724              type: string
   725          - name: service_id
   726            in: query
   727            description: id of the service associated with the instance
   728            schema:
   729              type: string
   730          - name: plan_id
   731            in: query
   732            description: id of the plan associated with the instance
   733            schema:
   734              type: string
   735          - name: operation
   736            in: query
   737            description: a provided identifier for the operation
   738            schema:
   739              type: string
   740        responses:
   741          '200':
   742            description: OK
   743            content:
   744              application/json:
   745                schema:
   746                  $ref: '#/components/schemas/LastOperationResource'
   747          '400':
   748            description: Bad Request
   749            content:
   750              application/json:
   751                schema:
   752                  $ref: '#/components/schemas/Error'
   753          '410':
   754            description: Gone
   755            content:
   756              application/json:
   757                schema:
   758                  $ref: '#/components/schemas/Error'
   759  
   760    /oauth/v2/service_instances/{instance_id}/service_bindings/{binding_id}:
   761      put:
   762        summary: generation of a service binding
   763        security:
   764          - oAuth2ClientCredentials: ["broker:write"]
   765        tags:
   766          - Bindings (not implemented)
   767        operationId: serviceBinding.binding
   768        parameters:
   769          - $ref: '#/components/parameters/APIVersion'
   770          - name: instance_id
   771            in: path
   772            description: instance id of instance to create a binding on
   773            required: true
   774            schema:
   775              type: string
   776          - name: binding_id
   777            in: path
   778            description: binding id of binding to create
   779            required: true
   780            schema:
   781              type: string
   782          - name: accepts_incomplete
   783            in: query
   784            description: asynchronous operations supported
   785            schema:
   786              type: boolean
   787        requestBody:
   788          description: parameters for the requested service binding
   789          required: true
   790          content:
   791            application/json:
   792              schema:
   793                $ref: '#/components/schemas/ServiceBindingRequest'
   794        responses:
   795          '200':
   796            description: OK
   797            content:
   798              application/json:
   799                schema:
   800                  $ref: '#/components/schemas/ServiceBinding'
   801          '201':
   802            description: Created
   803            content:
   804              application/json:
   805                schema:
   806                  $ref: '#/components/schemas/ServiceBinding'
   807          '202':
   808            description: Accepted
   809            content:
   810              application/json:
   811                schema:
   812                  $ref: '#/components/schemas/AsyncOperation'
   813          '400':
   814            description: Bad Request
   815            content:
   816              application/json:
   817                schema:
   818                  $ref: '#/components/schemas/Error'
   819          '409':
   820            description: Conflict
   821            content:
   822              application/json:
   823                schema:
   824                  $ref: '#/components/schemas/Error'
   825          '422':
   826            description: Unprocessable Entity
   827            content:
   828              application/json:
   829                schema:
   830                  $ref: '#/components/schemas/Error'
   831      delete:
   832        summary: deprovision of a service binding
   833        security:
   834          - oAuth2ClientCredentials: ["broker:write"]
   835        tags:
   836          - Bindings (not implemented)
   837        operationId: serviceBinding.unbinding
   838        parameters:
   839          - $ref: '#/components/parameters/APIVersion'
   840          - name: instance_id
   841            in: path
   842            description: id of the instance associated with the binding being deleted
   843            required: true
   844            schema:
   845              type: string
   846          - name: binding_id
   847            in: path
   848            description: id of the binding being deleted
   849            required: true
   850            schema:
   851              type: string
   852          - name: service_id
   853            in: query
   854            description: id of the service associated with the instance for which a binding is being deleted
   855            required: true
   856            schema:
   857              type: string
   858          - name: plan_id
   859            in: query
   860            description: id of the plan associated with the instance for which a binding is being deleted
   861            required: true
   862            schema:
   863              type: string
   864          - name: accepts_incomplete
   865            in: query
   866            description: asynchronous operations supported
   867            schema:
   868              type: boolean
   869        responses:
   870          '200':
   871            description: OK
   872            content:
   873              application/json:
   874                schema:
   875                  $ref: '#/components/schemas/Object'
   876          '202':
   877            description: Accepted
   878            content:
   879              application/json:
   880                schema:
   881                  $ref: '#/components/schemas/AsyncOperation'
   882          '400':
   883            description: Bad Request
   884            content:
   885              application/json:
   886                schema:
   887                  $ref: '#/components/schemas/Error'
   888          '410':
   889            description: Gone
   890            content:
   891              application/json:
   892                schema:
   893                  $ref: '#/components/schemas/Error'
   894      get:
   895        summary: gets a service binding
   896        security:
   897          - oAuth2ClientCredentials: ["broker:write"]
   898        tags:
   899          - Bindings (not implemented)
   900        operationId: serviceBinding.get
   901        parameters:
   902          - $ref: '#/components/parameters/APIVersion'
   903          - name: instance_id
   904            in: path
   905            description: instance id of instance associated with the binding
   906            required: true
   907            schema:
   908              type: string
   909          - name: binding_id
   910            in: path
   911            description: binding id of binding to fetch
   912            required: true
   913            schema:
   914              type: string
   915        responses:
   916          '200':
   917            description: OK
   918            content:
   919              application/json:
   920                schema:
   921                  $ref: '#/components/schemas/ServiceBindingResource'
   922          '404':
   923            description: Not Found
   924            content:
   925              application/json:
   926                schema:
   927                  $ref: '#/components/schemas/Error'
   928  
   929    /oauth/{region}/v2/catalog:
   930      get:
   931        summary: get the catalog of services that the service broker offers
   932        security:
   933          - oAuth2ClientCredentials: ["broker:write"]
   934        tags:
   935          - Catalog
   936        operationId: catalog.region.get
   937        parameters:
   938          - $ref: '#/components/parameters/APIVersion'
   939          - name: region
   940            in: path
   941            description: the region id
   942            required: true
   943            schema:
   944              type: string
   945        responses:
   946          '200':
   947            description: catalog response
   948            content:
   949              application/json:
   950                schema:
   951                  $ref: '#/components/schemas/Catalog'
   952  
   953    /oauth/{region}/v2/service_instances/{instance_id}:
   954      put:
   955        summary: provision a service instance
   956        security:
   957          - oAuth2ClientCredentials: ["broker:write"]
   958        tags:
   959          - Instances
   960        operationId: serviceInstance.region.provision
   961        parameters:
   962          - $ref: '#/components/parameters/APIVersion'
   963          - name: region
   964            in: path
   965            description: the region id
   966            required: true
   967            schema:
   968              type: string
   969          - name: instance_id
   970            in: path
   971            description: instance id of instance to provision
   972            required: true
   973            schema:
   974              type: string
   975        requestBody:
   976          description: parameters for the requested service instance provision
   977          required: true
   978          content:
   979            application/json:
   980              schema:
   981                $ref: '#/components/schemas/ServiceInstanceProvisionRequest'
   982        responses:
   983          '200':
   984            description: OK
   985            content:
   986              application/json:
   987                schema:
   988                  $ref: '#/components/schemas/ServiceInstanceProvision'
   989          '201':
   990            description: Created
   991            content:
   992              application/json:
   993                schema:
   994                  $ref: '#/components/schemas/ServiceInstanceProvision'
   995          '202':
   996            description: Accepted
   997            content:
   998              application/json:
   999                schema:
  1000                  $ref: '#/components/schemas/ServiceInstanceAsyncOperation'
  1001          '400':
  1002            description: Bad Request
  1003            content:
  1004              application/json:
  1005                schema:
  1006                  $ref: '#/components/schemas/Error'
  1007          '409':
  1008            description: Conflict
  1009            content:
  1010              application/json:
  1011                schema:
  1012                  $ref: '#/components/schemas/Error'
  1013          '422':
  1014            description: Unprocessable Entity
  1015            content:
  1016              application/json:
  1017                schema:
  1018                  $ref: '#/components/schemas/Error'
  1019      patch:
  1020        summary: update a service instance
  1021        security:
  1022          - oAuth2ClientCredentials: ["broker:write"]
  1023        tags:
  1024          - Instances
  1025        operationId: serviceInstance.region.update
  1026        parameters:
  1027          - $ref: '#/components/parameters/APIVersion'
  1028          - name: region
  1029            in: path
  1030            description: the region id
  1031            required: true
  1032            schema:
  1033              type: string
  1034          - name: instance_id
  1035            in: path
  1036            description: instance id of instance to update
  1037            required: true
  1038            schema:
  1039              type: string
  1040        requestBody:
  1041          description: parameters for the requested service instance update
  1042          required: true
  1043          content:
  1044            application/json:
  1045              schema:
  1046                $ref: '#/components/schemas/ServiceInstanceUpdateRequest'
  1047        responses:
  1048          '200':
  1049            description: OK
  1050            content:
  1051              application/json:
  1052                schema:
  1053                  $ref: '#/components/schemas/Object'
  1054          '202':
  1055            description: Accepted
  1056            content:
  1057              application/json:
  1058                schema:
  1059                  $ref: '#/components/schemas/ServiceInstanceAsyncOperation'
  1060          '400':
  1061            description: Bad Request
  1062            content:
  1063              application/json:
  1064                schema:
  1065                  $ref: '#/components/schemas/Error'
  1066          '422':
  1067            description: Unprocessable entity
  1068            content:
  1069              application/json:
  1070                schema:
  1071                  $ref: '#/components/schemas/Error'
  1072      delete:
  1073        summary: deprovision a service instance
  1074        security:
  1075          - oAuth2ClientCredentials: ["broker:write"]
  1076        tags:
  1077          - Instances
  1078        operationId: serviceInstance.region.deprovision
  1079        parameters:
  1080          - $ref: '#/components/parameters/APIVersion'
  1081          - name: region
  1082            in: path
  1083            description: the region id
  1084            required: true
  1085            schema:
  1086              type: string
  1087          - name: instance_id
  1088            in: path
  1089            description: id of instance being deleted
  1090            required: true
  1091            schema:
  1092              type: string
  1093          - name: service_id
  1094            in: query
  1095            description: id of the service associated with the instance being deleted
  1096            required: true
  1097            schema:
  1098              type: string
  1099          - name: plan_id
  1100            in: query
  1101            description: id of the plan associated with the instance being deleted
  1102            required: true
  1103            schema:
  1104              type: string
  1105          - name: force
  1106            in: query
  1107            schema:
  1108              type: boolean
  1109        responses:
  1110          '200':
  1111            description: OK
  1112            content:
  1113              application/json:
  1114                schema:
  1115                  $ref: '#/components/schemas/Object'
  1116          '202':
  1117            description: Accepted
  1118            content:
  1119              application/json:
  1120                schema:
  1121                  $ref: '#/components/schemas/AsyncOperation'
  1122          '400':
  1123            description: Bad Request
  1124            content:
  1125              application/json:
  1126                schema:
  1127                  $ref: '#/components/schemas/Error'
  1128          '410':
  1129            description: Gone
  1130            content:
  1131              application/json:
  1132                schema:
  1133                  $ref: '#/components/schemas/Error'
  1134          '422':
  1135            description: Unprocessable Entity
  1136            content:
  1137              application/json:
  1138                schema:
  1139                  $ref: '#/components/schemas/Error'
  1140      get:
  1141        summary: gets a service instance
  1142        security:
  1143          - oAuth2ClientCredentials: ["broker:write"]
  1144        tags:
  1145          - Instances
  1146        operationId: serviceInstance.region.get
  1147        parameters:
  1148          - $ref: '#/components/parameters/APIVersion'
  1149          - name: region
  1150            in: path
  1151            description: the region id
  1152            required: true
  1153            schema:
  1154              type: string
  1155          - name: instance_id
  1156            in: path
  1157            description: instance id of instance to fetch
  1158            required: true
  1159            schema:
  1160              type: string
  1161        responses:
  1162          '200':
  1163            description: OK
  1164            content:
  1165              application/json:
  1166                schema:
  1167                  $ref: '#/components/schemas/ServiceInstanceResource'
  1168          '404':
  1169            description: Not Found
  1170            content:
  1171              application/json:
  1172                schema:
  1173                  $ref: '#/components/schemas/Error'
  1174  
  1175    /oauth/{region}/v2/service_instances/{instance_id}/last_operation:
  1176      get:
  1177        summary: last requested operation state for service instance
  1178        security:
  1179          - oAuth2ClientCredentials: ["broker:write"]
  1180        tags:
  1181          - Instances
  1182        operationId: serviceInstance.region.lastOperation.get
  1183        parameters:
  1184          - $ref: '#/components/parameters/APIVersion'
  1185          - name: region
  1186            in: path
  1187            description: the region id
  1188            required: true
  1189            schema:
  1190              type: string
  1191          - name: instance_id
  1192            in: path
  1193            description: instance id of instance to find last operation applied to it
  1194            required: true
  1195            schema:
  1196              type: string
  1197          - name: service_id
  1198            in: query
  1199            description: id of the service associated with the instance
  1200            schema:
  1201              type: string
  1202          - name: plan_id
  1203            in: query
  1204            description: id of the plan associated with the instance
  1205            schema:
  1206              type: string
  1207          - name: operation
  1208            in: query
  1209            description: a provided identifier for the operation
  1210            schema:
  1211              type: string
  1212        responses:
  1213          '200':
  1214            description: OK
  1215            content:
  1216              application/json:
  1217                schema:
  1218                  $ref: '#/components/schemas/LastOperationResource'
  1219          '400':
  1220            description: Bad Request
  1221            content:
  1222              application/json:
  1223                schema:
  1224                  $ref: '#/components/schemas/Error'
  1225          '404':
  1226            description: Not Found
  1227            content:
  1228              application/json:
  1229                schema:
  1230                  $ref: '#/components/schemas/Error'
  1231          '410':
  1232            description: Gone
  1233            content:
  1234              application/json:
  1235                schema:
  1236                  $ref: '#/components/schemas/Error'
  1237  
  1238    /oauth/{region}/v2/service_instances/{instance_id}/service_bindings/{binding_id}/last_operation:
  1239      get:
  1240        summary: last requested operation state for service binding
  1241        security:
  1242          - oAuth2ClientCredentials: ["broker:write"]
  1243        tags:
  1244          - Bindings (not implemented)
  1245        operationId: serviceBinding.region.lastOperation.get
  1246        parameters:
  1247          - $ref: '#/components/parameters/APIVersion'
  1248          - name: region
  1249            in: path
  1250            description: the region id
  1251            required: true
  1252            schema:
  1253              type: string
  1254          - name: instance_id
  1255            in: path
  1256            description: instance id of instance to find last operation applied to it
  1257            required: true
  1258            schema:
  1259              type: string
  1260          - name: binding_id
  1261            in: path
  1262            description: binding id of service binding to find last operation applied to it
  1263            required: true
  1264            schema:
  1265              type: string
  1266          - name: service_id
  1267            in: query
  1268            description: id of the service associated with the instance
  1269            schema:
  1270              type: string
  1271          - name: plan_id
  1272            in: query
  1273            description: id of the plan associated with the instance
  1274            schema:
  1275              type: string
  1276          - name: operation
  1277            in: query
  1278            description: a provided identifier for the operation
  1279            schema:
  1280              type: string
  1281        responses:
  1282          '200':
  1283            description: OK
  1284            content:
  1285              application/json:
  1286                schema:
  1287                  $ref: '#/components/schemas/LastOperationResource'
  1288          '400':
  1289            description: Bad Request
  1290            content:
  1291              application/json:
  1292                schema:
  1293                  $ref: '#/components/schemas/Error'
  1294          '410':
  1295            description: Gone
  1296            content:
  1297              application/json:
  1298                schema:
  1299                  $ref: '#/components/schemas/Error'
  1300  
  1301    /oauth/{region}/v2/service_instances/{instance_id}/service_bindings/{binding_id}:
  1302      put:
  1303        summary: generation of a service binding
  1304        security:
  1305          - oAuth2ClientCredentials: ["broker:write"]
  1306        tags:
  1307          - Bindings (not implemented)
  1308        operationId: serviceBinding.region.binding
  1309        parameters:
  1310          - $ref: '#/components/parameters/APIVersion'
  1311          - name: region
  1312            in: path
  1313            description: the region id
  1314            required: true
  1315            schema:
  1316              type: string
  1317          - name: instance_id
  1318            in: path
  1319            description: instance id of instance to create a binding on
  1320            required: true
  1321            schema:
  1322              type: string
  1323          - name: binding_id
  1324            in: path
  1325            description: binding id of binding to create
  1326            required: true
  1327            schema:
  1328              type: string
  1329          - name: accepts_incomplete
  1330            in: query
  1331            description: asynchronous operations supported
  1332            schema:
  1333              type: boolean
  1334        requestBody:
  1335          description: parameters for the requested service binding
  1336          required: true
  1337          content:
  1338            application/json:
  1339              schema:
  1340                $ref: '#/components/schemas/ServiceBindingRequest'
  1341        responses:
  1342          '200':
  1343            description: OK
  1344            content:
  1345              application/json:
  1346                schema:
  1347                  $ref: '#/components/schemas/ServiceBinding'
  1348          '201':
  1349            description: Created
  1350            content:
  1351              application/json:
  1352                schema:
  1353                  $ref: '#/components/schemas/ServiceBinding'
  1354          '202':
  1355            description: Accepted
  1356            content:
  1357              application/json:
  1358                schema:
  1359                  $ref: '#/components/schemas/AsyncOperation'
  1360          '400':
  1361            description: Bad Request
  1362            content:
  1363              application/json:
  1364                schema:
  1365                  $ref: '#/components/schemas/Error'
  1366          '409':
  1367            description: Conflict
  1368            content:
  1369              application/json:
  1370                schema:
  1371                  $ref: '#/components/schemas/Error'
  1372          '422':
  1373            description: Unprocessable Entity
  1374            content:
  1375              application/json:
  1376                schema:
  1377                  $ref: '#/components/schemas/Error'
  1378      delete:
  1379        summary: deprovision of a service binding
  1380        security:
  1381          - oAuth2ClientCredentials: ["broker:write"]
  1382        tags:
  1383          - Bindings (not implemented)
  1384        operationId: serviceBinding.region.unbinding
  1385        parameters:
  1386          - $ref: '#/components/parameters/APIVersion'
  1387          - name: region
  1388            in: path
  1389            description: the region id
  1390            required: true
  1391            schema:
  1392              type: string
  1393          - name: instance_id
  1394            in: path
  1395            description: id of the instance associated with the binding being deleted
  1396            required: true
  1397            schema:
  1398              type: string
  1399          - name: binding_id
  1400            in: path
  1401            description: id of the binding being deleted
  1402            required: true
  1403            schema:
  1404              type: string
  1405          - name: service_id
  1406            in: query
  1407            description: id of the service associated with the instance for which a binding is being deleted
  1408            required: true
  1409            schema:
  1410              type: string
  1411          - name: plan_id
  1412            in: query
  1413            description: id of the plan associated with the instance for which a binding is being deleted
  1414            required: true
  1415            schema:
  1416              type: string
  1417          - name: accepts_incomplete
  1418            in: query
  1419            description: asynchronous operations supported
  1420            schema:
  1421              type: boolean
  1422        responses:
  1423          '200':
  1424            description: OK
  1425            content:
  1426              application/json:
  1427                schema:
  1428                  $ref: '#/components/schemas/Object'
  1429          '202':
  1430            description: Accepted
  1431            content:
  1432              application/json:
  1433                schema:
  1434                  $ref: '#/components/schemas/AsyncOperation'
  1435          '400':
  1436            description: Bad Request
  1437            content:
  1438              application/json:
  1439                schema:
  1440                  $ref: '#/components/schemas/Error'
  1441          '410':
  1442            description: Gone
  1443            content:
  1444              application/json:
  1445                schema:
  1446                  $ref: '#/components/schemas/Error'
  1447      get:
  1448        summary: gets a service binding
  1449        security:
  1450          - oAuth2ClientCredentials: ["broker:write"]
  1451        tags:
  1452          - Bindings (not implemented)
  1453        operationId: serviceBinding.region.get
  1454        parameters:
  1455          - $ref: '#/components/parameters/APIVersion'
  1456          - name: region
  1457            in: path
  1458            description: the region id
  1459            required: true
  1460            schema:
  1461              type: string
  1462          - name: instance_id
  1463            in: path
  1464            description: instance id of instance associated with the binding
  1465            required: true
  1466            schema:
  1467              type: string
  1468          - name: binding_id
  1469            in: path
  1470            description: binding id of binding to fetch
  1471            required: true
  1472            schema:
  1473              type: string
  1474        responses:
  1475          '200':
  1476            description: OK
  1477            content:
  1478              application/json:
  1479                schema:
  1480                  $ref: '#/components/schemas/ServiceBindingResource'
  1481          '404':
  1482            description: Not Found
  1483            content:
  1484              application/json:
  1485                schema:
  1486                  $ref: '#/components/schemas/Error'
  1487  
  1488  components:
  1489    parameters:
  1490      APIVersion:
  1491        name: X-Broker-API-Version
  1492        in: header
  1493        description: version number of the Service Broker API that the Platform will use
  1494        required: true
  1495        schema:
  1496          type: string
  1497          default: '2.14'
  1498  
  1499    schemas:
  1500      OrchestrationParameters:
  1501        type: object
  1502        properties:
  1503          strategy:
  1504            type: object
  1505            properties:
  1506              type:
  1507                type: string
  1508                example: parallel
  1509                enum: [
  1510                    "parallel"
  1511                ]
  1512                description: "Specifies the type of the orchestration"
  1513              schedule:
  1514                type: string
  1515                enum: [
  1516                    "immediate",
  1517                    "maintenanceWindow"
  1518                ]
  1519                example: immediate
  1520                description: "Specifies the schedule type for an orchestration"
  1521              parallel:
  1522                type: object
  1523                properties:
  1524                  workers:
  1525                    type: number
  1526                    example: 1
  1527                    description: Specifies the number of parallel workers to process upgrade operations
  1528          dryRun:
  1529            type: boolean
  1530            default: false
  1531            description: Specifies if the orchestration is used for testing purposes
  1532          version:
  1533            type: string
  1534            example: 1.18.0|PR-123|main-00e83e99
  1535            description: Specifies Kyma version for the upgrade operation. Supports semantic, PR, and branch-commit as Kyma version.
  1536          targets:
  1537            type: object
  1538            properties:
  1539              include:
  1540                type: array
  1541                items:
  1542                  $ref: '#/components/schemas/RuntimeTarget'
  1543              exclude:
  1544                type: array
  1545                items:
  1546                  $ref: '#/components/schemas/RuntimeTarget'
  1547  
  1548      RuntimeTarget:
  1549        type: object
  1550        properties:
  1551          target:
  1552            type: string
  1553            enum: [
  1554                "all"
  1555            ]
  1556            example: all
  1557            description: "Selects Runtimes in a specified way"
  1558          globalAccount:
  1559            type: string
  1560            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1561            description: Regex pattern to match against Runtime's globalAccount field
  1562          subAccount:
  1563            type: string
  1564            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1565            description: Regex pattern to match against Runtime's subAccount field
  1566          region:
  1567            type: string
  1568            example: europe|eu-
  1569            description: Regex pattern to match against the Shoot cluster's region field (not SCP platform region)
  1570          runtimeID:
  1571            type: string
  1572            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1573            description: Specifies runtimeID
  1574          planName:
  1575            type: string
  1576            example: azure
  1577            description: Specifies plan name
  1578          shoot:
  1579            type: string
  1580            example: c-0ab3fe0
  1581            description: Match Runtime by shoot name
  1582  
  1583      StatusResponse:
  1584        type: object
  1585        properties:
  1586          type:
  1587            type: string
  1588            enum: [
  1589                "upgradeKyma",
  1590                "upgradeCluster"
  1591            ]
  1592            description: "Orchestration type, either kyma upgrade or cluster upgrade"
  1593            example: "upgradeKyma"
  1594          state:
  1595            type: string
  1596            example: in progress
  1597          description:
  1598            type: string
  1599            example: Orchestration scheduled
  1600          parameters:
  1601            $ref: '#/components/schemas/OrchestrationParameters'
  1602          operationStats:
  1603            type: object
  1604            description: Number of operations per operation state
  1605            additionalProperties:
  1606              type: integer
  1607  
  1608      StatusResponseList:
  1609        type: object
  1610        properties:
  1611          data:
  1612            type: array
  1613            items:
  1614              $ref: '#/components/schemas/StatusResponse'
  1615          count:
  1616            type: integer
  1617            example: 0
  1618          totalCount:
  1619            type: integer
  1620            example: 0
  1621  
  1622      OperationResponse:
  1623        type: object
  1624        properties:
  1625          instanceID:
  1626            type: string
  1627            format: uuid
  1628            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1629          runtimeID:
  1630            type: string
  1631            format: uuid
  1632            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1633          operationID:
  1634            type: string
  1635            format: uuid
  1636            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1637          globalAccountID:
  1638            type: string
  1639            format: uuid
  1640            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1641          subAccountID:
  1642            type: string
  1643            format: uuid
  1644            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1645          state:
  1646            type: string
  1647            example: in progress
  1648            enum: [
  1649                "suceeded",
  1650                "failed",
  1651                "in progress"
  1652            ]
  1653          description:
  1654            type: string
  1655            example: Operation scheduled
  1656          shootName:
  1657            type: string
  1658            example: c-8e9ea4f
  1659            description: Name of the Shoot cluster on Gardener
  1660          maintenanceWindowBegin:
  1661            type: string
  1662            example: 150405-0000
  1663            description: Start time of the orchestrations processing
  1664          maintenanceWindowEnd:
  1665            type: string
  1666            example: 160405-0000
  1667            description: Orchestrations processing deadline
  1668          dryRun:
  1669            type: boolean
  1670            default: false
  1671            description: Specifies if the orchestration is used for testing purposes
  1672          servicePlanID:
  1673            type: string
  1674            format: uuid
  1675            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1676            description: ID of the service plan
  1677          servicePlanName:
  1678            type: string
  1679            example: azure
  1680            description: Specifies the plan name
  1681  
  1682      OperationDetailsResponse:
  1683        type: object
  1684        properties:
  1685          instanceID:
  1686            type: string
  1687            format: uuid
  1688            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1689          runtimeID:
  1690            type: string
  1691            format: uuid
  1692            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1693          operationID:
  1694            type: string
  1695            format: uuid
  1696            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1697          globalAccountID:
  1698            type: string
  1699            format: uuid
  1700            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1701          subAccountID:
  1702            type: string
  1703            format: uuid
  1704            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1705          state:
  1706            type: string
  1707            enum: [
  1708                "suceeded",
  1709                "failed",
  1710                "in progress"
  1711            ]
  1712            example: in progress
  1713          description:
  1714            type: string
  1715            example: Operation scheduled
  1716          shootName:
  1717            type: string
  1718            example: c-8e9ea4f
  1719            description: Name of the Shoot cluster on Gardener
  1720          maintenanceWindowBegin:
  1721            type: string
  1722            example: 150405-0000
  1723            description: Start time of the orchestrations processing
  1724          maintenanceWindowEnd:
  1725            type: string
  1726            example: 160405-0000
  1727            description: Orchestrations processing deadline
  1728          dryRun:
  1729            type: boolean
  1730            default: false
  1731            description: Specifies if the orchestration is used for testing purposes
  1732          servicePlanID:
  1733            type: string
  1734            format: uuid
  1735            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1736            description: ID of the service plan
  1737          servicePlanName:
  1738            type: string
  1739            example: azure
  1740            description: Specifies the plan name
  1741          kymaConfig:
  1742            type: string
  1743            description: Object with the Kyma config sent to Runtime Provisioner
  1744          clusterConfig:
  1745            type: string
  1746            description: Object with the cluster config sent to Runtime Provisioner
  1747  
  1748      OperationResponseList:
  1749        type: object
  1750        properties:
  1751          data:
  1752            type: array
  1753            items:
  1754              $ref: '#/components/schemas/OperationResponse'
  1755          count:
  1756            type: integer
  1757            example: 0
  1758          totalCount:
  1759            type: integer
  1760            example: 0
  1761  
  1762      UpgradeResponse:
  1763        type: object
  1764        properties:
  1765          orchestrationID:
  1766            type: string
  1767            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1768  
  1769      RuntimeDTO:
  1770        type: object
  1771        properties:
  1772          instanceID:
  1773            type: string
  1774            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1775          runtimeID:
  1776            type: string
  1777            format: uuid
  1778            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1779          globalAccountID:
  1780            type: string
  1781            format: uuid
  1782            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1783          subaccountID:
  1784            type: string
  1785            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1786          subaccountRegion:
  1787            type: string
  1788          shootName:
  1789            type: string
  1790            example: c-8e9ea4f
  1791            description: Name of the Shoot cluster on Gardener
  1792          serviceClassID:
  1793            type: string
  1794            format: uuid
  1795            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1796          serviceClassName:
  1797            type: string
  1798            example: kymaruntime
  1799          servicePlanID:
  1800            type: string
  1801            format: uuid
  1802            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1803          servicePlanName:
  1804            type: string
  1805            example: azure
  1806          status:
  1807            $ref: '#/components/schemas/StatusDTO'
  1808  
  1809      EventDTO:
  1810        type: object
  1811        properties:
  1812          level:
  1813            type: string
  1814            example: info
  1815            enum: [
  1816                "info",
  1817                "error"
  1818            ]
  1819          instanceID:
  1820            type: string
  1821            example: test-instance-123
  1822          operationID:
  1823            type: string
  1824            format: uuid
  1825            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  1826          message:
  1827            type: string
  1828            example: "processing step: [Remove_Runtime]"
  1829          createdAt:
  1830            type: string
  1831            format: timestamp
  1832            example: "2022-10-18T13:52:24.598517Z"
  1833  
  1834      RuntimePage:
  1835        type: object
  1836        properties:
  1837          data:
  1838            type: array
  1839            items:
  1840              $ref: '#/components/schemas/RuntimeDTO'
  1841          count:
  1842            type: integer
  1843            example: 0
  1844          totalCount:
  1845            type: integer
  1846            example: 0
  1847  
  1848      StatusDTO:
  1849        type: object
  1850        properties:
  1851          createdAt:
  1852            type: string
  1853            format: timestamp
  1854          modifiedAt:
  1855            type: string
  1856            format: timestamp
  1857          provisioning:
  1858            $ref: '#/components/schemas/OperationStateDTO'
  1859          deprovisioning:
  1860            $ref: '#/components/schemas/OperationStateDTO'
  1861          upgradingKyma:
  1862            $ref: '#/components/schemas/OperationsDataDTO'
  1863          suspension:
  1864            $ref: '#/components/schemas/OperationsDataDTO'
  1865          unsuspension:
  1866            $ref: '#/components/schemas/OperationsDataDTO'
  1867  
  1868      OperationStateDTO:
  1869        type: object
  1870        properties:
  1871          state:
  1872            type: string
  1873            example: in progress
  1874            enum: [
  1875                "suceeded",
  1876                "failed",
  1877                "in progress"
  1878            ]
  1879          description:
  1880            type: string
  1881            example: Operation scheduled
  1882          createdAt:
  1883            type: string
  1884            format: timestamp
  1885          operationID:
  1886            type: string
  1887            format: uuid
  1888  
  1889      OperationsDataDTO:
  1890        type: object
  1891        properties:
  1892          data:
  1893            type: array
  1894            items:
  1895              $ref: '#/components/schemas/OperationStateDTO'
  1896          count:
  1897            type: integer
  1898          totalCount:
  1899            type: integer
  1900  
  1901      OrchestrationError:
  1902        type: object
  1903        properties:
  1904          error:
  1905            type: string
  1906            example: "while decoding request body: invalid character '}' looking for beginning of object key string"
  1907  
  1908      Catalog:
  1909        type: object
  1910        properties:
  1911          services:
  1912            type: array
  1913            items:
  1914              $ref: '#/components/schemas/Service'
  1915  
  1916      Service:
  1917        type: object
  1918        required:
  1919          - name
  1920          - id
  1921          - description
  1922          - bindable
  1923          - plans
  1924        properties:
  1925          name:
  1926            type: string
  1927            example: kymaruntime
  1928            description: Service's name
  1929          id:
  1930            type: string
  1931            format: uuid
  1932            example: 47c9dcbf-ff30-448e-ab36-d3bad66ba281
  1933            description: Service's ID
  1934          description:
  1935            type: string
  1936            example: Kyma environment is a runtime you can use to build cloud-native Kubernetes-based applications by using microservices and serverless functions.
  1937            description: Service's description
  1938          tags:
  1939            type: array
  1940            items:
  1941              type: string
  1942          bindable:
  1943            type: boolean
  1944            description: Specifies if service is bindable
  1945            default: true
  1946          metadata:
  1947            $ref: '#/components/schemas/ServiceMetadata'
  1948          plan_updateable:
  1949            type: boolean
  1950            description: Specifies if plan can be updated
  1951            default: false
  1952          plans:
  1953            type: array
  1954            items:
  1955              $ref: '#/components/schemas/Plan'
  1956  
  1957      Plan:
  1958        type: object
  1959        required:
  1960          - id
  1961          - name
  1962          - description
  1963        properties:
  1964          id:
  1965            type: string
  1966            format: uuid
  1967            example: 47c9dcbf-ff30-448e-ab36-d3bad66ba281
  1968            description: Service's plan ID
  1969          name:
  1970            type: string
  1971            example: azure
  1972            description: Service's plan name
  1973          description:
  1974            type: string
  1975            example: Azure
  1976            description: Service's plan description
  1977          metadata:
  1978            $ref: '#/components/schemas/PlanMetadata'
  1979          bindable:
  1980            type: boolean
  1981            default: true
  1982            description: Specifies if plan is bindable
  1983          schemas:
  1984            $ref: '#/components/schemas/Schemas'
  1985  
  1986      Schemas:
  1987        type: object
  1988        properties:
  1989          service_instance:
  1990            $ref: '#/components/schemas/ServiceInstanceSchema'
  1991          service_binding:
  1992            $ref: '#/components/schemas/ServiceBindingSchema'
  1993  
  1994      ServiceInstanceSchema:
  1995        type: object
  1996        properties:
  1997          create:
  1998            $ref: '#/components/schemas/SchemaParameters'
  1999          update:
  2000            $ref: '#/components/schemas/SchemaParameters'
  2001  
  2002      ServiceBindingSchema:
  2003        type: object
  2004        properties:
  2005          create:
  2006            $ref: '#/components/schemas/SchemaParameters'
  2007  
  2008      SchemaParameters:
  2009        type: object
  2010        properties:
  2011          parameters:
  2012            type: object
  2013  
  2014      ServiceInstanceResource:
  2015        type: object
  2016        properties:
  2017          service_id:
  2018            type: string
  2019            format: uuid
  2020            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2021          plan_id:
  2022            type: string
  2023            format: uuid
  2024            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2025          dashboard_url:
  2026            type: string
  2027            example: https://dashboard.kyma.com
  2028          parameters:
  2029            $ref: '#/components/schemas/Object'
  2030  
  2031      ServiceInstanceProvisionRequest:
  2032        type: object
  2033        required:
  2034          - service_id
  2035          - plan_id
  2036        properties:
  2037          service_id:
  2038            type: string
  2039            format: uuid
  2040            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2041          plan_id:
  2042            type: string
  2043            format: uuid
  2044            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2045          context:
  2046            $ref: '#/components/schemas/Context'
  2047          parameters:
  2048            $ref: '#/components/schemas/ServiceInstanceProvisionRequestParameters'
  2049  
  2050      OIDC:
  2051        type: object
  2052        properties:
  2053          clientID:
  2054            type: string
  2055            description: The client ID for the OpenID Connect client
  2056            format: uuid
  2057            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2058          groupsClaim:
  2059            type: string
  2060            description: If provided, the name of a custom OpenID Connect claim for specifying user groups
  2061            example: groups
  2062          issuerURL:
  2063            type: string
  2064            description: The URL of the OpenID issuer, only HTTPS scheme will be accepted
  2065            example: https://kymatest.accounts400.ondemand.com
  2066          signingAlgs:
  2067            type: array
  2068            description: List of allowed JOSE asymmetric signing algorithms
  2069            items:
  2070              type: string
  2071              example: "RS256"
  2072          usernameClaim:
  2073            type: string
  2074            description: The OpenID claim to use as the user name
  2075            example: "sub"
  2076          usernamePrefix:
  2077            type: string
  2078            description: If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'
  2079            example: "-"
  2080  
  2081      ServiceInstanceProvisionRequestParameters:
  2082        type: object
  2083        required:
  2084          - name
  2085        properties:
  2086          name:
  2087            type: string
  2088          targetSecret:
  2089            type: string
  2090          volumeSizeGb:
  2091            type: integer
  2092            example: 25
  2093          machineType:
  2094            type: string
  2095            example: Standard_D8_v3
  2096          region:
  2097            type: string
  2098            example: "westeurope"
  2099          purpose:
  2100            type: string
  2101            example: evaluation
  2102          licence_type:
  2103            type: string
  2104            example: TestDevelopmentAndDemo
  2105          zones:
  2106            type: array
  2107            items:
  2108              type: string
  2109          zonesCount:
  2110            type: integer
  2111            example: 1
  2112          autoScalerMin:
  2113            type: integer
  2114            example: 3
  2115          autoScalerMax:
  2116            type: integer
  2117            example: 10
  2118          maxSurge:
  2119            type: integer
  2120            example: 2
  2121          maxUnavailable:
  2122            type: integer
  2123            example: 2
  2124          components:
  2125            type: array
  2126            items:
  2127              type: string
  2128          kymaVersion:
  2129            type: string
  2130            example: "2.0"
  2131          overridesVersion:
  2132            type: string
  2133          administrators:
  2134            type: array
  2135            items:
  2136              type: string
  2137          provider:
  2138            type: string
  2139            enum: ["Azure", "AWS", "GCP", "OpenStack"]
  2140          oidc:
  2141            $ref: '#/components/schemas/OIDC'
  2142          service_id:
  2143            type: string
  2144            format: uuid
  2145            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2146          plan_id:
  2147            type: string
  2148            format: uuid
  2149            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2150  
  2151      ServiceInstanceProvisionLabels:
  2152        type: object
  2153        properties:
  2154          Name:
  2155            type: string
  2156            example: instance123
  2157          KubeconfigURL:
  2158            type: string
  2159            format: url
  2160            example: https://kubeconfigs.kyma.com/kubeconfig/instance123
  2161  
  2162      ServiceInstanceProvisionMeta:
  2163        type: object
  2164        properties:
  2165          labels:
  2166            $ref: '#/components/schemas/ServiceInstanceProvisionLabels'
  2167  
  2168      ServiceInstanceProvision:
  2169        type: object
  2170        properties:
  2171          operation:
  2172            type: string
  2173            format: uuid
  2174            example: c64c69ac-b3fc-4d3a-9fe8-a8acc850b1f4
  2175          dashboard_url:
  2176            type: string
  2177            example: https://dashboard.kyma.com
  2178          metadata:
  2179            $ref: '#/components/schemas/ServiceInstanceProvisionMeta'
  2180  
  2181      ServiceInstanceAsyncOperation:
  2182        type: object
  2183        properties:
  2184          operation:
  2185            type: string
  2186            format: uuid
  2187            example: c64c69ac-b3fc-4d3a-9fe8-a8acc850b1f4
  2188          dashboard_url:
  2189            type: string
  2190            example: https://dashboard.kyma.com
  2191          metadata:
  2192            $ref: '#/components/schemas/ServiceInstanceProvisionMeta'
  2193  
  2194      ServiceInstanceUpdateRequest:
  2195        type: object
  2196        required:
  2197          - service_id
  2198        properties:
  2199          context:
  2200            $ref: '#/components/schemas/Context'
  2201          service_id:
  2202            type: string
  2203            format: uuid
  2204            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2205          plan_id:
  2206            type: string
  2207            format: uuid
  2208            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2209          parameters:
  2210            $ref: '#/components/schemas/ServiceInstanceUpdateRequestParams'
  2211          previous_values:
  2212            $ref: '#/components/schemas/ServiceInstancePreviousValues'
  2213  
  2214      ServiceInstanceUpdateRequestParams:
  2215        type: object
  2216        properties:
  2217          autoScalerMin:
  2218            type: integer
  2219            example: 3
  2220          autoScalerMax:
  2221            type: integer
  2222            example: 10
  2223          maxSurge:
  2224            type: integer
  2225            example: 2
  2226          maxUnavailable:
  2227            type: integer
  2228            example: 2
  2229          oidc:
  2230            $ref: '#/components/schemas/OIDC'
  2231  
  2232      ServiceInstancePreviousValues:
  2233        type: object
  2234        properties:
  2235          plan_id:
  2236            type: string
  2237            format: uuid
  2238            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2239  
  2240      AsyncOperation:
  2241        type: object
  2242        properties:
  2243          operation:
  2244            type: string
  2245  
  2246      LastOperationResource:
  2247        type: object
  2248        required:
  2249          - state
  2250        properties:
  2251          state:
  2252            type: string
  2253            enum:
  2254              - in progress
  2255              - succeeded
  2256              - failed
  2257          description:
  2258            type: string
  2259  
  2260      ServiceBindingResource:
  2261        type: object
  2262        properties:
  2263          credentials:
  2264            $ref: '#/components/schemas/Object'
  2265          syslog_drain_url:
  2266            type: string
  2267          route_service_url:
  2268            type: string
  2269          volume_mounts:
  2270            type: array
  2271            items:
  2272              $ref: '#/components/schemas/ServiceBindingVolumeMount'
  2273          parameters:
  2274            $ref: '#/components/schemas/Object'
  2275  
  2276      ServiceBindingRequest:
  2277        type: object
  2278        required:
  2279          - service_id
  2280          - plan_id
  2281        properties:
  2282          context:
  2283            $ref: '#/components/schemas/Context'
  2284          service_id:
  2285            type: string
  2286            format: uuid
  2287            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2288          plan_id:
  2289            type: string
  2290            format: uuid
  2291            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2292          parameters:
  2293            $ref: '#/components/schemas/Object'
  2294  
  2295      ServiceBinding:
  2296        type: object
  2297        properties:
  2298          credentials:
  2299            $ref: '#/components/schemas/Object'
  2300          syslog_drain_url:
  2301            type: string
  2302          route_service_url:
  2303            type: string
  2304          volume_mounts:
  2305            type: array
  2306            items:
  2307              $ref: '#/components/schemas/ServiceBindingVolumeMount'
  2308  
  2309      ServiceBindingVolumeMount:
  2310        type: object
  2311        required:
  2312          - driver
  2313          - container_dir
  2314          - mode
  2315          - device_type
  2316          - device
  2317        properties:
  2318          driver:
  2319            type: string
  2320          container_dir:
  2321            type: string
  2322          mode:
  2323            type: string
  2324            enum:
  2325              - r
  2326              - rw
  2327          device_type:
  2328            type: string
  2329            enum:
  2330              - shared
  2331          device:
  2332            $ref: '#/components/schemas/ServiceBindingVolumeMountDevice'
  2333  
  2334      ServiceBindingVolumeMountDevice:
  2335        type: object
  2336        required:
  2337          - volume_id
  2338        properties:
  2339          volume_id:
  2340            type: string
  2341          mount_config:
  2342            $ref: '#/components/schemas/Object'
  2343  
  2344      ServiceManagerCredentialsBasic:
  2345        type: object
  2346        properties:
  2347          username:
  2348            type: string
  2349          password:
  2350            type: string
  2351  
  2352      ServiceManagerCredentials:
  2353        type: object
  2354        properties:
  2355          basic:
  2356            $ref: '#/components/schemas/ServiceManagerCredentialsBasic'
  2357  
  2358      SMPlatformCredentials:
  2359        type: object
  2360        properties:
  2361          credentials:
  2362            $ref: '#/components/schemas/ServiceManagerCredentials'
  2363          url:
  2364            type: string
  2365  
  2366      Context:
  2367        description: "See [Context Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#context-object) for more details."
  2368        type: object
  2369        properties:
  2370          globalaccount_id:
  2371            type: string
  2372            format: uuid
  2373            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2374          subaccount_id:
  2375            type: string
  2376            format: uuid
  2377            example: 054ac2c2-318f-45dd-855c-eee41513d40d
  2378          tenant_id:
  2379            type: string
  2380          sm_platform_credentials:
  2381            $ref: '#/components/schemas/SMPlatformCredentials'
  2382          active:
  2383            type: boolean
  2384          user_id:
  2385            type: string
  2386  
  2387      ServiceMetadata:
  2388        description: "See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details."
  2389        type: object
  2390        properties:
  2391          displayName:
  2392            type: string
  2393            example: Kyma Environment
  2394          documentationUrl:
  2395            type: string
  2396            example: https://github.com/kyma-project/control-plane/tree/main/docs/kyma-environment-broker
  2397          imageUrl:
  2398            type: string
  2399            example: data:image/svg+xml;base64,imgURL
  2400          longDescription:
  2401            type: string
  2402            example: Kyma environment is a runtime you can use to build cloud-native Kubernetes-based applications by using microservices and serverless functions.
  2403          providerDisplayName:
  2404            type: string
  2405            example: provider
  2406          supportUrl:
  2407            type: string
  2408            example: https://support.com/
  2409  
  2410      PlanMetadata:
  2411        description: "See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details."
  2412        type: object
  2413        properties:
  2414          displayName:
  2415            type: string
  2416            example: Azure
  2417  
  2418      Object:
  2419        type: object
  2420  
  2421      Error:
  2422        description: "See [Service Broker Errors](https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors) for more details."
  2423        type: object
  2424        properties:
  2425          error:
  2426            type: string
  2427            example: not found error
  2428          description:
  2429            type: string
  2430            example: instance was not found
  2431    securitySchemes:
  2432      oAuth2ClientCredentials:
  2433        type: oauth2
  2434        flows:
  2435          clientCredentials:
  2436            tokenUrl: https://oauth2.{{.domain}}/oauth2/token
  2437            scopes:
  2438              broker:write: Grants access to OSB API
  2439  
  2440  externalDocs:
  2441    description: The offical Kyma Environment Broker documentation
  2442    url: 'https://github.com/kyma-project/control-plane/tree/main/docs/kyma-environment-broker'