You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 3, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+35-5Lines changed: 35 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,10 +59,12 @@ In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests mus
59
59
60
60
### Summary and detailed representations
61
61
62
-
When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource.
62
+
When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource, such as a single feature flag, you receive a _detailed representation_ of the resource.
63
63
64
64
The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation.
65
65
66
+
In most cases, the detailed representation contains all of the attributes of the resource. In a few cases, the detailed representation contains many, but not all, of the attributes of the resource. Typically this happens when an attribute of the requested resource is itself paginated. You can request that the response include a particular attribute by using the `expand` request parameter.
67
+
66
68
### Links and addressability
67
69
68
70
The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links:
@@ -97,6 +99,12 @@ Collections are always represented as a JSON object with an `items` attribute co
97
99
98
100
Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection.
99
101
102
+
### Expanding responses
103
+
104
+
Sometimes the detailed representation of a resource does not include all of the attributes of the resource by default. If this is the case, the request method will clearly document this and describe which attributes you can include in an expanded response.
105
+
106
+
To include the additional attributes, append the `expand` request parameter to your request and add a comma-separated list of the attributes to include. For example, when you append `?expand=members,roles` to the [Get team](/tag/Teams-(beta)#operation/getTeam) endpoint, the expanded response includes both of these attributes.
107
+
100
108
## Updates
101
109
102
110
Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations.
@@ -394,7 +402,7 @@ We mark beta resources with a \"Beta\" callout in our documentation, pictured be
394
402
395
403
> ### This feature is in beta
396
404
>
397
-
> To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources).
405
+
> To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Overview/Beta-resources).
0 commit comments