Skip to content

Commit bcb0230

Browse files
committed
fixup! feat: update LiveObjects usage docs
1 parent 6276908 commit bcb0230

File tree

2 files changed

+16
-22
lines changed

2 files changed

+16
-22
lines changed

src/pages/docs/liveobjects/rest-api-usage.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The key in the `data` object indicates the type of the value:
3939
`bytes` values use base64 string encoding in JSON request and response bodies.
4040
</Aside>
4141

42-
## Fetch the channel object <a id="fetching-objects"/>
42+
## Fetch the channel object <a id="fetch-object"/>
4343

4444
### Get the entire object <a id="fetching-object-get"/>
4545

@@ -68,7 +68,7 @@ This endpoint by default returns the compact representation of the object tree.
6868
```
6969
</Code>
7070

71-
#### Get the entire object with metatdata <a id="fetching-object-get-full-object"/>
71+
#### Get the entire object with metatdata <a id="fetching-object"/>
7272

7373
By providing the `compact=false` query param the response will contain the full object representation including the
7474
objectIds.
@@ -140,7 +140,7 @@ objectIds.
140140

141141
Both these requests are billed per object returned.
142142

143-
#### Get a subset of the object <a id="fetching-object-get-with-path"/>
143+
#### Get a subset of the object <a id="fetch-object-with-path"/>
144144

145145
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:
146146

@@ -166,8 +166,7 @@ You can return a subset of the object tree by specifying the `path` query param.
166166

167167
Note you will be only billed for the objects contained within the path.
168168

169-
170-
### Get a single object by id <a id="fetching-objects-get-single"/>
169+
### Get an object by id <a id="fetch-object-get-by-id"/>
171170

172171
`GET main.realtime.ably.net/channels/<channelName>/object/<objectId>`
173172

static/open-specs/liveobjects.yaml

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ paths:
2020
description: |
2121
Publish operations to create or update objects on the channel.<br><br>
2222
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).
2424
parameters:
2525
- name: channelId
2626
in: path
@@ -238,7 +238,7 @@ paths:
238238
If the path param is not provided then the root object is returned. If the compact param is not provided
239239
then the response defaults to the compact format.<br><br>
240240
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).
242242
243243
parameters:
244244
- name: channelId
@@ -465,7 +465,7 @@ paths:
465465
If the compact param is not provided then the response defaults to the compact format. The path query
466466
param can be used to request a value from the provided object ID's children.
467467
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).
469469
parameters:
470470
- name: channelName
471471
in: path
@@ -698,7 +698,7 @@ paths:
698698
699699
DEPRECATED: please use `POST /channels/{channelName}/object` instead.<br><br>
700700
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).
702702
parameters:
703703
- name: channelName
704704
in: path
@@ -916,8 +916,6 @@ paths:
916916
Fetch a flat list of objects on the channel.<br><br>
917917
918918
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).
921919
parameters:
922920
- name: channelName
923921
in: path
@@ -929,27 +927,27 @@ paths:
929927
- name: values
930928
in: query
931929
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.
933931
schema:
934932
type: boolean
935933
default: false
936934
- name: metadata
937935
in: query
938936
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.
940938
schema:
941939
type: boolean
942940
default: false
943941
- name: limit
944942
in: query
945943
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.
947945
schema:
948946
type: integer
949947
- name: cursor
950948
in: query
951949
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.
953951
schema:
954952
$ref: '#/components/schemas/ObjectIdString'
955953
responses:
@@ -1160,8 +1158,6 @@ paths:
11601158
Fetch an object by ID, optionally including its children.<br><br>
11611159
DEPRECATED: please use GET /channels/{channelName}/object?compact=false or
11621160
/channels/{channelName}/object/{objectId}?compact=false instead.<br><br>
1163-
1164-
For more information, see the usage documentation for [get objects](/docs/liveobjects/rest-api-usage#fetching-objects-get).
11651161
parameters:
11661162
- name: channelName
11671163
in: path
@@ -1180,15 +1176,15 @@ paths:
11801176
in: query
11811177
required: false
11821178
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.
11851181
schema:
11861182
type: boolean
11871183
default: false
11881184
- name: metadata
11891185
in: query
11901186
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.
11921188
schema:
11931189
type: boolean
11941190
default: false
@@ -1374,7 +1370,6 @@ paths:
13741370
description: |
13751371
Fetch the objects on the channel in a tree structure in a concise format.<br><br>
13761372
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).
13781373
parameters:
13791374
- name: channelName
13801375
in: path
@@ -1801,7 +1796,7 @@ components:
18011796
$ref: '#/components/schemas/ObjectIdString'
18021797
path:
18031798
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.
18051800
example: "votes.up"
18061801

18071802
OperationMapSet:

0 commit comments

Comments
 (0)