Skip to content

Commit e6d9b14

Browse files
authored
accepts_incomplete is a param, not a request body field
1 parent f81f49e commit e6d9b14

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

spec.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -353,15 +353,20 @@ When the broker receives a provision request from the platform, it should take w
353353

354354
The `:instance_id` of a service instance is provided by the platform. This ID will be used for future requests (bind and deprovision), so the broker must use it to correlate the resource it creates.
355355

356+
#### Parameters ####
357+
| Parameter name | Type | Description |
358+
|---|---|---|
359+
| accepts_incomplete | boolean | A value of true indicates that the marketplace and its clients support asynchronous broker operations. If this parameter is not included in the request, and the broker can only provision an instance of the requested plan asynchronously, the broker should reject the request with a 422 as described below. |
360+
361+
356362
##### Body #####
357363
| Request field | Type | Description |
358364
|---|---|---|
359365
| service_id* | string | The ID of the service (from the catalog). Must be globally unique. |
360366
| plan_id* | string | The ID of the plan (from the catalog) for which the service instance has been requested. Must be unique to a service. |
361-
| parameters | JSON object | Configuration options for the service instance. |
362-
| accepts_incomplete | boolean | A value of true indicates that the marketplace and its clients support asynchronous broker operations. If this parameter is not included in the request, and the broker can only provision an instance of the requested plan asynchronously, the broker should reject the request with a 422 as described below. |
363367
| organization_guid* | string | The platform GUID for the organization under which the service is to be provisioned. Although most brokers will not use this field, it may be helpful for executing operations on a user's behalf. |
364368
| space_guid* | string | The identifier for the project space within the platform organization. Although most brokers will not use this field, it may be helpful for executing operations on a user's behalf. |
369+
| parameters | JSON object | Configuration options for the service instance. |
365370

366371
\* Fields with an asterisk are required.
367372

@@ -380,7 +385,7 @@ The `:instance_id` of a service instance is provided by the platform. This ID wi
380385

381386
##### cURL #####
382387
<pre class="terminal">
383-
$ curl http://username:password@broker-url/v2/service_instances/:instance_id -d '{
388+
$ curl http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d '{
384389
"service_id": "service-guid-here",
385390
"plan_id": "plan-guid-here",
386391
"organization_guid": "org-guid-here",
@@ -441,14 +446,18 @@ Not all permutations of plan changes are expected to be supported. For example,
441446

442447
`:instance_id` is the global unique ID of a previously-provisioned service instance.
443448

449+
#### Parameters ####
450+
| Parameter name | Type | Description |
451+
|---|---|---|
452+
| accepts\_incomplete | boolean | A value of true indicates that the marketplace and its clients support asynchronous broker operations. If this parameter is not included in the request, and the broker can only provision an instance of the requested plan asynchronously, the broker should reject the request with a 422 as described below. |
453+
444454
##### Body #####
445455

446456
| Request Field | Type | Description |
447457
|---|---|---|
448458
| service\_id* | string | The ID of the service (from the catalog). Must be globally unique. |
449459
| plan\_id | string | The ID of the plan (from the catalog) for which the service instance has been requested. Must be unique to a service. |
450460
| parameters | JSON object | Configuration options for the service instance. |
451-
| accepts\_incomplete | boolean | A value of true indicates that the marketplace and its clients support asynchronous broker operations. If this parameter is not included in the request, and the broker can only provision an instance of the requested plan asynchronously, the broker should reject the request with a 422 as described below. |
452461
| previous\_values | object | Information about the instance prior to the update. |
453462
| previous\_values.service_id | string | ID of the service for the instance. |
454463
| previous\_values.plan_id | string | ID of the plan prior to the update. |
@@ -476,7 +485,7 @@ Not all permutations of plan changes are expected to be supported. For example,
476485

477486
##### cURL #####
478487
<pre class="terminal">
479-
$ curl http://username:password@broker-url/v2/service_instances/:instance_id -d '{
488+
$ curl http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d '{
480489
"service_id": "service-guid-here",
481490
"plan_id": "plan-guid-here",
482491
"parameters": {
@@ -718,8 +727,8 @@ The request provides these query string parameters as useful hints for brokers.
718727

719728
##### cURL #####
720729
<pre class="terminal">
721-
$ curl 'http://username:password@broker-url/v2/service_instances/:instance_id?service_id=
722-
service-id-here&plan_id=plan-id-here' -X DELETE -H "X-Broker-API-Version: 2.11"
730+
$ curl 'http://username:password@broker-url/v2/service_instances/:instance_id?accepts_incomplete=true
731+
&service_id=service-id-here&plan_id=plan-id-here' -X DELETE -H "X-Broker-API-Version: 2.11"
723732
</pre>
724733

725734
### Response ###

0 commit comments

Comments
 (0)