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

Commit 9fe5152

Browse files
Add service offerings to the upgrade guide
[#172351415](https://www.pivotaltracker.com/story/show/172351415)
1 parent c4a896c commit 9fe5152

2 files changed

Lines changed: 45 additions & 2 deletions

File tree

docs/v3/source/includes/concepts/_fields.md.erb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ or `/v3/service_instances?fields[space.organization]=name` where `organization`
2222
- `keys` is a comma-separated list of the fields in the object being requested. For example,
2323
`/v3/service_instances?fields[space]=name,guid` will return just the `name` and `guid` of the space in the includes section.
2424

25+
For information on `fields` support for each resource refer to its documentation.
26+
2527
### Fields Sample requests
2628

2729

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

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,16 @@ For example, to include an app's space in the response:
165165
cf curl /v3/apps/:guid?include=space
166166
```
167167

168-
Read more about [the `include` parameter](#include).
168+
In addition, some resources provide the possibility of including specified fields of a related resource.
169+
170+
For example, to include the service broker name and guid in the service offering's response:
171+
172+
```
173+
cf curl /v3/service_offerings/:guid?fields[service_broker]=name,guid
174+
```
175+
176+
Read more about [the `include` parameter](#include) and [the `fields` parameter](#fields).
177+
169178

170179
## New Concepts
171180

@@ -366,8 +375,9 @@ This table shows how V2 resources map to their respective V3 counterparts. Note
366375
|Resource Matches|Resource Matches|
367376
|Routes, Route Mappings|Routes|[Routes in V3](#routes-in-v3)|
368377
|Security Groups|Security Groups|[Security Groups in V3](#security-groups-in-v3)|
378+
|Services|Service Offerings|[Service Offerings in V3](#service-offerings-in-v3)
369379
|Service Bindings, Service Keys|Service Keys|
370-
|Service Brokers|Service Brokers|
380+
|Service Brokers|Service Brokers|[Service Brokers in V3](#service-brokers-in-v3)
371381
|Service Instances, User-Provided Service Instances|Service Instances|
372382
|Spaces|Spaces|
373383
|Space Quota Definitions|Space Quotas|[Space Quotas in V3](#space-quotas-in-v3)
@@ -428,13 +438,44 @@ In V2, the endpoint to apply a security group to a space only includes the lifec
428438

429439
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`.
430440

441+
### Service Offerings in V3
442+
443+
Services endpoints are now replaced by [Service Offerings endpoints](#service-offerings) at `/v3/service_offerings`
444+
445+
Some services related endpoints nested in other resources have been translated to filters on `service_offerings`, with the advantage that filters accept multiple values and can be combined.
446+
447+
`GET /v2/organizations/:guid/services` is now `GET /v3/service_offerings?organization_ids=guid`.
448+
449+
`GET /v2/spaces/:guid/services` is now `GET /v3/service_offerings?space_ids=guid`
450+
451+
Service `label` attribute has been renamed to `name` and `names` is a valid filter key.
452+
453+
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.
454+
455+
The structure of the Service Offering object as well as some attribute names have changed from V2 to V3:
456+
457+
|**V2**|**V3**|
458+
|---|---|
459+
label | name
460+
active | available
461+
bindable | services.total_service_keys
462+
extra | shareable, broker_catalog.metadata
463+
unique_id | broker_catalog.id
464+
plan_updateable | broker_catalog.features.plan_updateable
465+
instances_retrievable | broker_catalog.features.instances_retrievable
466+
bindings_retrievable | broker_catalog.features.bindings_retrievable
467+
468+
469+
Read more about the [service offering resource](#service-offerings).
470+
431471
### Service Brokers in V3
432472

433473
#### Create, Update and Delete
434474

435475

436476
In V3 these endpoints are now asynchronous. See [Asynchronous operations](#asynchronous-operations) and [Service Broker Jobs](#service-broker-jobs) for more information.
437477

478+
Read more about the [service broker resource](#service-brokers).
438479

439480
### Space Quotas in V3
440481

0 commit comments

Comments
 (0)