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
Copy file name to clipboardExpand all lines: src/pages/docs/liveobjects/rest-api-usage.mdx
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ The key in the `data` object indicates the type of the value:
39
39
`bytes` values use base64 string encoding in JSON request and response bodies.
40
40
</Aside>
41
41
42
-
## Fetch the channel object <aid="fetching-objects"/>
42
+
## Fetch the channel object <aid="fetch-object"/>
43
43
44
44
### Get the entire object <aid="fetching-object-get"/>
45
45
@@ -68,7 +68,7 @@ This endpoint by default returns the compact representation of the object tree.
68
68
```
69
69
</Code>
70
70
71
-
#### Get the entire object with metatdata <aid="fetching-object-get-full-object"/>
71
+
#### Get the entire object with metatdata <aid="fetching-object"/>
72
72
73
73
By providing the `compact=false` query param the response will contain the full object representation including the
74
74
objectIds.
@@ -140,7 +140,7 @@ objectIds.
140
140
141
141
Both these requests are billed per object returned.
142
142
143
-
#### Get a subset of the object <aid="fetching-object-get-with-path"/>
143
+
#### Get a subset of the object <aid="fetch-object-with-path"/>
144
144
145
145
You can return a subset of the object tree by specifying the `path` query param. For example, to return just the `poll``LiveMap` instance from the root object:
146
146
@@ -166,8 +166,7 @@ You can return a subset of the object tree by specifying the `path` query param.
166
166
167
167
Note you will be only billed for the objects contained within the path.
168
168
169
-
170
-
### Get a single object by id <aid="fetching-objects-get-single"/>
169
+
### Get an object by id <aid="fetch-object-get-by-id"/>
Copy file name to clipboardExpand all lines: static/open-specs/liveobjects.yaml
+12-17Lines changed: 12 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ paths:
20
20
description: |
21
21
Publish operations to create or update objects on the channel.<br><br>
22
22
23
-
For more information, see the usage documentation for [publishing operations](/docs/liveobjects/rest-api-usage#updating-objects).
23
+
For more information, see the usage documentation for [publishing operations](/docs/liveobjects/rest-api-usage#publishing-operations).
24
24
parameters:
25
25
- name: channelId
26
26
in: path
@@ -238,7 +238,7 @@ paths:
238
238
If the path param is not provided then the root object is returned. If the compact param is not provided
239
239
then the response defaults to the compact format.<br><br>
240
240
241
-
For more information, see the usage documentation for [get object](/docs/liveobjects/rest-api-usage#fetching-objects-get).
241
+
For more information, see the usage documentation for [get object](/docs/liveobjects/rest-api-usage#fetch-object).
242
242
243
243
parameters:
244
244
- name: channelId
@@ -465,7 +465,7 @@ paths:
465
465
If the compact param is not provided then the response defaults to the compact format. The path query
466
466
param can be used to request a value from the provided object ID's children.
467
467
468
-
For more information, see the usage documentation for [get object](/docs/liveobjects/rest-api-usage#fetching-objects-get).
468
+
For more information, see the usage documentation for [get object by ID](/docs/liveobjects/rest-api-usage#fetch-object-get-by-id).
469
469
parameters:
470
470
- name: channelName
471
471
in: path
@@ -698,7 +698,7 @@ paths:
698
698
699
699
DEPRECATED: please use `POST /channels/{channelName}/object` instead.<br><br>
700
700
701
-
For more information, see the usage documentation for [publishing operations](/docs/liveobjects/rest-api-usage#updating-objects).
701
+
For more information, see the usage documentation for [publishing operations](/docs/liveobjects/rest-api-usage#publishing-operations).
702
702
parameters:
703
703
- name: channelName
704
704
in: path
@@ -916,8 +916,6 @@ paths:
916
916
Fetch a flat list of objects on the channel.<br><br>
917
917
918
918
DEPRECATED: please use `GET /channels/{channelName}/object` instead.<br><br>
919
-
920
-
For more information, see the usage documentation for [list objects](/docs/liveobjects/rest-api-usage#fetching-objects).
921
919
parameters:
922
920
- name: channelName
923
921
in: path
@@ -929,27 +927,27 @@ paths:
929
927
- name: values
930
928
in: query
931
929
required: false
932
-
description: If `true`, includes the values of objects in the response. See [including values](/docs/liveobjects/rest-api-usage#fetching-objects-list-values).
930
+
description: If `true`, includes the values of objects in the response.
933
931
schema:
934
932
type: boolean
935
933
default: false
936
934
- name: metadata
937
935
in: query
938
936
required: false
939
-
description: If `true`, includes additional object [metadata](/docs/liveobjects/concepts/objects#metadata) in the response. See [including metadata](/docs/liveobjects/rest-api-usage#fetching-objects-list-metadata).
937
+
description: If `true`, includes additional object [metadata](/docs/liveobjects/concepts/objects#metadata) in the response.
940
938
schema:
941
939
type: boolean
942
940
default: false
943
941
- name: limit
944
942
in: query
945
943
required: false
946
-
description: Specifies the maximum number of objects to include in the response. See [pagination](/docs/liveobjects/rest-api-usage#fetching-objects-list-pagination).
944
+
description: Specifies the maximum number of objects to include in the response.
947
945
schema:
948
946
type: integer
949
947
- name: cursor
950
948
in: query
951
949
required: false
952
-
description: The object ID to use as a cursor for pagination. See [pagination](/docs/liveobjects/rest-api-usage#fetching-objects-list-pagination).
950
+
description: The object ID to use as a cursor for pagination.
953
951
schema:
954
952
$ref: '#/components/schemas/ObjectIdString'
955
953
responses:
@@ -1160,8 +1158,6 @@ paths:
1160
1158
Fetch an object by ID, optionally including its children.<br><br>
1161
1159
DEPRECATED: please use GET /channels/{channelName}/object?compact=false or
For more information, see the usage documentation for [get objects](/docs/liveobjects/rest-api-usage#fetching-objects-get).
1165
1161
parameters:
1166
1162
- name: channelName
1167
1163
in: path
@@ -1180,15 +1176,15 @@ paths:
1180
1176
in: query
1181
1177
required: false
1182
1178
description: |
1183
-
Fetch the objects on the channel in a tree structure starting from the specified [object ID](/docs/liveobjects/concepts/objects#object-ids).
1184
-
Nested child objects are resolved and their values are included in the response. See [Get an object and its children](/docs/liveobjects/rest-api-usage#fetching-objects-get-children).
1179
+
Fetch the objects on the channel in a tree structure starting from the specified [object ID](/docs/liveobjects/concepts/objects#fetch-object-by-id).
1180
+
Nested child objects are resolved and their values are included in the response.
1185
1181
schema:
1186
1182
type: boolean
1187
1183
default: false
1188
1184
- name: metadata
1189
1185
in: query
1190
1186
required: false
1191
-
description: If `true`, includes additional object [metadata](/docs/liveobjects/concepts/objects#metadata) in the response. See [including metadata](/docs/liveobjects/rest-api-usage#fetching-objects-get-metadata).
1187
+
description: If `true`, includes additional object.
1192
1188
schema:
1193
1189
type: boolean
1194
1190
default: false
@@ -1374,7 +1370,6 @@ paths:
1374
1370
description: |
1375
1371
Fetch the objects on the channel in a tree structure in a concise format.<br><br>
1376
1372
DEPRECATED: please use GET /channels/{channelName}/object or /channels/{channelName}/object/{objectId} instead.<br><br>
1377
-
For more information, see the usage documentation for [get a compact view of objects](/docs/liveobjects/rest-api-usage#fetching-objects-compact).
1378
1373
parameters:
1379
1374
- name: channelName
1380
1375
in: path
@@ -1801,7 +1796,7 @@ components:
1801
1796
$ref: '#/components/schemas/ObjectIdString'
1802
1797
path:
1803
1798
type: string
1804
-
description: The [path](/docs/liveobjects/rest-api-usage#updating-objects-by-path) from the root to the object.
1799
+
description: The [path](/docs/liveobjects/rest-api-usage#fetch-object-with-path) from the root to the object.
0 commit comments