app.bulleted.getOutline
Schema Diff
+16 -1
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 3 non-breaking changes.
Breaking Changes (1)
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "app.bulleted.getOutline#node", src: "app.bulleted.getOutline#node", tgt: "app.bulleted.getOutline#node.did", kind: "prop", name: Some("did") }
Non-Breaking Changes (3)
- AddedVertex AddedVertex { vertex_id: "app.bulleted.getOutline#node.did" }
- AddedVertex AddedVertex { vertex_id: "app.bulleted.getOutline#node.display" }
- AddedEdge AddedEdge { src: "app.bulleted.getOutline#node", tgt: "app.bulleted.getOutline#node.display", kind: "prop", name: Some("display") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "app.bulleted.getOutline#node.did" }AddedVertex { vertex_id: "app.bulleted.getOutline#node.display" }
Additional Notes
- Breaking: RequiredEdgeAdded { vertex_id: "app.bulleted.getOutline#node", src: "app.bulleted.getOutline#node", tgt: "app.bulleted.getOutline#node.did", kind: "prop", name: Some("did") }
- Non-breaking: AddedEdge { src: "app.bulleted.getOutline#node", tgt: "app.bulleted.getOutline#node.display", kind: "prop", name: Some("display") }
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
+
"did",
105
106
"sortKey",
106
107
"text"
107
108
],
108
109
"properties": {
109
110
"cid": {
110
111
"type": "string",
111
112
"format": "cid",
112
113
"description": "The record CID as this appview last indexed it."
113
114
},
115
+
"did": {
116
+
"type": "string",
117
+
"format": "did",
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
+
},
114
120
"uri": {
115
121
"type": "string",
116
122
"format": "at-uri",
117
123
"description": "The record's own AT-URI."
118
124
},
119
125
"note": {
120
126
"type": "string",
121
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."
122
128
},
123
129
"rkey": {
124
130
"type": "string",
125
131
"description": "The record key."
126
132
},
127
133
"text": {
128
134
"type": "string",
129
135
"description": "The bullet's text, unrendered."
130
136
},
131
137
"facets": {
132
138
"type": "array",
133
139
"items": {
134
140
"ref": "app.bsky.richtext.facet",
135
141
"type": "ref"
136
142
},
137
143
"description": "Rich text annotations over text, as stored. Byte ranges, so they index text as UTF-8."
138
144
},
139
145
"layout": {
140
146
"type": "string",
141
147
"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.",
142
148
"knownValues": [
143
149
"bullet",
144
150
"todo",
145
151
"h1",
146
152
"h2",
147
153
"h3",
148
154
"codeBlock",
149
155
"quoteBlock"
150
156
]
151
157
},
152
158
"mirror": {
153
159
"ref": "#mirror",
154
160
"type": "ref"
155
161
},
156
162
"parent": {
157
163
"type": "string",
158
164
"format": "at-uri",
159
165
"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."
160
166
},
167
+
"display": {
168
+
"type": "string",
169
+
"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
+
"knownValues": [
171
+
"expanded",
172
+
"collapsed"
173
+
]
174
+
},
161
175
"sortKey": {
162
176
"type": "string",
163
177
"description": "Fractional index ordering this row among its siblings."
164
178
},
165
179
"createdAt": {
166
180
"type": "string",
167
181
"format": "datetime"
168
182
},
169
183
"childCount": {
170
184
"type": "integer",
171
185
"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."
172
186
},
173
187
"completedAt": {
174
188
"type": "string",
175
189
"format": "datetime",
176
190
"description": "Presence means completed; there is no separate boolean anywhere in this system."
177
191
}
178
192
},
179
193
"description": "One row of an outline: an app.bulleted.node, or an app.bulleted.mirror standing in a sibling group beside them."
180
194
},
181
195
"mirror": {
182
196
"type": "object",
183
197
"required": [
184
198
"original"
185
199
],
186
200
"properties": {
187
201
"original": {
188
202
"type": "string",
189
203
"format": "at-uri",
190
204
"description": "The app.bulleted.node this mirror renders."
191
205
}
192
206
},
193
207
"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."
194
208
},
195
209
"outline": {
196
210
"type": "object",
197
211
"required": [
198
212
"uri"
199
213
],
200
214
"properties": {
201
215
"uri": {
202
216
"type": "string",
203
217
"format": "at-uri",
204
218
"description": "The outline record this came from. Compare its rkey against the level to tell an inherited title from one written here."
205
219
},
206
220
"image": {
207
221
"type": "string",
208
222
"format": "uri",
209
223
"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."
210
224
},
211
225
"title": {
212
226
"type": "string"
213
227
},
214
228
"imageAlt": {
215
229
"type": "string"
216
230
},
217
231
"description": {
218
232
"type": "string"
219
233
}
220
234
},
221
235
"description": "An app.bulleted.outline record, as it applies to the level that was asked for."
222
236
}
223
237
},
224
238
"$type": "com.atproto.lexicon.schema",
225
-
"lexicon": 1
239
+
"lexicon": 1,
240
+
"revision": 1
226
241
}