This repository was archived by the owner on Jun 2, 2021. It is now read-only.
File tree Expand file tree Collapse file tree
docs/v3/source/includes/upgrade_guide/conceptual_changes Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -14,6 +14,27 @@ about which information they really need and to fetch that information with
1414multiple API calls and/or by making use of the [ ` include `
1515parameter] ( #including-associated-resources ) on certain endpoints.
1616
17+ In V2, summary endpoints provided a way to fetch all resources associated with a
18+ parent resource. In V3, fetch the summary though the associated resource and
19+ filter by the parent resource. See below for examples of summaries in V3.
20+
21+ #### Replacing the space summary endpoint
22+
23+ - To fetch all apps in a space, use ` GET /v3/apps?space_guids=<space-guid> ` .
24+ Passing ` include=space ` will include the space resource in the response body.
25+ - To fetch all service instances in a space use `GET
26+ /v3/service_instances?space_guids=<space-guid >`. You may be able to pass the
27+ experimental ` fields ` parameter to include related information in the response
28+ body.
29+
30+ #### Replacing the user summary endpoint
31+
32+ - The user summary was useful for finding organizations and spaces where a user
33+ had roles. In V3, with the introduction of the role resource, you can use `GET
34+ /v3/roles?user_guids=<user-guid >` to list a user's roles. Passing
35+ ` include=space,organization ` will include the relevant spaces and organizations
36+ in the response body.
37+
1738#### Usage summary endpoints
1839
1940There are still a couple of endpoints in V3 that provide a basic summary of
You can’t perform that action at this time.
0 commit comments