Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 4c4b2b4

Browse files
v3 GA service plans endpoints
[#172351417](https://www.pivotaltracker.com/story/show/172351417)
1 parent 741ca24 commit 4c4b2b4

9 files changed

Lines changed: 59 additions & 14 deletions

File tree

docs/v2/index.html

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1005,9 +1005,19 @@ <h2>
10051005
<div class="article">
10061006
<h2>
10071007
<a id="service-plans" class="anchor" href="#service-plans">&#128279;</a>
1008-
Service Plans
1008+
Service Plans - Deprecated
10091009
</h2>
10101010

1011+
<div class="panel panel-warning">
1012+
<div class="panel-heading" style="background-color:#f0b37e;">
1013+
<h3 class="panel-title" style="color:white;">Warning:</h3>
1014+
</div>
1015+
<div class="panel-body" style="background-color:#ffedcc;">
1016+
The V2 Service Plans resource is deprecated, please refer to the Service Plans section of the
1017+
<a href="http://v3-apidocs.cloudfoundry.org#service-plans" class="alert-link">V3 Docs</a>
1018+
</div>
1019+
</div>
1020+
10111021
<ul>
10121022
<li>
10131023
<a href="service_plans/delete_a_particular_service_plans.html">Delete a Particular Service Plans</a>

docs/v3/source/includes/experimental_resources/service_plans/_delete.md.erb renamed to docs/v3/source/includes/resources/service_plans/_delete.md.erb

File renamed without changes.

docs/v3/source/includes/experimental_resources/service_plans/_get.md.erb renamed to docs/v3/source/includes/resources/service_plans/_get.md.erb

File renamed without changes.

docs/v3/source/includes/experimental_resources/service_plans/_header.md renamed to docs/v3/source/includes/resources/service_plans/_header.md

File renamed without changes.

docs/v3/source/includes/experimental_resources/service_plans/_list.md.erb renamed to docs/v3/source/includes/resources/service_plans/_list.md.erb

File renamed without changes.

docs/v3/source/includes/experimental_resources/service_plans/_object.md.erb renamed to docs/v3/source/includes/resources/service_plans/_object.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Name | Type | Description
1818
**costs** | _array of [cost objects](#the-service-plan-cost)_ | The cost of the Service Plan as obtained from the Service Broker Catalog.
1919
**created_at** | _datetime_ | The time with zone when the object was created.
2020
**updated_at** | _datetime_ | The time with zone when the object was last updated.
21-
**maintenance_info** | _[maintenance_info object](#the-maintenance-info-object-for-service-plans)_ | Information about the version of this service instance.
21+
**maintenance_info** | _[maintenance_info object](#the-maintenance-info-object-for-service-plans)_ | Information about the version of this service plan.
2222
**broker_catalog** | _[broker catalog object](#the-service-plan-broker-catalog)_ | This object contains information obtained from the Service Broker Catalog.
2323
**schemas** | _[schemas object](#the-service-plan-schemas)_ | Schema definitions for Service Instances and Service Bindings for the Service Plan.
2424
**relationships.service_offering** | [_to-one relationship_](#to-one-relationships) | The Service Offering that this Service Plan relates to.

docs/v3/source/includes/experimental_resources/service_plans/_update.md.erb renamed to docs/v3/source/includes/resources/service_plans/_update.md.erb

File renamed without changes.

docs/v3/source/includes/upgrade_guide/upgrade_guide.md

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,15 @@ In V2, the endpoint to apply a security group to a space only includes the lifec
438438

439439
In V3, the endpoint to apply a security group to a space includes the lifecycle. For example to unbind a security group from the running lifecycle, one would `DELETE /v3/security_groups/:guid/relationships/running_spaces/:space_guid`.
440440

441+
### Service Brokers in V3
442+
443+
#### Create, Update and Delete
444+
445+
446+
In V3 these endpoints are now asynchronous. See [Asynchronous operations](#asynchronous-operations) and [Service Broker Jobs](#service-broker-jobs) for more information.
447+
448+
Read more about the [service broker resource](#service-brokers).
449+
441450
### Service Offerings in V3
442451

443452
Services endpoints are now replaced by [Service Offerings endpoints](#service-offerings) at `/v3/service_offerings`
@@ -451,32 +460,58 @@ Some services related endpoints nested in other resources have been translated t
451460
`GET /v2/services/:guid/service_plans` is now a filter on the `Service Plan` resource: `GET /v3/service_plans?service_offering_guids=guid`. This link can also be found in the object's `links` section.
452461

453462

454-
In V2, `service_broker_name and service_broker_guid` where top level attributes in the response. V3 returns this values only if requested using the [`fields` syntax](#fields). Refer to [Service Offerings endpoints](#service-offerings) for further information. A link to the `Service Broker` resource is included in the object's `relationships` section.
463+
In V2, `service_broker_name` was returned in the response. V3 returns this value only if requested using the [`fields` syntax](#fields). Refer to [Service Offerings endpoints](#service-offerings) for further information. A link to the `Service Broker` resource is included in the object's `links` section.
455464

456465
The structure of the Service Offering object as well as some attribute names have changed from V2 to V3:
457466

458467
|**V2**|**V3**|
459468
|---|---|
460469
label | name
461470
active | available
462-
bindable | services.total_service_keys
471+
bindable | broker_catalog.features.bindable
463472
extra | shareable, broker_catalog.metadata
464473
unique_id | broker_catalog.id
465474
plan_updateable | broker_catalog.features.plan_updateable
466475
instances_retrievable | broker_catalog.features.instances_retrievable
467476
bindings_retrievable | broker_catalog.features.bindings_retrievable
477+
service_broker_guid | relationships.service_broker.data.guid
468478

469479

470480
Read more about the [service offering resource](#service-offerings).
471481

472-
### Service Brokers in V3
482+
### Service Plans in V3
473483

474-
#### Create, Update and Delete
484+
Some service plans related endpoints nested in other resources have been translated to filters on `service_plans`, with the advantage that filters accept multiple values and can be combined.
475485

486+
`GET /v2/services/:guid/service_plans` -> `GET /v3/service_plans?service_offering_guids=guid`
476487

477-
In V3 these endpoints are now asynchronous. See [Asynchronous operations](#asynchronous-operations) and [Service Broker Jobs](#service-broker-jobs) for more information.
488+
Changing plan visibility to `Public` is not a PUT operation anymore. To change visibility use the [Service Plan Visibility resource](#service-plan-visibility)
489+
490+
The structure of the Service Plan object as well as some attribute names have changed from V2 to V3:
491+
492+
|**V2**|**V3**|
493+
|---|---|
494+
active | available
495+
bindable | broker_catalog.features.bindable
496+
extra | broker_catalog.metadata
497+
public | `visibility_type == 'public'` (see [Visibility types](#list-of-visibility-types))
498+
unique_id | broker_catalog.id
499+
plan_updateable | broker_catalog.features.plan_updateable
500+
service_instances_url | use `service_plan_guids` or `service_plan_names` filter on [Service Instances resource](#service-instances)
501+
service_url | links.service_offering.href
502+
service_guid | relationships.service_offering.data.guid
503+
504+
Some filters were renamed and changed to accept a list of values:
505+
506+
|**V2**|**V3**|
507+
|---|---|
508+
service_guid | service_offering_guids
509+
service_instance_guid | service_instance_guids
510+
service_broker_guid | service_broker_guids
511+
unique_id | broker_catalog_ids
512+
513+
Read more about the [service plan resource](#service-plans).
478514

479-
Read more about the [service broker resource](#service-brokers).
480515

481516
### Space Quotas in V3
482517

docs/v3/source/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,12 @@ includes:
253253
- resources/service_offerings/list
254254
- resources/service_offerings/update
255255
- resources/service_offerings/delete
256+
- resources/service_plans/header
257+
- resources/service_plans/object
258+
- resources/service_plans/get
259+
- resources/service_plans/list
260+
- resources/service_plans/update
261+
- resources/service_plans/delete
256262
- resources/spaces/header
257263
- resources/spaces/object
258264
- resources/spaces/create
@@ -321,12 +327,6 @@ includes:
321327
- experimental_resources/service_bindings/get
322328
- experimental_resources/service_bindings/list
323329
- experimental_resources/service_bindings/delete
324-
- experimental_resources/service_plans/header
325-
- experimental_resources/service_plans/object
326-
- experimental_resources/service_plans/get
327-
- experimental_resources/service_plans/list
328-
- experimental_resources/service_plans/update
329-
- experimental_resources/service_plans/delete
330330
- experimental_resources/service_plan_visibility/header
331331
- experimental_resources/service_plan_visibility/object
332332
- experimental_resources/service_plan_visibility/visibility_types

0 commit comments

Comments
 (0)