app.bulleted.getOutline
Schema Diff
+15 -2
Compatibility Analysis
Backward Compatible
Backward compatible. 4 non-breaking changes.
Non-Breaking Changes (4)
- AddedVertex AddedVertex { vertex_id: "app.bulleted.getOutline#node.embed" }
- AddedVertex AddedVertex { vertex_id: "app.bulleted.getOutline#node.embedState" }
- AddedEdge AddedEdge { src: "app.bulleted.getOutline#node", tgt: "app.bulleted.getOutline#node.embed", kind: "prop", name: Some("embed") }
- AddedEdge AddedEdge { src: "app.bulleted.getOutline#node", tgt: "app.bulleted.getOutline#node.embedState", kind: "prop", name: Some("embedState") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "app.bulleted.getOutline#node.embed" }AddedVertex { vertex_id: "app.bulleted.getOutline#node.embedState" }
Additional Notes
- Non-breaking: AddedEdge { src: "app.bulleted.getOutline#node", tgt: "app.bulleted.getOutline#node.embed", kind: "prop", name: Some("embed") }
- Non-breaking: AddedEdge { src: "app.bulleted.getOutline#node", tgt: "app.bulleted.getOutline#node.embedState", kind: "prop", name: Some("embedState") }
1
1
{
2
2
"id": "app.bulleted.getOutline",
3
3
"defs": {
4
4
"main": {
5
5
"type": "query",
6
6
"errors": [
7
7
{
8
8
"name": "NotFound",
9
9
"description": "No such identity in this appview, or no such bullet in it. Also the answer for a record this appview has been asked to withhold: a status meaning 'this exists but is denied' is a way to enumerate the denylist."
10
10
}
11
11
],
12
12
"output": {
13
13
"schema": {
14
14
"type": "object",
15
15
"required": [
16
16
"did",
17
17
"nodes",
18
18
"truncated"
19
19
],
20
20
"properties": {
21
21
"did": {
22
22
"type": "string",
23
23
"format": "did",
24
24
"description": "The identity this outline belongs to, echoed back."
25
25
},
26
26
"root": {
27
27
"ref": "#node",
28
28
"type": "ref",
29
29
"description": "The zoomed bullet itself, so a caller can title the level without a second request. Absent when the whole outline was asked for."
30
30
},
31
31
"stop": {
32
32
"type": "string",
33
33
"description": "Which bound ended the walk. Present alongside truncated on purpose: one boolean is what most callers want, and a caller deciding whether to ask again with a larger depth needs to know which limit it hit.",
34
34
"knownValues": [
35
35
"complete",
36
36
"depth",
37
37
"limit"
38
38
]
39
39
},
40
40
"nodes": {
41
41
"type": "array",
42
42
"items": {
43
43
"ref": "#node",
44
44
"type": "ref"
45
45
},
46
46
"description": "Pre-order, siblings in sortKey order. Flat, not nested: parentage is in each node's parent field, exactly as it is in the records themselves."
47
47
},
48
48
"handle": {
49
49
"type": "string",
50
50
"format": "handle",
51
51
"description": "The handle this appview last observed for did. Absent when none has been observed. Never resolved on demand, so it may lag the network and must not be treated as authoritative."
52
52
},
53
53
"outline": {
54
54
"ref": "#outline",
55
55
"type": "ref",
56
56
"description": "The app.bulleted.outline record in effect at this level. It may have been written at an ancestor rather than here; uri says which, and there is deliberately no separate inherited flag because the URI already answers it."
57
57
},
58
58
"truncated": {
59
59
"type": "boolean",
60
60
"description": "Whether anything was left out. True whenever stop is not 'complete'."
61
61
}
62
62
}
63
63
},
64
64
"encoding": "application/json"
65
65
},
66
66
"parameters": {
67
67
"type": "params",
68
68
"required": [
69
69
"did"
70
70
],
71
71
"properties": {
72
72
"did": {
73
73
"type": "string",
74
74
"format": "did",
75
75
"description": "The identity whose outline to read. A DID and never a handle: a handle is a lease on a name, and resolving one here would make this endpoint an open resolver somebody else pays for."
76
76
},
77
77
"node": {
78
78
"type": "string",
79
79
"description": "Record key of the bullet to zoom into. Absent means the whole outline. The record key rather than an AT-URI, matching /public/{did}/{rkey}: the identity is already named by did, and two fields that can disagree about it is a bug waiting to be written."
80
80
},
81
81
"depth": {
82
82
"type": "integer",
83
83
"default": 3,
84
84
"maximum": 5,
85
85
"minimum": 1,
86
86
"description": "Levels below the root to return; 1 is the root's children only. Clamped rather than rejected, so a value outside the range is answered with the nearest one in range."
87
87
},
88
88
"limit": {
89
89
"type": "integer",
90
90
"default": 10,
91
91
"maximum": 100,
92
92
"minimum": 1,
93
93
"description": "Ceiling on nodes returned across ALL levels, not per level. Clamped rather than rejected. A per-level reading would make depth 5 with limit 100 a five-hundred-node answer to a request that said one hundred."
94
94
}
95
95
}
96
96
},
97
97
"description": "The public outline for an identity, optionally zoomed to one bullet. Answers from this appview's index of public records; it does not read the identity's PDS. No authentication, because everything here is already public."
98
98
},
99
99
"node": {
100
100
"type": "object",
101
101
"required": [
102
102
"uri",
103
103
"cid",
104
104
"rkey",
105
105
"did",
106
106
"sortKey",
107
107
"text"
108
108
],
109
109
"properties": {
110
110
"cid": {
111
111
"type": "string",
112
112
"format": "cid",
113
113
"description": "The record CID as this appview last indexed it."
114
114
},
115
115
"did": {
116
116
"type": "string",
117
117
"format": "did",
118
118
"description": "The repository this record lives in. Usually the identity the request named, and NOT always: an outline whose app.bulleted.outline admits contributors answers with their records too, rendered in place among the author's own. Read this rather than parsing the authority out of uri."
119
119
},
120
120
"uri": {
121
121
"type": "string",
122
122
"format": "at-uri",
123
123
"description": "The record's own AT-URI."
124
124
},
125
125
"note": {
126
126
"type": "string",
127
127
"description": "The body of this bullet's app.bulleted.note, if it has one. Co-keyed with the bullet by the parallel-key rule, so it needs no URI of its own here."
128
128
},
129
129
"rkey": {
130
130
"type": "string",
131
131
"description": "The record key."
132
132
},
133
133
"text": {
134
134
"type": "string",
135
135
"description": "The bullet's text, unrendered."
136
136
},
137
+
"embed": {
138
+
"type": "unknown",
139
+
"description": "This bullet's embed, exactly as its app.bulleted.node record carries it — an open union of app.bsky.embed.external and app.bsky.embed.record. The record's own claim, not this service's rendered card: a caller asking for an outline wants what is in the repository, and a view shape published here would need its own union and its own versioning. Absent on a mirror, whose content belongs to the record it points at."
140
+
},
137
141
"facets": {
138
142
"type": "array",
139
143
"items": {
140
144
"ref": "app.bsky.richtext.facet",
141
145
"type": "ref"
142
146
},
143
147
"description": "Rich text annotations over text, as stored. Byte ranges, so they index text as UTF-8."
144
148
},
145
149
"layout": {
146
150
"type": "string",
147
151
"description": "How the bullet renders, verbatim as stored. An open set: a value written by a later version arrives unchanged rather than folded onto bullet.",
148
152
"knownValues": [
149
153
"bullet",
150
154
"todo",
151
155
"h1",
152
156
"h2",
153
157
"h3",
154
158
"codeBlock",
155
159
"quoteBlock"
156
160
]
157
161
},
158
162
"mirror": {
159
163
"ref": "#mirror",
160
164
"type": "ref"
161
165
},
162
166
"parent": {
163
167
"type": "string",
164
168
"format": "at-uri",
165
169
"description": "The bullet this one hangs under. Absent means top level of the identity's outline, which is not the same as top level of this response — a zoomed answer's rows all carry a parent."
166
170
},
167
171
"display": {
168
172
"type": "string",
169
173
"description": "Whether this row's children are shown when a reader has no preference of their own, verbatim as stored. Absent means expanded, as does any unrecognized value. Absent on a mirror, which renders another repository's subtree and has no hint of its own.",
170
174
"knownValues": [
171
175
"expanded",
172
176
"collapsed"
173
177
]
174
178
},
175
179
"sortKey": {
176
180
"type": "string",
177
181
"description": "Fractional index ordering this row among its siblings."
178
182
},
179
183
"createdAt": {
180
184
"type": "string",
181
185
"format": "datetime"
182
186
},
183
187
"childCount": {
184
188
"type": "integer",
185
189
"description": "How many children this bullet has, whether or not they are in this response. Without it a leaf and a bullet cut off by depth or limit are the same absence."
186
190
},
191
+
"embedState": {
192
+
"type": "string",
193
+
"description": "Whether this service has resolved what a record embed points at. Absent for an external card, which needs no resolution because it is itself the snapshot the writer stored. 'pending' means nobody has looked yet; 'missing' means the record is gone from its repository; 'refused' means its host would not serve it. Not derivable from the embed, which is why it is answered alongside it.",
194
+
"knownValues": [
195
+
"ok",
196
+
"pending",
197
+
"missing",
198
+
"refused"
199
+
]
200
+
},
187
201
"completedAt": {
188
202
"type": "string",
189
203
"format": "datetime",
190
204
"description": "Presence means completed; there is no separate boolean anywhere in this system."
191
205
}
192
206
},
193
207
"description": "One row of an outline: an app.bulleted.node, or an app.bulleted.mirror standing in a sibling group beside them."
194
208
},
195
209
"mirror": {
196
210
"type": "object",
197
211
"required": [
198
212
"original"
199
213
],
200
214
"properties": {
201
215
"original": {
202
216
"type": "string",
203
217
"format": "at-uri",
204
218
"description": "The app.bulleted.node this mirror renders."
205
219
}
206
220
},
207
221
"description": "Present when this row is an app.bulleted.mirror rather than a node. The row's uri addresses the mirror record in this identity's repository; original names the bullet it points at, which lives in another repository and is NOT expanded here. Ask for that identity's outline to read it."
208
222
},
209
223
"outline": {
210
224
"type": "object",
211
225
"required": [
212
226
"uri"
213
227
],
214
228
"properties": {
215
229
"uri": {
216
230
"type": "string",
217
231
"format": "at-uri",
218
232
"description": "The outline record this came from. Compare its rkey against the level to tell an inherited title from one written here."
219
233
},
220
234
"image": {
221
235
"type": "string",
222
236
"format": "uri",
223
237
"description": "Absolute URL of the preview image, served through this appview's blob proxy rather than as a raw blob reference, because a caller cannot fetch a blob without also knowing the PDS."
224
238
},
225
239
"title": {
226
240
"type": "string"
227
241
},
228
242
"imageAlt": {
229
243
"type": "string"
230
244
},
231
245
"description": {
232
246
"type": "string"
233
247
}
234
248
},
235
249
"description": "An app.bulleted.outline record, as it applies to the level that was asked for."
236
250
}
237
251
},
238
252
"$type": "com.atproto.lexicon.schema",
239
-
"lexicon": 1,
240
-
"revision": 1
253
+
"lexicon": 1
241
254
}