@atproto/api 0.9.6 → 0.9.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/dist/client/lexicons.d.ts +153 -5
- package/dist/client/types/app/bsky/actor/defs.d.ts +1 -0
- package/dist/client/types/com/atproto/admin/defs.d.ts +9 -0
- package/dist/client/types/com/atproto/admin/emitModerationEvent.d.ts +1 -1
- package/dist/client/types/com/atproto/admin/queryModerationEvents.d.ts +2 -0
- package/dist/client/types/com/atproto/admin/queryModerationStatuses.d.ts +2 -0
- package/dist/index.js +335 -181
- package/dist/index.js.map +2 -2
- package/package.json +2 -2
- package/src/client/lexicons.ts +401 -123
- package/src/client/types/app/bsky/actor/defs.ts +2 -0
- package/src/client/types/app/bsky/actor/getProfile.ts +1 -0
- package/src/client/types/app/bsky/actor/profile.ts +3 -0
- package/src/client/types/app/bsky/embed/external.ts +1 -0
- package/src/client/types/app/bsky/embed/images.ts +4 -0
- package/src/client/types/app/bsky/embed/record.ts +1 -0
- package/src/client/types/app/bsky/feed/defs.ts +1 -0
- package/src/client/types/app/bsky/feed/getAuthorFeed.ts +1 -0
- package/src/client/types/app/bsky/feed/getFeedGenerator.ts +3 -0
- package/src/client/types/app/bsky/feed/getFeedSkeleton.ts +1 -0
- package/src/client/types/app/bsky/feed/getLikes.ts +2 -0
- package/src/client/types/app/bsky/feed/getListFeed.ts +1 -0
- package/src/client/types/app/bsky/feed/getPostThread.ts +3 -0
- package/src/client/types/app/bsky/feed/getPosts.ts +1 -0
- package/src/client/types/app/bsky/feed/getRepostedBy.ts +2 -0
- package/src/client/types/app/bsky/feed/getTimeline.ts +1 -0
- package/src/client/types/app/bsky/feed/post.ts +5 -1
- package/src/client/types/app/bsky/feed/threadgate.ts +1 -0
- package/src/client/types/app/bsky/graph/block.ts +1 -0
- package/src/client/types/app/bsky/graph/getList.ts +1 -0
- package/src/client/types/app/bsky/graph/getLists.ts +1 -0
- package/src/client/types/app/bsky/graph/getRelationships.ts +2 -0
- package/src/client/types/app/bsky/graph/list.ts +1 -0
- package/src/client/types/app/bsky/graph/listblock.ts +1 -0
- package/src/client/types/app/bsky/graph/listitem.ts +2 -0
- package/src/client/types/app/bsky/richtext/facet.ts +5 -4
- package/src/client/types/com/atproto/admin/defs.ts +24 -0
- package/src/client/types/com/atproto/admin/emitModerationEvent.ts +1 -0
- package/src/client/types/com/atproto/admin/queryModerationEvents.ts +4 -0
- package/src/client/types/com/atproto/admin/queryModerationStatuses.ts +2 -0
- package/src/client/types/com/atproto/identity/updateHandle.ts +1 -0
- package/src/client/types/com/atproto/moderation/createReport.ts +1 -0
- package/src/client/types/com/atproto/repo/applyWrites.ts +6 -5
- package/src/client/types/com/atproto/repo/createRecord.ts +4 -4
- package/src/client/types/com/atproto/repo/deleteRecord.ts +2 -2
- package/src/client/types/com/atproto/repo/describeRepo.ts +3 -0
- package/src/client/types/com/atproto/repo/getRecord.ts +1 -1
- package/src/client/types/com/atproto/repo/putRecord.ts +4 -4
- package/src/client/types/com/atproto/server/createAccount.ts +8 -0
- package/src/client/types/com/atproto/server/createAppPassword.ts +1 -0
- package/src/client/types/com/atproto/server/describeServer.ts +3 -0
- package/src/client/types/com/atproto/server/getAccountInviteCodes.ts +1 -0
- package/src/client/types/com/atproto/server/reserveSigningKey.ts +2 -2
- package/src/client/types/com/atproto/sync/getBlob.ts +1 -1
- package/src/client/types/com/atproto/sync/getRecord.ts +1 -0
- package/src/client/types/com/atproto/sync/getRepo.ts +1 -1
- package/src/client/types/com/atproto/sync/listRepos.ts +1 -0
- package/src/client/types/com/atproto/sync/notifyOfUpdate.ts +1 -1
- package/src/client/types/com/atproto/sync/requestCrawl.ts +1 -1
- package/src/client/types/com/atproto/sync/subscribeRepos.ts +16 -4
package/dist/index.js
CHANGED
|
@@ -15973,6 +15973,12 @@ var schemaDict = {
|
|
|
15973
15973
|
suspendUntil: {
|
|
15974
15974
|
type: "string",
|
|
15975
15975
|
format: "datetime"
|
|
15976
|
+
},
|
|
15977
|
+
tags: {
|
|
15978
|
+
type: "array",
|
|
15979
|
+
items: {
|
|
15980
|
+
type: "string"
|
|
15981
|
+
}
|
|
15976
15982
|
}
|
|
15977
15983
|
}
|
|
15978
15984
|
},
|
|
@@ -16564,6 +16570,31 @@ var schemaDict = {
|
|
|
16564
16570
|
}
|
|
16565
16571
|
}
|
|
16566
16572
|
},
|
|
16573
|
+
modEventTag: {
|
|
16574
|
+
type: "object",
|
|
16575
|
+
description: "Add/Remove a tag on a subject",
|
|
16576
|
+
required: ["add", "remove"],
|
|
16577
|
+
properties: {
|
|
16578
|
+
add: {
|
|
16579
|
+
type: "array",
|
|
16580
|
+
items: {
|
|
16581
|
+
type: "string"
|
|
16582
|
+
},
|
|
16583
|
+
description: "Tags to be added to the subject. If already exists, won't be duplicated."
|
|
16584
|
+
},
|
|
16585
|
+
remove: {
|
|
16586
|
+
type: "array",
|
|
16587
|
+
items: {
|
|
16588
|
+
type: "string"
|
|
16589
|
+
},
|
|
16590
|
+
description: "Tags to be removed to the subject. Ignores a tag If it doesn't exist, won't be duplicated."
|
|
16591
|
+
},
|
|
16592
|
+
comment: {
|
|
16593
|
+
type: "string",
|
|
16594
|
+
description: "Additional comment about added/removed tags."
|
|
16595
|
+
}
|
|
16596
|
+
}
|
|
16597
|
+
},
|
|
16567
16598
|
communicationTemplateView: {
|
|
16568
16599
|
type: "object",
|
|
16569
16600
|
required: [
|
|
@@ -16738,7 +16769,8 @@ var schemaDict = {
|
|
|
16738
16769
|
"lex:com.atproto.admin.defs#modEventMute",
|
|
16739
16770
|
"lex:com.atproto.admin.defs#modEventReverseTakedown",
|
|
16740
16771
|
"lex:com.atproto.admin.defs#modEventUnmute",
|
|
16741
|
-
"lex:com.atproto.admin.defs#modEventEmail"
|
|
16772
|
+
"lex:com.atproto.admin.defs#modEventEmail",
|
|
16773
|
+
"lex:com.atproto.admin.defs#modEventTag"
|
|
16742
16774
|
]
|
|
16743
16775
|
},
|
|
16744
16776
|
subject: {
|
|
@@ -17160,6 +17192,20 @@ var schemaDict = {
|
|
|
17160
17192
|
},
|
|
17161
17193
|
description: "If specified, only events where all of these labels were removed are returned"
|
|
17162
17194
|
},
|
|
17195
|
+
addedTags: {
|
|
17196
|
+
type: "array",
|
|
17197
|
+
items: {
|
|
17198
|
+
type: "string"
|
|
17199
|
+
},
|
|
17200
|
+
description: "If specified, only events where all of these tags were added are returned"
|
|
17201
|
+
},
|
|
17202
|
+
removedTags: {
|
|
17203
|
+
type: "array",
|
|
17204
|
+
items: {
|
|
17205
|
+
type: "string"
|
|
17206
|
+
},
|
|
17207
|
+
description: "If specified, only events where all of these tags were removed are returned"
|
|
17208
|
+
},
|
|
17163
17209
|
reportTypes: {
|
|
17164
17210
|
type: "array",
|
|
17165
17211
|
items: {
|
|
@@ -17275,6 +17321,18 @@ var schemaDict = {
|
|
|
17275
17321
|
maximum: 100,
|
|
17276
17322
|
default: 50
|
|
17277
17323
|
},
|
|
17324
|
+
tags: {
|
|
17325
|
+
type: "array",
|
|
17326
|
+
items: {
|
|
17327
|
+
type: "string"
|
|
17328
|
+
}
|
|
17329
|
+
},
|
|
17330
|
+
excludeTags: {
|
|
17331
|
+
type: "array",
|
|
17332
|
+
items: {
|
|
17333
|
+
type: "string"
|
|
17334
|
+
}
|
|
17335
|
+
},
|
|
17278
17336
|
cursor: {
|
|
17279
17337
|
type: "string"
|
|
17280
17338
|
}
|
|
@@ -17563,7 +17621,7 @@ var schemaDict = {
|
|
|
17563
17621
|
defs: {
|
|
17564
17622
|
main: {
|
|
17565
17623
|
type: "query",
|
|
17566
|
-
description: "
|
|
17624
|
+
description: "Resolves a handle (domain name) to a DID.",
|
|
17567
17625
|
parameters: {
|
|
17568
17626
|
type: "params",
|
|
17569
17627
|
required: ["handle"],
|
|
@@ -17597,7 +17655,7 @@ var schemaDict = {
|
|
|
17597
17655
|
defs: {
|
|
17598
17656
|
main: {
|
|
17599
17657
|
type: "procedure",
|
|
17600
|
-
description: "Updates the handle
|
|
17658
|
+
description: "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.",
|
|
17601
17659
|
input: {
|
|
17602
17660
|
encoding: "application/json",
|
|
17603
17661
|
schema: {
|
|
@@ -17606,7 +17664,8 @@ var schemaDict = {
|
|
|
17606
17664
|
properties: {
|
|
17607
17665
|
handle: {
|
|
17608
17666
|
type: "string",
|
|
17609
|
-
format: "handle"
|
|
17667
|
+
format: "handle",
|
|
17668
|
+
description: "The new handle."
|
|
17610
17669
|
}
|
|
17611
17670
|
}
|
|
17612
17671
|
}
|
|
@@ -17689,7 +17748,7 @@ var schemaDict = {
|
|
|
17689
17748
|
defs: {
|
|
17690
17749
|
main: {
|
|
17691
17750
|
type: "query",
|
|
17692
|
-
description: "Find labels relevant to the provided URI patterns.",
|
|
17751
|
+
description: "Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.",
|
|
17693
17752
|
parameters: {
|
|
17694
17753
|
type: "params",
|
|
17695
17754
|
required: ["uriPatterns"],
|
|
@@ -17748,13 +17807,13 @@ var schemaDict = {
|
|
|
17748
17807
|
defs: {
|
|
17749
17808
|
main: {
|
|
17750
17809
|
type: "subscription",
|
|
17751
|
-
description: "Subscribe to
|
|
17810
|
+
description: "Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.",
|
|
17752
17811
|
parameters: {
|
|
17753
17812
|
type: "params",
|
|
17754
17813
|
properties: {
|
|
17755
17814
|
cursor: {
|
|
17756
17815
|
type: "integer",
|
|
17757
|
-
description: "The last known event to backfill from."
|
|
17816
|
+
description: "The last known event seq number to backfill from."
|
|
17758
17817
|
}
|
|
17759
17818
|
}
|
|
17760
17819
|
},
|
|
@@ -17810,7 +17869,7 @@ var schemaDict = {
|
|
|
17810
17869
|
defs: {
|
|
17811
17870
|
main: {
|
|
17812
17871
|
type: "procedure",
|
|
17813
|
-
description: "
|
|
17872
|
+
description: "Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.",
|
|
17814
17873
|
input: {
|
|
17815
17874
|
encoding: "application/json",
|
|
17816
17875
|
schema: {
|
|
@@ -17819,10 +17878,12 @@ var schemaDict = {
|
|
|
17819
17878
|
properties: {
|
|
17820
17879
|
reasonType: {
|
|
17821
17880
|
type: "ref",
|
|
17881
|
+
description: "Indicates the broad category of violation the report is for.",
|
|
17822
17882
|
ref: "lex:com.atproto.moderation.defs#reasonType"
|
|
17823
17883
|
},
|
|
17824
17884
|
reason: {
|
|
17825
|
-
type: "string"
|
|
17885
|
+
type: "string",
|
|
17886
|
+
description: "Additional context about the content and violation."
|
|
17826
17887
|
},
|
|
17827
17888
|
subject: {
|
|
17828
17889
|
type: "union",
|
|
@@ -17931,7 +17992,7 @@ var schemaDict = {
|
|
|
17931
17992
|
defs: {
|
|
17932
17993
|
main: {
|
|
17933
17994
|
type: "procedure",
|
|
17934
|
-
description: "Apply a batch transaction of creates, updates, and deletes.",
|
|
17995
|
+
description: "Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.",
|
|
17935
17996
|
input: {
|
|
17936
17997
|
encoding: "application/json",
|
|
17937
17998
|
schema: {
|
|
@@ -17941,12 +18002,12 @@ var schemaDict = {
|
|
|
17941
18002
|
repo: {
|
|
17942
18003
|
type: "string",
|
|
17943
18004
|
format: "at-identifier",
|
|
17944
|
-
description: "The handle or DID of the repo."
|
|
18005
|
+
description: "The handle or DID of the repo (aka, current account)."
|
|
17945
18006
|
},
|
|
17946
18007
|
validate: {
|
|
17947
18008
|
type: "boolean",
|
|
17948
18009
|
default: true,
|
|
17949
|
-
description: "
|
|
18010
|
+
description: "Can be set to 'false' to skip Lexicon schema validation of record data, for all operations."
|
|
17950
18011
|
},
|
|
17951
18012
|
writes: {
|
|
17952
18013
|
type: "array",
|
|
@@ -17962,6 +18023,7 @@ var schemaDict = {
|
|
|
17962
18023
|
},
|
|
17963
18024
|
swapCommit: {
|
|
17964
18025
|
type: "string",
|
|
18026
|
+
description: "If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.",
|
|
17965
18027
|
format: "cid"
|
|
17966
18028
|
}
|
|
17967
18029
|
}
|
|
@@ -17969,13 +18031,14 @@ var schemaDict = {
|
|
|
17969
18031
|
},
|
|
17970
18032
|
errors: [
|
|
17971
18033
|
{
|
|
17972
|
-
name: "InvalidSwap"
|
|
18034
|
+
name: "InvalidSwap",
|
|
18035
|
+
description: "Indicates that the 'swapCommit' parameter did not match current commit."
|
|
17973
18036
|
}
|
|
17974
18037
|
]
|
|
17975
18038
|
},
|
|
17976
18039
|
create: {
|
|
17977
18040
|
type: "object",
|
|
17978
|
-
description: "
|
|
18041
|
+
description: "Operation which creates a new record.",
|
|
17979
18042
|
required: ["collection", "value"],
|
|
17980
18043
|
properties: {
|
|
17981
18044
|
collection: {
|
|
@@ -17993,7 +18056,7 @@ var schemaDict = {
|
|
|
17993
18056
|
},
|
|
17994
18057
|
update: {
|
|
17995
18058
|
type: "object",
|
|
17996
|
-
description: "
|
|
18059
|
+
description: "Operation which updates an existing record.",
|
|
17997
18060
|
required: ["collection", "rkey", "value"],
|
|
17998
18061
|
properties: {
|
|
17999
18062
|
collection: {
|
|
@@ -18010,7 +18073,7 @@ var schemaDict = {
|
|
|
18010
18073
|
},
|
|
18011
18074
|
delete: {
|
|
18012
18075
|
type: "object",
|
|
18013
|
-
description: "
|
|
18076
|
+
description: "Operation which deletes an existing record.",
|
|
18014
18077
|
required: ["collection", "rkey"],
|
|
18015
18078
|
properties: {
|
|
18016
18079
|
collection: {
|
|
@@ -18030,7 +18093,7 @@ var schemaDict = {
|
|
|
18030
18093
|
defs: {
|
|
18031
18094
|
main: {
|
|
18032
18095
|
type: "procedure",
|
|
18033
|
-
description: "Create a new record.",
|
|
18096
|
+
description: "Create a single new repository record. Requires auth, implemented by PDS.",
|
|
18034
18097
|
input: {
|
|
18035
18098
|
encoding: "application/json",
|
|
18036
18099
|
schema: {
|
|
@@ -18040,7 +18103,7 @@ var schemaDict = {
|
|
|
18040
18103
|
repo: {
|
|
18041
18104
|
type: "string",
|
|
18042
18105
|
format: "at-identifier",
|
|
18043
|
-
description: "The handle or DID of the repo."
|
|
18106
|
+
description: "The handle or DID of the repo (aka, current account)."
|
|
18044
18107
|
},
|
|
18045
18108
|
collection: {
|
|
18046
18109
|
type: "string",
|
|
@@ -18049,17 +18112,17 @@ var schemaDict = {
|
|
|
18049
18112
|
},
|
|
18050
18113
|
rkey: {
|
|
18051
18114
|
type: "string",
|
|
18052
|
-
description: "The
|
|
18115
|
+
description: "The Record Key.",
|
|
18053
18116
|
maxLength: 15
|
|
18054
18117
|
},
|
|
18055
18118
|
validate: {
|
|
18056
18119
|
type: "boolean",
|
|
18057
18120
|
default: true,
|
|
18058
|
-
description: "
|
|
18121
|
+
description: "Can be set to 'false' to skip Lexicon schema validation of record data."
|
|
18059
18122
|
},
|
|
18060
18123
|
record: {
|
|
18061
18124
|
type: "unknown",
|
|
18062
|
-
description: "The record
|
|
18125
|
+
description: "The record itself. Must contain a $type field."
|
|
18063
18126
|
},
|
|
18064
18127
|
swapCommit: {
|
|
18065
18128
|
type: "string",
|
|
@@ -18088,7 +18151,8 @@ var schemaDict = {
|
|
|
18088
18151
|
},
|
|
18089
18152
|
errors: [
|
|
18090
18153
|
{
|
|
18091
|
-
name: "InvalidSwap"
|
|
18154
|
+
name: "InvalidSwap",
|
|
18155
|
+
description: "Indicates that 'swapCommit' didn't match current repo commit."
|
|
18092
18156
|
}
|
|
18093
18157
|
]
|
|
18094
18158
|
}
|
|
@@ -18100,7 +18164,7 @@ var schemaDict = {
|
|
|
18100
18164
|
defs: {
|
|
18101
18165
|
main: {
|
|
18102
18166
|
type: "procedure",
|
|
18103
|
-
description: "Delete a record, or ensure it doesn't exist.",
|
|
18167
|
+
description: "Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
|
|
18104
18168
|
input: {
|
|
18105
18169
|
encoding: "application/json",
|
|
18106
18170
|
schema: {
|
|
@@ -18110,7 +18174,7 @@ var schemaDict = {
|
|
|
18110
18174
|
repo: {
|
|
18111
18175
|
type: "string",
|
|
18112
18176
|
format: "at-identifier",
|
|
18113
|
-
description: "The handle or DID of the repo."
|
|
18177
|
+
description: "The handle or DID of the repo (aka, current account)."
|
|
18114
18178
|
},
|
|
18115
18179
|
collection: {
|
|
18116
18180
|
type: "string",
|
|
@@ -18119,7 +18183,7 @@ var schemaDict = {
|
|
|
18119
18183
|
},
|
|
18120
18184
|
rkey: {
|
|
18121
18185
|
type: "string",
|
|
18122
|
-
description: "The
|
|
18186
|
+
description: "The Record Key."
|
|
18123
18187
|
},
|
|
18124
18188
|
swapRecord: {
|
|
18125
18189
|
type: "string",
|
|
@@ -18148,7 +18212,7 @@ var schemaDict = {
|
|
|
18148
18212
|
defs: {
|
|
18149
18213
|
main: {
|
|
18150
18214
|
type: "query",
|
|
18151
|
-
description: "Get information about
|
|
18215
|
+
description: "Get information about an account and repository, including the list of collections. Does not require auth.",
|
|
18152
18216
|
parameters: {
|
|
18153
18217
|
type: "params",
|
|
18154
18218
|
required: ["repo"],
|
|
@@ -18181,17 +18245,20 @@ var schemaDict = {
|
|
|
18181
18245
|
format: "did"
|
|
18182
18246
|
},
|
|
18183
18247
|
didDoc: {
|
|
18184
|
-
type: "unknown"
|
|
18248
|
+
type: "unknown",
|
|
18249
|
+
description: "The complete DID document for this account."
|
|
18185
18250
|
},
|
|
18186
18251
|
collections: {
|
|
18187
18252
|
type: "array",
|
|
18253
|
+
description: "List of all the collections (NSIDs) for which this repo contains at least one record.",
|
|
18188
18254
|
items: {
|
|
18189
18255
|
type: "string",
|
|
18190
18256
|
format: "nsid"
|
|
18191
18257
|
}
|
|
18192
18258
|
},
|
|
18193
18259
|
handleIsCorrect: {
|
|
18194
|
-
type: "boolean"
|
|
18260
|
+
type: "boolean",
|
|
18261
|
+
description: "Indicates if handle is currently valid (resolves bi-directionally)"
|
|
18195
18262
|
}
|
|
18196
18263
|
}
|
|
18197
18264
|
}
|
|
@@ -18205,7 +18272,7 @@ var schemaDict = {
|
|
|
18205
18272
|
defs: {
|
|
18206
18273
|
main: {
|
|
18207
18274
|
type: "query",
|
|
18208
|
-
description: "Get a record.",
|
|
18275
|
+
description: "Get a single record from a repository. Does not require auth.",
|
|
18209
18276
|
parameters: {
|
|
18210
18277
|
type: "params",
|
|
18211
18278
|
required: ["repo", "collection", "rkey"],
|
|
@@ -18222,7 +18289,7 @@ var schemaDict = {
|
|
|
18222
18289
|
},
|
|
18223
18290
|
rkey: {
|
|
18224
18291
|
type: "string",
|
|
18225
|
-
description: "The
|
|
18292
|
+
description: "The Record Key."
|
|
18226
18293
|
},
|
|
18227
18294
|
cid: {
|
|
18228
18295
|
type: "string",
|
|
@@ -18260,7 +18327,7 @@ var schemaDict = {
|
|
|
18260
18327
|
defs: {
|
|
18261
18328
|
main: {
|
|
18262
18329
|
type: "query",
|
|
18263
|
-
description: "List a range of records in a collection.",
|
|
18330
|
+
description: "List a range of records in a repository, matching a specific collection. Does not require auth.",
|
|
18264
18331
|
parameters: {
|
|
18265
18332
|
type: "params",
|
|
18266
18333
|
required: ["repo", "collection"],
|
|
@@ -18344,7 +18411,7 @@ var schemaDict = {
|
|
|
18344
18411
|
defs: {
|
|
18345
18412
|
main: {
|
|
18346
18413
|
type: "procedure",
|
|
18347
|
-
description: "Write a record, creating or updating it as needed.",
|
|
18414
|
+
description: "Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.",
|
|
18348
18415
|
input: {
|
|
18349
18416
|
encoding: "application/json",
|
|
18350
18417
|
schema: {
|
|
@@ -18355,7 +18422,7 @@ var schemaDict = {
|
|
|
18355
18422
|
repo: {
|
|
18356
18423
|
type: "string",
|
|
18357
18424
|
format: "at-identifier",
|
|
18358
|
-
description: "The handle or DID of the repo."
|
|
18425
|
+
description: "The handle or DID of the repo (aka, current account)."
|
|
18359
18426
|
},
|
|
18360
18427
|
collection: {
|
|
18361
18428
|
type: "string",
|
|
@@ -18364,13 +18431,13 @@ var schemaDict = {
|
|
|
18364
18431
|
},
|
|
18365
18432
|
rkey: {
|
|
18366
18433
|
type: "string",
|
|
18367
|
-
description: "The
|
|
18434
|
+
description: "The Record Key.",
|
|
18368
18435
|
maxLength: 15
|
|
18369
18436
|
},
|
|
18370
18437
|
validate: {
|
|
18371
18438
|
type: "boolean",
|
|
18372
18439
|
default: true,
|
|
18373
|
-
description: "
|
|
18440
|
+
description: "Can be set to 'false' to skip Lexicon schema validation of record data."
|
|
18374
18441
|
},
|
|
18375
18442
|
record: {
|
|
18376
18443
|
type: "unknown",
|
|
@@ -18379,7 +18446,7 @@ var schemaDict = {
|
|
|
18379
18446
|
swapRecord: {
|
|
18380
18447
|
type: "string",
|
|
18381
18448
|
format: "cid",
|
|
18382
|
-
description: "Compare and swap with the previous record by CID."
|
|
18449
|
+
description: "Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation"
|
|
18383
18450
|
},
|
|
18384
18451
|
swapCommit: {
|
|
18385
18452
|
type: "string",
|
|
@@ -18441,7 +18508,7 @@ var schemaDict = {
|
|
|
18441
18508
|
defs: {
|
|
18442
18509
|
main: {
|
|
18443
18510
|
type: "procedure",
|
|
18444
|
-
description: "Upload a new blob to be
|
|
18511
|
+
description: "Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.",
|
|
18445
18512
|
input: {
|
|
18446
18513
|
encoding: "*/*"
|
|
18447
18514
|
},
|
|
@@ -18505,7 +18572,7 @@ var schemaDict = {
|
|
|
18505
18572
|
defs: {
|
|
18506
18573
|
main: {
|
|
18507
18574
|
type: "procedure",
|
|
18508
|
-
description: "Create an account.",
|
|
18575
|
+
description: "Create an account. Implemented by PDS.",
|
|
18509
18576
|
input: {
|
|
18510
18577
|
encoding: "application/json",
|
|
18511
18578
|
schema: {
|
|
@@ -18517,11 +18584,13 @@ var schemaDict = {
|
|
|
18517
18584
|
},
|
|
18518
18585
|
handle: {
|
|
18519
18586
|
type: "string",
|
|
18520
|
-
format: "handle"
|
|
18587
|
+
format: "handle",
|
|
18588
|
+
description: "Requested handle for the account."
|
|
18521
18589
|
},
|
|
18522
18590
|
did: {
|
|
18523
18591
|
type: "string",
|
|
18524
|
-
format: "did"
|
|
18592
|
+
format: "did",
|
|
18593
|
+
description: "Pre-existing atproto DID, being imported to a new account."
|
|
18525
18594
|
},
|
|
18526
18595
|
inviteCode: {
|
|
18527
18596
|
type: "string"
|
|
@@ -18533,13 +18602,16 @@ var schemaDict = {
|
|
|
18533
18602
|
type: "string"
|
|
18534
18603
|
},
|
|
18535
18604
|
password: {
|
|
18536
|
-
type: "string"
|
|
18605
|
+
type: "string",
|
|
18606
|
+
description: "Initial account password. May need to meet instance-specific password strength requirements."
|
|
18537
18607
|
},
|
|
18538
18608
|
recoveryKey: {
|
|
18539
|
-
type: "string"
|
|
18609
|
+
type: "string",
|
|
18610
|
+
description: "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation."
|
|
18540
18611
|
},
|
|
18541
18612
|
plcOp: {
|
|
18542
|
-
type: "unknown"
|
|
18613
|
+
type: "unknown",
|
|
18614
|
+
description: "A signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented."
|
|
18543
18615
|
}
|
|
18544
18616
|
}
|
|
18545
18617
|
}
|
|
@@ -18548,6 +18620,7 @@ var schemaDict = {
|
|
|
18548
18620
|
encoding: "application/json",
|
|
18549
18621
|
schema: {
|
|
18550
18622
|
type: "object",
|
|
18623
|
+
description: "Account login session returned on successful account creation.",
|
|
18551
18624
|
required: ["accessJwt", "refreshJwt", "handle", "did"],
|
|
18552
18625
|
properties: {
|
|
18553
18626
|
accessJwt: {
|
|
@@ -18562,10 +18635,12 @@ var schemaDict = {
|
|
|
18562
18635
|
},
|
|
18563
18636
|
did: {
|
|
18564
18637
|
type: "string",
|
|
18565
|
-
format: "did"
|
|
18638
|
+
format: "did",
|
|
18639
|
+
description: "The DID of the new account."
|
|
18566
18640
|
},
|
|
18567
18641
|
didDoc: {
|
|
18568
|
-
type: "unknown"
|
|
18642
|
+
type: "unknown",
|
|
18643
|
+
description: "Complete DID document."
|
|
18569
18644
|
}
|
|
18570
18645
|
}
|
|
18571
18646
|
}
|
|
@@ -18610,7 +18685,8 @@ var schemaDict = {
|
|
|
18610
18685
|
required: ["name"],
|
|
18611
18686
|
properties: {
|
|
18612
18687
|
name: {
|
|
18613
|
-
type: "string"
|
|
18688
|
+
type: "string",
|
|
18689
|
+
description: "A short name for the App Password, to help distinguish them."
|
|
18614
18690
|
}
|
|
18615
18691
|
}
|
|
18616
18692
|
}
|
|
@@ -18877,7 +18953,7 @@ var schemaDict = {
|
|
|
18877
18953
|
defs: {
|
|
18878
18954
|
main: {
|
|
18879
18955
|
type: "procedure",
|
|
18880
|
-
description: "Delete an actor's account with a token and password.",
|
|
18956
|
+
description: "Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.",
|
|
18881
18957
|
input: {
|
|
18882
18958
|
encoding: "application/json",
|
|
18883
18959
|
schema: {
|
|
@@ -18914,7 +18990,7 @@ var schemaDict = {
|
|
|
18914
18990
|
defs: {
|
|
18915
18991
|
main: {
|
|
18916
18992
|
type: "procedure",
|
|
18917
|
-
description: "Delete the current session."
|
|
18993
|
+
description: "Delete the current session. Requires auth."
|
|
18918
18994
|
}
|
|
18919
18995
|
}
|
|
18920
18996
|
},
|
|
@@ -18924,7 +19000,7 @@ var schemaDict = {
|
|
|
18924
19000
|
defs: {
|
|
18925
19001
|
main: {
|
|
18926
19002
|
type: "query",
|
|
18927
|
-
description: "
|
|
19003
|
+
description: "Describes the server's account creation requirements and capabilities. Implemented by PDS.",
|
|
18928
19004
|
output: {
|
|
18929
19005
|
encoding: "application/json",
|
|
18930
19006
|
schema: {
|
|
@@ -18932,19 +19008,23 @@ var schemaDict = {
|
|
|
18932
19008
|
required: ["availableUserDomains"],
|
|
18933
19009
|
properties: {
|
|
18934
19010
|
inviteCodeRequired: {
|
|
18935
|
-
type: "boolean"
|
|
19011
|
+
type: "boolean",
|
|
19012
|
+
description: "If true, an invite code must be supplied to create an account on this instance."
|
|
18936
19013
|
},
|
|
18937
19014
|
phoneVerificationRequired: {
|
|
18938
|
-
type: "boolean"
|
|
19015
|
+
type: "boolean",
|
|
19016
|
+
description: "If true, a phone verification token must be supplied to create an account on this instance."
|
|
18939
19017
|
},
|
|
18940
19018
|
availableUserDomains: {
|
|
18941
19019
|
type: "array",
|
|
19020
|
+
description: "List of domain suffixes that can be used in account handles.",
|
|
18942
19021
|
items: {
|
|
18943
19022
|
type: "string"
|
|
18944
19023
|
}
|
|
18945
19024
|
},
|
|
18946
19025
|
links: {
|
|
18947
19026
|
type: "ref",
|
|
19027
|
+
description: "URLs of service policy documents.",
|
|
18948
19028
|
ref: "lex:com.atproto.server.describeServer#links"
|
|
18949
19029
|
}
|
|
18950
19030
|
}
|
|
@@ -18970,7 +19050,7 @@ var schemaDict = {
|
|
|
18970
19050
|
defs: {
|
|
18971
19051
|
main: {
|
|
18972
19052
|
type: "query",
|
|
18973
|
-
description: "Get all invite codes for
|
|
19053
|
+
description: "Get all invite codes for the current account. Requires auth.",
|
|
18974
19054
|
parameters: {
|
|
18975
19055
|
type: "params",
|
|
18976
19056
|
properties: {
|
|
@@ -18980,7 +19060,8 @@ var schemaDict = {
|
|
|
18980
19060
|
},
|
|
18981
19061
|
createAvailable: {
|
|
18982
19062
|
type: "boolean",
|
|
18983
|
-
default: true
|
|
19063
|
+
default: true,
|
|
19064
|
+
description: "Controls whether any new 'earned' but not 'created' invites should be created."
|
|
18984
19065
|
}
|
|
18985
19066
|
}
|
|
18986
19067
|
},
|
|
@@ -19014,7 +19095,7 @@ var schemaDict = {
|
|
|
19014
19095
|
defs: {
|
|
19015
19096
|
main: {
|
|
19016
19097
|
type: "query",
|
|
19017
|
-
description: "Get information about the current session.",
|
|
19098
|
+
description: "Get information about the current auth session. Requires auth.",
|
|
19018
19099
|
output: {
|
|
19019
19100
|
encoding: "application/json",
|
|
19020
19101
|
schema: {
|
|
@@ -19094,7 +19175,7 @@ var schemaDict = {
|
|
|
19094
19175
|
defs: {
|
|
19095
19176
|
main: {
|
|
19096
19177
|
type: "procedure",
|
|
19097
|
-
description: "Refresh an authentication session.",
|
|
19178
|
+
description: "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
|
|
19098
19179
|
output: {
|
|
19099
19180
|
encoding: "application/json",
|
|
19100
19181
|
schema: {
|
|
@@ -19199,7 +19280,7 @@ var schemaDict = {
|
|
|
19199
19280
|
defs: {
|
|
19200
19281
|
main: {
|
|
19201
19282
|
type: "procedure",
|
|
19202
|
-
description: "Reserve a repo signing key for account creation.",
|
|
19283
|
+
description: "Reserve a repo signing key, for use with account creation. Necessary so that a DID PLC update operation can be constructed during an account migraiton. Public and does not require auth; implemented by PDS. NOTE: this endpoint may change when full account migration is implemented.",
|
|
19203
19284
|
input: {
|
|
19204
19285
|
encoding: "application/json",
|
|
19205
19286
|
schema: {
|
|
@@ -19207,7 +19288,8 @@ var schemaDict = {
|
|
|
19207
19288
|
properties: {
|
|
19208
19289
|
did: {
|
|
19209
19290
|
type: "string",
|
|
19210
|
-
|
|
19291
|
+
format: "did",
|
|
19292
|
+
description: "The DID to reserve a key for."
|
|
19211
19293
|
}
|
|
19212
19294
|
}
|
|
19213
19295
|
}
|
|
@@ -19220,7 +19302,7 @@ var schemaDict = {
|
|
|
19220
19302
|
properties: {
|
|
19221
19303
|
signingKey: {
|
|
19222
19304
|
type: "string",
|
|
19223
|
-
description: "
|
|
19305
|
+
description: "The public key for the reserved signing key, in did:key serialization."
|
|
19224
19306
|
}
|
|
19225
19307
|
}
|
|
19226
19308
|
}
|
|
@@ -19326,7 +19408,7 @@ var schemaDict = {
|
|
|
19326
19408
|
defs: {
|
|
19327
19409
|
main: {
|
|
19328
19410
|
type: "query",
|
|
19329
|
-
description: "Get a blob associated with a given
|
|
19411
|
+
description: "Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.",
|
|
19330
19412
|
parameters: {
|
|
19331
19413
|
type: "params",
|
|
19332
19414
|
required: ["did", "cid"],
|
|
@@ -19334,7 +19416,7 @@ var schemaDict = {
|
|
|
19334
19416
|
did: {
|
|
19335
19417
|
type: "string",
|
|
19336
19418
|
format: "did",
|
|
19337
|
-
description: "The DID of the
|
|
19419
|
+
description: "The DID of the account."
|
|
19338
19420
|
},
|
|
19339
19421
|
cid: {
|
|
19340
19422
|
type: "string",
|
|
@@ -19355,7 +19437,7 @@ var schemaDict = {
|
|
|
19355
19437
|
defs: {
|
|
19356
19438
|
main: {
|
|
19357
19439
|
type: "query",
|
|
19358
|
-
description: "Get blocks from a given repo.",
|
|
19440
|
+
description: "Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.",
|
|
19359
19441
|
parameters: {
|
|
19360
19442
|
type: "params",
|
|
19361
19443
|
required: ["did", "cids"],
|
|
@@ -19449,7 +19531,7 @@ var schemaDict = {
|
|
|
19449
19531
|
defs: {
|
|
19450
19532
|
main: {
|
|
19451
19533
|
type: "query",
|
|
19452
|
-
description: "Get the current commit CID & revision of the repo.",
|
|
19534
|
+
description: "Get the current commit CID & revision of the specified repo. Does not require auth.",
|
|
19453
19535
|
parameters: {
|
|
19454
19536
|
type: "params",
|
|
19455
19537
|
required: ["did"],
|
|
@@ -19491,7 +19573,7 @@ var schemaDict = {
|
|
|
19491
19573
|
defs: {
|
|
19492
19574
|
main: {
|
|
19493
19575
|
type: "query",
|
|
19494
|
-
description: "Get blocks needed
|
|
19576
|
+
description: "Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.",
|
|
19495
19577
|
parameters: {
|
|
19496
19578
|
type: "params",
|
|
19497
19579
|
required: ["did", "collection", "rkey"],
|
|
@@ -19506,7 +19588,8 @@ var schemaDict = {
|
|
|
19506
19588
|
format: "nsid"
|
|
19507
19589
|
},
|
|
19508
19590
|
rkey: {
|
|
19509
|
-
type: "string"
|
|
19591
|
+
type: "string",
|
|
19592
|
+
description: "Record Key"
|
|
19510
19593
|
},
|
|
19511
19594
|
commit: {
|
|
19512
19595
|
type: "string",
|
|
@@ -19527,7 +19610,7 @@ var schemaDict = {
|
|
|
19527
19610
|
defs: {
|
|
19528
19611
|
main: {
|
|
19529
19612
|
type: "query",
|
|
19530
|
-
description: "
|
|
19613
|
+
description: "Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.",
|
|
19531
19614
|
parameters: {
|
|
19532
19615
|
type: "params",
|
|
19533
19616
|
required: ["did"],
|
|
@@ -19539,7 +19622,7 @@ var schemaDict = {
|
|
|
19539
19622
|
},
|
|
19540
19623
|
since: {
|
|
19541
19624
|
type: "string",
|
|
19542
|
-
description: "The revision of the repo to
|
|
19625
|
+
description: "The revision ('rev') of the repo to create a diff from."
|
|
19543
19626
|
}
|
|
19544
19627
|
}
|
|
19545
19628
|
},
|
|
@@ -19555,7 +19638,7 @@ var schemaDict = {
|
|
|
19555
19638
|
defs: {
|
|
19556
19639
|
main: {
|
|
19557
19640
|
type: "query",
|
|
19558
|
-
description: "List blob
|
|
19641
|
+
description: "List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS.",
|
|
19559
19642
|
parameters: {
|
|
19560
19643
|
type: "params",
|
|
19561
19644
|
required: ["did"],
|
|
@@ -19608,7 +19691,7 @@ var schemaDict = {
|
|
|
19608
19691
|
defs: {
|
|
19609
19692
|
main: {
|
|
19610
19693
|
type: "query",
|
|
19611
|
-
description: "
|
|
19694
|
+
description: "Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.",
|
|
19612
19695
|
parameters: {
|
|
19613
19696
|
type: "params",
|
|
19614
19697
|
properties: {
|
|
@@ -19653,7 +19736,8 @@ var schemaDict = {
|
|
|
19653
19736
|
},
|
|
19654
19737
|
head: {
|
|
19655
19738
|
type: "string",
|
|
19656
|
-
format: "cid"
|
|
19739
|
+
format: "cid",
|
|
19740
|
+
description: "Current repo commit CID"
|
|
19657
19741
|
},
|
|
19658
19742
|
rev: {
|
|
19659
19743
|
type: "string"
|
|
@@ -19668,7 +19752,7 @@ var schemaDict = {
|
|
|
19668
19752
|
defs: {
|
|
19669
19753
|
main: {
|
|
19670
19754
|
type: "procedure",
|
|
19671
|
-
description: "Notify a crawling service of a recent update
|
|
19755
|
+
description: "Notify a crawling service of a recent update, and that crawling should resume. Intended use is after a gap between repo stream events caused the crawling service to disconnect. Does not require auth; implemented by Relay.",
|
|
19672
19756
|
input: {
|
|
19673
19757
|
encoding: "application/json",
|
|
19674
19758
|
schema: {
|
|
@@ -19677,7 +19761,7 @@ var schemaDict = {
|
|
|
19677
19761
|
properties: {
|
|
19678
19762
|
hostname: {
|
|
19679
19763
|
type: "string",
|
|
19680
|
-
description: "Hostname of the service that is notifying of update."
|
|
19764
|
+
description: "Hostname of the current service (usually a PDS) that is notifying of update."
|
|
19681
19765
|
}
|
|
19682
19766
|
}
|
|
19683
19767
|
}
|
|
@@ -19691,7 +19775,7 @@ var schemaDict = {
|
|
|
19691
19775
|
defs: {
|
|
19692
19776
|
main: {
|
|
19693
19777
|
type: "procedure",
|
|
19694
|
-
description: "Request a service to persistently crawl hosted repos.",
|
|
19778
|
+
description: "Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.",
|
|
19695
19779
|
input: {
|
|
19696
19780
|
encoding: "application/json",
|
|
19697
19781
|
schema: {
|
|
@@ -19700,7 +19784,7 @@ var schemaDict = {
|
|
|
19700
19784
|
properties: {
|
|
19701
19785
|
hostname: {
|
|
19702
19786
|
type: "string",
|
|
19703
|
-
description: "Hostname of the service that is requesting to be crawled."
|
|
19787
|
+
description: "Hostname of the current service (eg, PDS) that is requesting to be crawled."
|
|
19704
19788
|
}
|
|
19705
19789
|
}
|
|
19706
19790
|
}
|
|
@@ -19714,13 +19798,13 @@ var schemaDict = {
|
|
|
19714
19798
|
defs: {
|
|
19715
19799
|
main: {
|
|
19716
19800
|
type: "subscription",
|
|
19717
|
-
description: "
|
|
19801
|
+
description: "Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.",
|
|
19718
19802
|
parameters: {
|
|
19719
19803
|
type: "params",
|
|
19720
19804
|
properties: {
|
|
19721
19805
|
cursor: {
|
|
19722
19806
|
type: "integer",
|
|
19723
|
-
description: "The last known event to backfill from."
|
|
19807
|
+
description: "The last known event seq number to backfill from."
|
|
19724
19808
|
}
|
|
19725
19809
|
}
|
|
19726
19810
|
},
|
|
@@ -19741,12 +19825,14 @@ var schemaDict = {
|
|
|
19741
19825
|
name: "FutureCursor"
|
|
19742
19826
|
},
|
|
19743
19827
|
{
|
|
19744
|
-
name: "ConsumerTooSlow"
|
|
19828
|
+
name: "ConsumerTooSlow",
|
|
19829
|
+
description: "If the consumer of the stream can not keep up with events, and a backlog gets too large, the server will drop the connection."
|
|
19745
19830
|
}
|
|
19746
19831
|
]
|
|
19747
19832
|
},
|
|
19748
19833
|
commit: {
|
|
19749
19834
|
type: "object",
|
|
19835
|
+
description: "Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature.",
|
|
19750
19836
|
required: [
|
|
19751
19837
|
"seq",
|
|
19752
19838
|
"rebase",
|
|
@@ -19763,59 +19849,69 @@ var schemaDict = {
|
|
|
19763
19849
|
nullable: ["prev", "since"],
|
|
19764
19850
|
properties: {
|
|
19765
19851
|
seq: {
|
|
19766
|
-
type: "integer"
|
|
19852
|
+
type: "integer",
|
|
19853
|
+
description: "The stream sequence number of this message."
|
|
19767
19854
|
},
|
|
19768
19855
|
rebase: {
|
|
19769
|
-
type: "boolean"
|
|
19856
|
+
type: "boolean",
|
|
19857
|
+
description: "DEPRECATED -- unused"
|
|
19770
19858
|
},
|
|
19771
19859
|
tooBig: {
|
|
19772
|
-
type: "boolean"
|
|
19860
|
+
type: "boolean",
|
|
19861
|
+
description: "Indicates that this commit contained too many ops, or data size was too large. Consumers will need to make a separate request to get missing data."
|
|
19773
19862
|
},
|
|
19774
19863
|
repo: {
|
|
19775
19864
|
type: "string",
|
|
19776
|
-
format: "did"
|
|
19865
|
+
format: "did",
|
|
19866
|
+
description: "The repo this event comes from."
|
|
19777
19867
|
},
|
|
19778
19868
|
commit: {
|
|
19779
|
-
type: "cid-link"
|
|
19869
|
+
type: "cid-link",
|
|
19870
|
+
description: "Repo commit object CID."
|
|
19780
19871
|
},
|
|
19781
19872
|
prev: {
|
|
19782
|
-
type: "cid-link"
|
|
19873
|
+
type: "cid-link",
|
|
19874
|
+
description: "DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability."
|
|
19783
19875
|
},
|
|
19784
19876
|
rev: {
|
|
19785
19877
|
type: "string",
|
|
19786
|
-
description: "The rev of the emitted commit."
|
|
19878
|
+
description: "The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event."
|
|
19787
19879
|
},
|
|
19788
19880
|
since: {
|
|
19789
19881
|
type: "string",
|
|
19790
|
-
description: "The rev of the last emitted commit from this repo."
|
|
19882
|
+
description: "The rev of the last emitted commit from this repo (if any)."
|
|
19791
19883
|
},
|
|
19792
19884
|
blocks: {
|
|
19793
19885
|
type: "bytes",
|
|
19794
|
-
description: "CAR file containing relevant blocks.",
|
|
19886
|
+
description: "CAR file containing relevant blocks, as a diff since the previous repo state.",
|
|
19795
19887
|
maxLength: 1e6
|
|
19796
19888
|
},
|
|
19797
19889
|
ops: {
|
|
19798
19890
|
type: "array",
|
|
19799
19891
|
items: {
|
|
19800
19892
|
type: "ref",
|
|
19801
|
-
ref: "lex:com.atproto.sync.subscribeRepos#repoOp"
|
|
19893
|
+
ref: "lex:com.atproto.sync.subscribeRepos#repoOp",
|
|
19894
|
+
description: "List of repo mutation operations in this commit (eg, records created, updated, or deleted)."
|
|
19802
19895
|
},
|
|
19803
19896
|
maxLength: 200
|
|
19804
19897
|
},
|
|
19805
19898
|
blobs: {
|
|
19806
19899
|
type: "array",
|
|
19807
19900
|
items: {
|
|
19808
|
-
type: "cid-link"
|
|
19901
|
+
type: "cid-link",
|
|
19902
|
+
description: "List of new blobs (by CID) referenced by records in this commit."
|
|
19809
19903
|
}
|
|
19810
19904
|
},
|
|
19811
19905
|
time: {
|
|
19812
19906
|
type: "string",
|
|
19813
|
-
format: "datetime"
|
|
19907
|
+
format: "datetime",
|
|
19908
|
+
description: "Timestamp of when this message was originally broadcast."
|
|
19814
19909
|
}
|
|
19815
19910
|
}
|
|
19816
19911
|
},
|
|
19817
19912
|
handle: {
|
|
19818
19913
|
type: "object",
|
|
19914
|
+
description: "Represents an update of the account's handle, or transition to/from invalid state.",
|
|
19819
19915
|
required: ["seq", "did", "handle", "time"],
|
|
19820
19916
|
properties: {
|
|
19821
19917
|
seq: {
|
|
@@ -19837,6 +19933,7 @@ var schemaDict = {
|
|
|
19837
19933
|
},
|
|
19838
19934
|
migrate: {
|
|
19839
19935
|
type: "object",
|
|
19936
|
+
description: "Represents an account moving from one PDS instance to another. NOTE: not implemented; full account migration may introduce a new message instead.",
|
|
19840
19937
|
required: ["seq", "did", "migrateTo", "time"],
|
|
19841
19938
|
nullable: ["migrateTo"],
|
|
19842
19939
|
properties: {
|
|
@@ -19858,6 +19955,7 @@ var schemaDict = {
|
|
|
19858
19955
|
},
|
|
19859
19956
|
tombstone: {
|
|
19860
19957
|
type: "object",
|
|
19958
|
+
description: "Indicates that an account has been deleted.",
|
|
19861
19959
|
required: ["seq", "did", "time"],
|
|
19862
19960
|
properties: {
|
|
19863
19961
|
seq: {
|
|
@@ -19888,7 +19986,7 @@ var schemaDict = {
|
|
|
19888
19986
|
},
|
|
19889
19987
|
repoOp: {
|
|
19890
19988
|
type: "object",
|
|
19891
|
-
description: "A repo operation, ie a
|
|
19989
|
+
description: "A repo operation, ie a mutation of a single record.",
|
|
19892
19990
|
required: ["action", "path", "cid"],
|
|
19893
19991
|
nullable: ["cid"],
|
|
19894
19992
|
properties: {
|
|
@@ -19900,7 +19998,8 @@ var schemaDict = {
|
|
|
19900
19998
|
type: "string"
|
|
19901
19999
|
},
|
|
19902
20000
|
cid: {
|
|
19903
|
-
type: "cid-link"
|
|
20001
|
+
type: "cid-link",
|
|
20002
|
+
description: "For creates and updates, the new record CID. For deletions, null."
|
|
19904
20003
|
}
|
|
19905
20004
|
}
|
|
19906
20005
|
}
|
|
@@ -19940,7 +20039,7 @@ var schemaDict = {
|
|
|
19940
20039
|
defs: {
|
|
19941
20040
|
main: {
|
|
19942
20041
|
type: "query",
|
|
19943
|
-
description: "Fetch all labels from a labeler created after a certain date.",
|
|
20042
|
+
description: "Fetch all labels from a labeler created after a certain date. DEPRECATED: use queryLabels or subscribeLabels instead",
|
|
19944
20043
|
parameters: {
|
|
19945
20044
|
type: "params",
|
|
19946
20045
|
properties: {
|
|
@@ -20053,7 +20152,7 @@ var schemaDict = {
|
|
|
20053
20152
|
defs: {
|
|
20054
20153
|
main: {
|
|
20055
20154
|
type: "procedure",
|
|
20056
|
-
description: "Transfer an account.",
|
|
20155
|
+
description: "Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented.",
|
|
20057
20156
|
input: {
|
|
20058
20157
|
encoding: "application/json",
|
|
20059
20158
|
schema: {
|
|
@@ -20126,7 +20225,6 @@ var schemaDict = {
|
|
|
20126
20225
|
AppBskyActorDefs: {
|
|
20127
20226
|
lexicon: 1,
|
|
20128
20227
|
id: "app.bsky.actor.defs",
|
|
20129
|
-
description: "A reference to an actor in the network.",
|
|
20130
20228
|
defs: {
|
|
20131
20229
|
profileViewBasic: {
|
|
20132
20230
|
type: "object",
|
|
@@ -20259,6 +20357,7 @@ var schemaDict = {
|
|
|
20259
20357
|
},
|
|
20260
20358
|
viewerState: {
|
|
20261
20359
|
type: "object",
|
|
20360
|
+
description: "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.",
|
|
20262
20361
|
properties: {
|
|
20263
20362
|
muted: {
|
|
20264
20363
|
type: "boolean"
|
|
@@ -20343,6 +20442,9 @@ var schemaDict = {
|
|
|
20343
20442
|
type: "string",
|
|
20344
20443
|
format: "at-uri"
|
|
20345
20444
|
}
|
|
20445
|
+
},
|
|
20446
|
+
timelineIndex: {
|
|
20447
|
+
type: "integer"
|
|
20346
20448
|
}
|
|
20347
20449
|
}
|
|
20348
20450
|
},
|
|
@@ -20424,7 +20526,7 @@ var schemaDict = {
|
|
|
20424
20526
|
defs: {
|
|
20425
20527
|
main: {
|
|
20426
20528
|
type: "query",
|
|
20427
|
-
description: "Get private preferences attached to the account.",
|
|
20529
|
+
description: "Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.",
|
|
20428
20530
|
parameters: {
|
|
20429
20531
|
type: "params",
|
|
20430
20532
|
properties: {}
|
|
@@ -20451,14 +20553,15 @@ var schemaDict = {
|
|
|
20451
20553
|
defs: {
|
|
20452
20554
|
main: {
|
|
20453
20555
|
type: "query",
|
|
20454
|
-
description: "Get detailed profile view of an actor.",
|
|
20556
|
+
description: "Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.",
|
|
20455
20557
|
parameters: {
|
|
20456
20558
|
type: "params",
|
|
20457
20559
|
required: ["actor"],
|
|
20458
20560
|
properties: {
|
|
20459
20561
|
actor: {
|
|
20460
20562
|
type: "string",
|
|
20461
|
-
format: "at-identifier"
|
|
20563
|
+
format: "at-identifier",
|
|
20564
|
+
description: "Handle or DID of account to fetch profile of."
|
|
20462
20565
|
}
|
|
20463
20566
|
}
|
|
20464
20567
|
},
|
|
@@ -20518,7 +20621,7 @@ var schemaDict = {
|
|
|
20518
20621
|
defs: {
|
|
20519
20622
|
main: {
|
|
20520
20623
|
type: "query",
|
|
20521
|
-
description: "Get a list of suggested actors
|
|
20624
|
+
description: "Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.",
|
|
20522
20625
|
parameters: {
|
|
20523
20626
|
type: "params",
|
|
20524
20627
|
properties: {
|
|
@@ -20561,7 +20664,7 @@ var schemaDict = {
|
|
|
20561
20664
|
defs: {
|
|
20562
20665
|
main: {
|
|
20563
20666
|
type: "record",
|
|
20564
|
-
description: "A declaration of a profile.",
|
|
20667
|
+
description: "A declaration of a Bluesky account profile.",
|
|
20565
20668
|
key: "literal:self",
|
|
20566
20669
|
record: {
|
|
20567
20670
|
type: "object",
|
|
@@ -20573,21 +20676,25 @@ var schemaDict = {
|
|
|
20573
20676
|
},
|
|
20574
20677
|
description: {
|
|
20575
20678
|
type: "string",
|
|
20679
|
+
description: "Free-form profile description text.",
|
|
20576
20680
|
maxGraphemes: 256,
|
|
20577
20681
|
maxLength: 2560
|
|
20578
20682
|
},
|
|
20579
20683
|
avatar: {
|
|
20580
20684
|
type: "blob",
|
|
20685
|
+
description: "Small image to be displayed next to posts from account. AKA, 'profile picture'",
|
|
20581
20686
|
accept: ["image/png", "image/jpeg"],
|
|
20582
20687
|
maxSize: 1e6
|
|
20583
20688
|
},
|
|
20584
20689
|
banner: {
|
|
20585
20690
|
type: "blob",
|
|
20691
|
+
description: "Larger horizontal image to display behind profile view.",
|
|
20586
20692
|
accept: ["image/png", "image/jpeg"],
|
|
20587
20693
|
maxSize: 1e6
|
|
20588
20694
|
},
|
|
20589
20695
|
labels: {
|
|
20590
20696
|
type: "union",
|
|
20697
|
+
description: "Self-label values, specific to the Bluesky application, on the overall account.",
|
|
20591
20698
|
refs: ["lex:com.atproto.label.defs#selfLabels"]
|
|
20592
20699
|
}
|
|
20593
20700
|
}
|
|
@@ -20624,7 +20731,7 @@ var schemaDict = {
|
|
|
20624
20731
|
defs: {
|
|
20625
20732
|
main: {
|
|
20626
20733
|
type: "query",
|
|
20627
|
-
description: "Find actors (profiles) matching search criteria.",
|
|
20734
|
+
description: "Find actors (profiles) matching search criteria. Does not require auth.",
|
|
20628
20735
|
parameters: {
|
|
20629
20736
|
type: "params",
|
|
20630
20737
|
properties: {
|
|
@@ -20675,7 +20782,7 @@ var schemaDict = {
|
|
|
20675
20782
|
defs: {
|
|
20676
20783
|
main: {
|
|
20677
20784
|
type: "query",
|
|
20678
|
-
description: "Find actor suggestions for a prefix search term.",
|
|
20785
|
+
description: "Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.",
|
|
20679
20786
|
parameters: {
|
|
20680
20787
|
type: "params",
|
|
20681
20788
|
properties: {
|
|
@@ -20717,10 +20824,10 @@ var schemaDict = {
|
|
|
20717
20824
|
AppBskyEmbedExternal: {
|
|
20718
20825
|
lexicon: 1,
|
|
20719
20826
|
id: "app.bsky.embed.external",
|
|
20720
|
-
description: "A representation of some externally linked content, embedded in another form of content.",
|
|
20721
20827
|
defs: {
|
|
20722
20828
|
main: {
|
|
20723
20829
|
type: "object",
|
|
20830
|
+
description: "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).",
|
|
20724
20831
|
required: ["external"],
|
|
20725
20832
|
properties: {
|
|
20726
20833
|
external: {
|
|
@@ -20784,7 +20891,7 @@ var schemaDict = {
|
|
|
20784
20891
|
AppBskyEmbedImages: {
|
|
20785
20892
|
lexicon: 1,
|
|
20786
20893
|
id: "app.bsky.embed.images",
|
|
20787
|
-
description: "A set of images embedded in
|
|
20894
|
+
description: "A set of images embedded in a Bluesky record (eg, a post).",
|
|
20788
20895
|
defs: {
|
|
20789
20896
|
main: {
|
|
20790
20897
|
type: "object",
|
|
@@ -20810,7 +20917,8 @@ var schemaDict = {
|
|
|
20810
20917
|
maxSize: 1e6
|
|
20811
20918
|
},
|
|
20812
20919
|
alt: {
|
|
20813
|
-
type: "string"
|
|
20920
|
+
type: "string",
|
|
20921
|
+
description: "Alt text description of the image, for accessibility."
|
|
20814
20922
|
},
|
|
20815
20923
|
aspectRatio: {
|
|
20816
20924
|
type: "ref",
|
|
@@ -20852,13 +20960,16 @@ var schemaDict = {
|
|
|
20852
20960
|
required: ["thumb", "fullsize", "alt"],
|
|
20853
20961
|
properties: {
|
|
20854
20962
|
thumb: {
|
|
20855
|
-
type: "string"
|
|
20963
|
+
type: "string",
|
|
20964
|
+
description: "Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View."
|
|
20856
20965
|
},
|
|
20857
20966
|
fullsize: {
|
|
20858
|
-
type: "string"
|
|
20967
|
+
type: "string",
|
|
20968
|
+
description: "Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View."
|
|
20859
20969
|
},
|
|
20860
20970
|
alt: {
|
|
20861
|
-
type: "string"
|
|
20971
|
+
type: "string",
|
|
20972
|
+
description: "Alt text description of the image, for accessibility."
|
|
20862
20973
|
},
|
|
20863
20974
|
aspectRatio: {
|
|
20864
20975
|
type: "ref",
|
|
@@ -20871,7 +20982,7 @@ var schemaDict = {
|
|
|
20871
20982
|
AppBskyEmbedRecord: {
|
|
20872
20983
|
lexicon: 1,
|
|
20873
20984
|
id: "app.bsky.embed.record",
|
|
20874
|
-
description: "A representation of a record embedded in
|
|
20985
|
+
description: "A representation of a record embedded in a Bluesky record (eg, a post). For example, a quote-post, or sharing a feed generator record.",
|
|
20875
20986
|
defs: {
|
|
20876
20987
|
main: {
|
|
20877
20988
|
type: "object",
|
|
@@ -20916,7 +21027,8 @@ var schemaDict = {
|
|
|
20916
21027
|
ref: "lex:app.bsky.actor.defs#profileViewBasic"
|
|
20917
21028
|
},
|
|
20918
21029
|
value: {
|
|
20919
|
-
type: "unknown"
|
|
21030
|
+
type: "unknown",
|
|
21031
|
+
description: "The record data itself."
|
|
20920
21032
|
},
|
|
20921
21033
|
labels: {
|
|
20922
21034
|
type: "array",
|
|
@@ -20980,7 +21092,7 @@ var schemaDict = {
|
|
|
20980
21092
|
AppBskyEmbedRecordWithMedia: {
|
|
20981
21093
|
lexicon: 1,
|
|
20982
21094
|
id: "app.bsky.embed.recordWithMedia",
|
|
20983
|
-
description: "A representation of a record embedded in
|
|
21095
|
+
description: "A representation of a record embedded in a Bluesky record (eg, a post), alongside other compatible embeds. For example, a quote post and image, or a quote post and external URL card.",
|
|
20984
21096
|
defs: {
|
|
20985
21097
|
main: {
|
|
20986
21098
|
type: "object",
|
|
@@ -21079,6 +21191,7 @@ var schemaDict = {
|
|
|
21079
21191
|
},
|
|
21080
21192
|
viewerState: {
|
|
21081
21193
|
type: "object",
|
|
21194
|
+
description: "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.",
|
|
21082
21195
|
properties: {
|
|
21083
21196
|
repost: {
|
|
21084
21197
|
type: "string",
|
|
@@ -21338,7 +21451,7 @@ var schemaDict = {
|
|
|
21338
21451
|
defs: {
|
|
21339
21452
|
main: {
|
|
21340
21453
|
type: "query",
|
|
21341
|
-
description: "Get information about a feed generator, including policies and offered feed URIs.",
|
|
21454
|
+
description: "Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View).",
|
|
21342
21455
|
output: {
|
|
21343
21456
|
encoding: "application/json",
|
|
21344
21457
|
schema: {
|
|
@@ -21393,7 +21506,7 @@ var schemaDict = {
|
|
|
21393
21506
|
defs: {
|
|
21394
21507
|
main: {
|
|
21395
21508
|
type: "record",
|
|
21396
|
-
description: "
|
|
21509
|
+
description: "Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.",
|
|
21397
21510
|
key: "any",
|
|
21398
21511
|
record: {
|
|
21399
21512
|
type: "object",
|
|
@@ -21427,6 +21540,7 @@ var schemaDict = {
|
|
|
21427
21540
|
},
|
|
21428
21541
|
labels: {
|
|
21429
21542
|
type: "union",
|
|
21543
|
+
description: "Self-label values",
|
|
21430
21544
|
refs: ["lex:com.atproto.label.defs#selfLabels"]
|
|
21431
21545
|
},
|
|
21432
21546
|
createdAt: {
|
|
@@ -21444,7 +21558,7 @@ var schemaDict = {
|
|
|
21444
21558
|
defs: {
|
|
21445
21559
|
main: {
|
|
21446
21560
|
type: "query",
|
|
21447
|
-
description: "Get a list of feeds created by the actor.",
|
|
21561
|
+
description: "Get a list of feeds (feed generator records) created by the actor (in the actor's repo).",
|
|
21448
21562
|
parameters: {
|
|
21449
21563
|
type: "params",
|
|
21450
21564
|
required: ["actor"],
|
|
@@ -21492,7 +21606,7 @@ var schemaDict = {
|
|
|
21492
21606
|
defs: {
|
|
21493
21607
|
main: {
|
|
21494
21608
|
type: "query",
|
|
21495
|
-
description: "Get a list of posts liked by an actor.",
|
|
21609
|
+
description: "Get a list of posts liked by an actor. Does not require auth.",
|
|
21496
21610
|
parameters: {
|
|
21497
21611
|
type: "params",
|
|
21498
21612
|
required: ["actor"],
|
|
@@ -21548,7 +21662,7 @@ var schemaDict = {
|
|
|
21548
21662
|
defs: {
|
|
21549
21663
|
main: {
|
|
21550
21664
|
type: "query",
|
|
21551
|
-
description: "Get a view of an actor's feed.",
|
|
21665
|
+
description: "Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.",
|
|
21552
21666
|
parameters: {
|
|
21553
21667
|
type: "params",
|
|
21554
21668
|
required: ["actor"],
|
|
@@ -21568,6 +21682,7 @@ var schemaDict = {
|
|
|
21568
21682
|
},
|
|
21569
21683
|
filter: {
|
|
21570
21684
|
type: "string",
|
|
21685
|
+
description: "Combinations of post/repost types to include in response.",
|
|
21571
21686
|
knownValues: [
|
|
21572
21687
|
"posts_with_replies",
|
|
21573
21688
|
"posts_no_replies",
|
|
@@ -21614,7 +21729,7 @@ var schemaDict = {
|
|
|
21614
21729
|
defs: {
|
|
21615
21730
|
main: {
|
|
21616
21731
|
type: "query",
|
|
21617
|
-
description: "Get a hydrated feed from an actor's selected feed generator.",
|
|
21732
|
+
description: "Get a hydrated feed from an actor's selected feed generator. Implemented by App View.",
|
|
21618
21733
|
parameters: {
|
|
21619
21734
|
type: "params",
|
|
21620
21735
|
required: ["feed"],
|
|
@@ -21667,14 +21782,15 @@ var schemaDict = {
|
|
|
21667
21782
|
defs: {
|
|
21668
21783
|
main: {
|
|
21669
21784
|
type: "query",
|
|
21670
|
-
description: "Get information about a feed generator.",
|
|
21785
|
+
description: "Get information about a feed generator. Implemented by AppView.",
|
|
21671
21786
|
parameters: {
|
|
21672
21787
|
type: "params",
|
|
21673
21788
|
required: ["feed"],
|
|
21674
21789
|
properties: {
|
|
21675
21790
|
feed: {
|
|
21676
21791
|
type: "string",
|
|
21677
|
-
format: "at-uri"
|
|
21792
|
+
format: "at-uri",
|
|
21793
|
+
description: "AT-URI of the feed generator record."
|
|
21678
21794
|
}
|
|
21679
21795
|
}
|
|
21680
21796
|
},
|
|
@@ -21689,10 +21805,12 @@ var schemaDict = {
|
|
|
21689
21805
|
ref: "lex:app.bsky.feed.defs#generatorView"
|
|
21690
21806
|
},
|
|
21691
21807
|
isOnline: {
|
|
21692
|
-
type: "boolean"
|
|
21808
|
+
type: "boolean",
|
|
21809
|
+
description: "Indicates whether the feed generator service has been online recently, or else seems to be inactive."
|
|
21693
21810
|
},
|
|
21694
21811
|
isValid: {
|
|
21695
|
-
type: "boolean"
|
|
21812
|
+
type: "boolean",
|
|
21813
|
+
description: "Indicates whether the feed generator service is compatible with the record declaration."
|
|
21696
21814
|
}
|
|
21697
21815
|
}
|
|
21698
21816
|
}
|
|
@@ -21745,14 +21863,15 @@ var schemaDict = {
|
|
|
21745
21863
|
defs: {
|
|
21746
21864
|
main: {
|
|
21747
21865
|
type: "query",
|
|
21748
|
-
description: "Get a skeleton of a feed provided by a feed generator.",
|
|
21866
|
+
description: "Get a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester. Implemented by Feed Generator Service.",
|
|
21749
21867
|
parameters: {
|
|
21750
21868
|
type: "params",
|
|
21751
21869
|
required: ["feed"],
|
|
21752
21870
|
properties: {
|
|
21753
21871
|
feed: {
|
|
21754
21872
|
type: "string",
|
|
21755
|
-
format: "at-uri"
|
|
21873
|
+
format: "at-uri",
|
|
21874
|
+
description: "Reference to feed generator record describing the specific feed being requested."
|
|
21756
21875
|
},
|
|
21757
21876
|
limit: {
|
|
21758
21877
|
type: "integer",
|
|
@@ -21798,18 +21917,20 @@ var schemaDict = {
|
|
|
21798
21917
|
defs: {
|
|
21799
21918
|
main: {
|
|
21800
21919
|
type: "query",
|
|
21801
|
-
description: "Get
|
|
21920
|
+
description: "Get like records which reference a subject (by AT-URI and CID).",
|
|
21802
21921
|
parameters: {
|
|
21803
21922
|
type: "params",
|
|
21804
21923
|
required: ["uri"],
|
|
21805
21924
|
properties: {
|
|
21806
21925
|
uri: {
|
|
21807
21926
|
type: "string",
|
|
21808
|
-
format: "at-uri"
|
|
21927
|
+
format: "at-uri",
|
|
21928
|
+
description: "AT-URI of the subject (eg, a post record)."
|
|
21809
21929
|
},
|
|
21810
21930
|
cid: {
|
|
21811
21931
|
type: "string",
|
|
21812
|
-
format: "cid"
|
|
21932
|
+
format: "cid",
|
|
21933
|
+
description: "CID of the subject record (aka, specific version of record), to filter likes."
|
|
21813
21934
|
},
|
|
21814
21935
|
limit: {
|
|
21815
21936
|
type: "integer",
|
|
@@ -21876,14 +21997,15 @@ var schemaDict = {
|
|
|
21876
21997
|
defs: {
|
|
21877
21998
|
main: {
|
|
21878
21999
|
type: "query",
|
|
21879
|
-
description: "Get a
|
|
22000
|
+
description: "Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.",
|
|
21880
22001
|
parameters: {
|
|
21881
22002
|
type: "params",
|
|
21882
22003
|
required: ["list"],
|
|
21883
22004
|
properties: {
|
|
21884
22005
|
list: {
|
|
21885
22006
|
type: "string",
|
|
21886
|
-
format: "at-uri"
|
|
22007
|
+
format: "at-uri",
|
|
22008
|
+
description: "Reference (AT-URI) to the list record."
|
|
21887
22009
|
},
|
|
21888
22010
|
limit: {
|
|
21889
22011
|
type: "integer",
|
|
@@ -21929,23 +22051,26 @@ var schemaDict = {
|
|
|
21929
22051
|
defs: {
|
|
21930
22052
|
main: {
|
|
21931
22053
|
type: "query",
|
|
21932
|
-
description: "Get posts in a thread.",
|
|
22054
|
+
description: "Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.",
|
|
21933
22055
|
parameters: {
|
|
21934
22056
|
type: "params",
|
|
21935
22057
|
required: ["uri"],
|
|
21936
22058
|
properties: {
|
|
21937
22059
|
uri: {
|
|
21938
22060
|
type: "string",
|
|
21939
|
-
format: "at-uri"
|
|
22061
|
+
format: "at-uri",
|
|
22062
|
+
description: "Reference (AT-URI) to post record."
|
|
21940
22063
|
},
|
|
21941
22064
|
depth: {
|
|
21942
22065
|
type: "integer",
|
|
22066
|
+
description: "How many levels of reply depth should be included in response.",
|
|
21943
22067
|
default: 6,
|
|
21944
22068
|
minimum: 0,
|
|
21945
22069
|
maximum: 1e3
|
|
21946
22070
|
},
|
|
21947
22071
|
parentHeight: {
|
|
21948
22072
|
type: "integer",
|
|
22073
|
+
description: "How many levels of parent (and grandparent, etc) post to include.",
|
|
21949
22074
|
default: 80,
|
|
21950
22075
|
minimum: 0,
|
|
21951
22076
|
maximum: 1e3
|
|
@@ -21983,13 +22108,14 @@ var schemaDict = {
|
|
|
21983
22108
|
defs: {
|
|
21984
22109
|
main: {
|
|
21985
22110
|
type: "query",
|
|
21986
|
-
description: "
|
|
22111
|
+
description: "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
|
|
21987
22112
|
parameters: {
|
|
21988
22113
|
type: "params",
|
|
21989
22114
|
required: ["uris"],
|
|
21990
22115
|
properties: {
|
|
21991
22116
|
uris: {
|
|
21992
22117
|
type: "array",
|
|
22118
|
+
description: "List of post AT-URIs to return hydrated views for.",
|
|
21993
22119
|
items: {
|
|
21994
22120
|
type: "string",
|
|
21995
22121
|
format: "at-uri"
|
|
@@ -22023,18 +22149,20 @@ var schemaDict = {
|
|
|
22023
22149
|
defs: {
|
|
22024
22150
|
main: {
|
|
22025
22151
|
type: "query",
|
|
22026
|
-
description: "Get a list of reposts.",
|
|
22152
|
+
description: "Get a list of reposts for a given post.",
|
|
22027
22153
|
parameters: {
|
|
22028
22154
|
type: "params",
|
|
22029
22155
|
required: ["uri"],
|
|
22030
22156
|
properties: {
|
|
22031
22157
|
uri: {
|
|
22032
22158
|
type: "string",
|
|
22033
|
-
format: "at-uri"
|
|
22159
|
+
format: "at-uri",
|
|
22160
|
+
description: "Reference (AT-URI) of post record"
|
|
22034
22161
|
},
|
|
22035
22162
|
cid: {
|
|
22036
22163
|
type: "string",
|
|
22037
|
-
format: "cid"
|
|
22164
|
+
format: "cid",
|
|
22165
|
+
description: "If supplied, filters to reposts of specific version (by CID) of the post record."
|
|
22038
22166
|
},
|
|
22039
22167
|
limit: {
|
|
22040
22168
|
type: "integer",
|
|
@@ -22083,7 +22211,7 @@ var schemaDict = {
|
|
|
22083
22211
|
defs: {
|
|
22084
22212
|
main: {
|
|
22085
22213
|
type: "query",
|
|
22086
|
-
description: "Get a list of suggested feeds for the
|
|
22214
|
+
description: "Get a list of suggested feeds (feed generators) for the requesting account.",
|
|
22087
22215
|
parameters: {
|
|
22088
22216
|
type: "params",
|
|
22089
22217
|
properties: {
|
|
@@ -22126,12 +22254,13 @@ var schemaDict = {
|
|
|
22126
22254
|
defs: {
|
|
22127
22255
|
main: {
|
|
22128
22256
|
type: "query",
|
|
22129
|
-
description: "Get a view of the
|
|
22257
|
+
description: "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.",
|
|
22130
22258
|
parameters: {
|
|
22131
22259
|
type: "params",
|
|
22132
22260
|
properties: {
|
|
22133
22261
|
algorithm: {
|
|
22134
|
-
type: "string"
|
|
22262
|
+
type: "string",
|
|
22263
|
+
description: "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism."
|
|
22135
22264
|
},
|
|
22136
22265
|
limit: {
|
|
22137
22266
|
type: "integer",
|
|
@@ -22172,7 +22301,7 @@ var schemaDict = {
|
|
|
22172
22301
|
defs: {
|
|
22173
22302
|
main: {
|
|
22174
22303
|
type: "record",
|
|
22175
|
-
description: "
|
|
22304
|
+
description: "Record declaring a 'like' of a piece of subject content.",
|
|
22176
22305
|
key: "tid",
|
|
22177
22306
|
record: {
|
|
22178
22307
|
type: "object",
|
|
@@ -22197,7 +22326,7 @@ var schemaDict = {
|
|
|
22197
22326
|
defs: {
|
|
22198
22327
|
main: {
|
|
22199
22328
|
type: "record",
|
|
22200
|
-
description: "
|
|
22329
|
+
description: "Record containing a Bluesky post.",
|
|
22201
22330
|
key: "tid",
|
|
22202
22331
|
record: {
|
|
22203
22332
|
type: "object",
|
|
@@ -22206,11 +22335,12 @@ var schemaDict = {
|
|
|
22206
22335
|
text: {
|
|
22207
22336
|
type: "string",
|
|
22208
22337
|
maxLength: 3e3,
|
|
22209
|
-
maxGraphemes: 300
|
|
22338
|
+
maxGraphemes: 300,
|
|
22339
|
+
description: "The primary post content. May be an empty string, if there are embeds."
|
|
22210
22340
|
},
|
|
22211
22341
|
entities: {
|
|
22212
22342
|
type: "array",
|
|
22213
|
-
description: "
|
|
22343
|
+
description: "DEPRECATED: replaced by app.bsky.richtext.facet.",
|
|
22214
22344
|
items: {
|
|
22215
22345
|
type: "ref",
|
|
22216
22346
|
ref: "lex:app.bsky.feed.post#entity"
|
|
@@ -22218,6 +22348,7 @@ var schemaDict = {
|
|
|
22218
22348
|
},
|
|
22219
22349
|
facets: {
|
|
22220
22350
|
type: "array",
|
|
22351
|
+
description: "Annotations of text (mentions, URLs, hashtags, etc)",
|
|
22221
22352
|
items: {
|
|
22222
22353
|
type: "ref",
|
|
22223
22354
|
ref: "lex:app.bsky.richtext.facet"
|
|
@@ -22238,6 +22369,7 @@ var schemaDict = {
|
|
|
22238
22369
|
},
|
|
22239
22370
|
langs: {
|
|
22240
22371
|
type: "array",
|
|
22372
|
+
description: "Indicates human language of post primary text content.",
|
|
22241
22373
|
maxLength: 3,
|
|
22242
22374
|
items: {
|
|
22243
22375
|
type: "string",
|
|
@@ -22246,21 +22378,23 @@ var schemaDict = {
|
|
|
22246
22378
|
},
|
|
22247
22379
|
labels: {
|
|
22248
22380
|
type: "union",
|
|
22381
|
+
description: "Self-label values for this post. Effectively content warnings.",
|
|
22249
22382
|
refs: ["lex:com.atproto.label.defs#selfLabels"]
|
|
22250
22383
|
},
|
|
22251
22384
|
tags: {
|
|
22252
22385
|
type: "array",
|
|
22386
|
+
description: "Additional non-inline tags describing this post.",
|
|
22253
22387
|
maxLength: 8,
|
|
22254
22388
|
items: {
|
|
22255
22389
|
type: "string",
|
|
22256
22390
|
maxLength: 640,
|
|
22257
22391
|
maxGraphemes: 64
|
|
22258
|
-
}
|
|
22259
|
-
description: "Additional non-inline tags describing this post."
|
|
22392
|
+
}
|
|
22260
22393
|
},
|
|
22261
22394
|
createdAt: {
|
|
22262
22395
|
type: "string",
|
|
22263
|
-
format: "datetime"
|
|
22396
|
+
format: "datetime",
|
|
22397
|
+
description: "Client-declared timestamp when this post was originally created."
|
|
22264
22398
|
}
|
|
22265
22399
|
}
|
|
22266
22400
|
}
|
|
@@ -22319,7 +22453,7 @@ var schemaDict = {
|
|
|
22319
22453
|
id: "app.bsky.feed.repost",
|
|
22320
22454
|
defs: {
|
|
22321
22455
|
main: {
|
|
22322
|
-
description: "
|
|
22456
|
+
description: "Record representing a 'repost' of an existing Bluesky post.",
|
|
22323
22457
|
type: "record",
|
|
22324
22458
|
key: "tid",
|
|
22325
22459
|
record: {
|
|
@@ -22345,7 +22479,7 @@ var schemaDict = {
|
|
|
22345
22479
|
defs: {
|
|
22346
22480
|
main: {
|
|
22347
22481
|
type: "query",
|
|
22348
|
-
description: "Find posts matching search criteria.",
|
|
22482
|
+
description: "Find posts matching search criteria, returning views of those posts.",
|
|
22349
22483
|
parameters: {
|
|
22350
22484
|
type: "params",
|
|
22351
22485
|
required: ["q"],
|
|
@@ -22404,14 +22538,15 @@ var schemaDict = {
|
|
|
22404
22538
|
main: {
|
|
22405
22539
|
type: "record",
|
|
22406
22540
|
key: "tid",
|
|
22407
|
-
description: "
|
|
22541
|
+
description: "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository..",
|
|
22408
22542
|
record: {
|
|
22409
22543
|
type: "object",
|
|
22410
22544
|
required: ["post", "createdAt"],
|
|
22411
22545
|
properties: {
|
|
22412
22546
|
post: {
|
|
22413
22547
|
type: "string",
|
|
22414
|
-
format: "at-uri"
|
|
22548
|
+
format: "at-uri",
|
|
22549
|
+
description: "Reference (AT-URI) to the post record."
|
|
22415
22550
|
},
|
|
22416
22551
|
allow: {
|
|
22417
22552
|
type: "array",
|
|
@@ -22461,7 +22596,7 @@ var schemaDict = {
|
|
|
22461
22596
|
defs: {
|
|
22462
22597
|
main: {
|
|
22463
22598
|
type: "record",
|
|
22464
|
-
description: "
|
|
22599
|
+
description: "Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details.",
|
|
22465
22600
|
key: "tid",
|
|
22466
22601
|
record: {
|
|
22467
22602
|
type: "object",
|
|
@@ -22469,7 +22604,8 @@ var schemaDict = {
|
|
|
22469
22604
|
properties: {
|
|
22470
22605
|
subject: {
|
|
22471
22606
|
type: "string",
|
|
22472
|
-
format: "did"
|
|
22607
|
+
format: "did",
|
|
22608
|
+
description: "DID of the account to be blocked."
|
|
22473
22609
|
},
|
|
22474
22610
|
createdAt: {
|
|
22475
22611
|
type: "string",
|
|
@@ -22653,7 +22789,7 @@ var schemaDict = {
|
|
|
22653
22789
|
defs: {
|
|
22654
22790
|
main: {
|
|
22655
22791
|
type: "record",
|
|
22656
|
-
description: "
|
|
22792
|
+
description: "Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.",
|
|
22657
22793
|
key: "tid",
|
|
22658
22794
|
record: {
|
|
22659
22795
|
type: "object",
|
|
@@ -22678,7 +22814,7 @@ var schemaDict = {
|
|
|
22678
22814
|
defs: {
|
|
22679
22815
|
main: {
|
|
22680
22816
|
type: "query",
|
|
22681
|
-
description: "
|
|
22817
|
+
description: "Enumerates which accounts the requesting account is currently blocking. Requires auth.",
|
|
22682
22818
|
parameters: {
|
|
22683
22819
|
type: "params",
|
|
22684
22820
|
properties: {
|
|
@@ -22721,7 +22857,7 @@ var schemaDict = {
|
|
|
22721
22857
|
defs: {
|
|
22722
22858
|
main: {
|
|
22723
22859
|
type: "query",
|
|
22724
|
-
description: "
|
|
22860
|
+
description: "Enumerates accounts which follow a specified account (actor).",
|
|
22725
22861
|
parameters: {
|
|
22726
22862
|
type: "params",
|
|
22727
22863
|
required: ["actor"],
|
|
@@ -22773,7 +22909,7 @@ var schemaDict = {
|
|
|
22773
22909
|
defs: {
|
|
22774
22910
|
main: {
|
|
22775
22911
|
type: "query",
|
|
22776
|
-
description: "
|
|
22912
|
+
description: "Enumerates accounts which a specified account (actor) follows.",
|
|
22777
22913
|
parameters: {
|
|
22778
22914
|
type: "params",
|
|
22779
22915
|
required: ["actor"],
|
|
@@ -22825,14 +22961,15 @@ var schemaDict = {
|
|
|
22825
22961
|
defs: {
|
|
22826
22962
|
main: {
|
|
22827
22963
|
type: "query",
|
|
22828
|
-
description: "
|
|
22964
|
+
description: "Gets a 'view' (with additional context) of a specified list.",
|
|
22829
22965
|
parameters: {
|
|
22830
22966
|
type: "params",
|
|
22831
22967
|
required: ["list"],
|
|
22832
22968
|
properties: {
|
|
22833
22969
|
list: {
|
|
22834
22970
|
type: "string",
|
|
22835
|
-
format: "at-uri"
|
|
22971
|
+
format: "at-uri",
|
|
22972
|
+
description: "Reference (AT-URI) of the list record to hydrate."
|
|
22836
22973
|
},
|
|
22837
22974
|
limit: {
|
|
22838
22975
|
type: "integer",
|
|
@@ -22877,7 +23014,7 @@ var schemaDict = {
|
|
|
22877
23014
|
defs: {
|
|
22878
23015
|
main: {
|
|
22879
23016
|
type: "query",
|
|
22880
|
-
description: "Get lists that the actor is blocking.",
|
|
23017
|
+
description: "Get mod lists that the requesting account (actor) is blocking. Requires auth.",
|
|
22881
23018
|
parameters: {
|
|
22882
23019
|
type: "params",
|
|
22883
23020
|
properties: {
|
|
@@ -22920,7 +23057,7 @@ var schemaDict = {
|
|
|
22920
23057
|
defs: {
|
|
22921
23058
|
main: {
|
|
22922
23059
|
type: "query",
|
|
22923
|
-
description: "
|
|
23060
|
+
description: "Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.",
|
|
22924
23061
|
parameters: {
|
|
22925
23062
|
type: "params",
|
|
22926
23063
|
properties: {
|
|
@@ -22963,14 +23100,15 @@ var schemaDict = {
|
|
|
22963
23100
|
defs: {
|
|
22964
23101
|
main: {
|
|
22965
23102
|
type: "query",
|
|
22966
|
-
description: "
|
|
23103
|
+
description: "Enumerates the lists created by a specified account (actor).",
|
|
22967
23104
|
parameters: {
|
|
22968
23105
|
type: "params",
|
|
22969
23106
|
required: ["actor"],
|
|
22970
23107
|
properties: {
|
|
22971
23108
|
actor: {
|
|
22972
23109
|
type: "string",
|
|
22973
|
-
format: "at-identifier"
|
|
23110
|
+
format: "at-identifier",
|
|
23111
|
+
description: "The account (actor) to enumerate lists from."
|
|
22974
23112
|
},
|
|
22975
23113
|
limit: {
|
|
22976
23114
|
type: "integer",
|
|
@@ -23011,7 +23149,7 @@ var schemaDict = {
|
|
|
23011
23149
|
defs: {
|
|
23012
23150
|
main: {
|
|
23013
23151
|
type: "query",
|
|
23014
|
-
description: "
|
|
23152
|
+
description: "Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.",
|
|
23015
23153
|
parameters: {
|
|
23016
23154
|
type: "params",
|
|
23017
23155
|
properties: {
|
|
@@ -23054,17 +23192,19 @@ var schemaDict = {
|
|
|
23054
23192
|
defs: {
|
|
23055
23193
|
main: {
|
|
23056
23194
|
type: "query",
|
|
23057
|
-
description: "Enumerates public relationships between one account, and a list of other accounts",
|
|
23195
|
+
description: "Enumerates public relationships between one account, and a list of other accounts. Does not require auth.",
|
|
23058
23196
|
parameters: {
|
|
23059
23197
|
type: "params",
|
|
23060
23198
|
required: ["actor"],
|
|
23061
23199
|
properties: {
|
|
23062
23200
|
actor: {
|
|
23063
23201
|
type: "string",
|
|
23064
|
-
format: "at-identifier"
|
|
23202
|
+
format: "at-identifier",
|
|
23203
|
+
description: "Primary account requesting relationships for."
|
|
23065
23204
|
},
|
|
23066
23205
|
others: {
|
|
23067
23206
|
type: "array",
|
|
23207
|
+
description: "List of 'other' accounts to be related back to the primary.",
|
|
23068
23208
|
maxLength: 30,
|
|
23069
23209
|
items: {
|
|
23070
23210
|
type: "string",
|
|
@@ -23111,7 +23251,7 @@ var schemaDict = {
|
|
|
23111
23251
|
defs: {
|
|
23112
23252
|
main: {
|
|
23113
23253
|
type: "query",
|
|
23114
|
-
description: "
|
|
23254
|
+
description: "Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.",
|
|
23115
23255
|
parameters: {
|
|
23116
23256
|
type: "params",
|
|
23117
23257
|
required: ["actor"],
|
|
@@ -23147,7 +23287,7 @@ var schemaDict = {
|
|
|
23147
23287
|
defs: {
|
|
23148
23288
|
main: {
|
|
23149
23289
|
type: "record",
|
|
23150
|
-
description: "
|
|
23290
|
+
description: "Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists.",
|
|
23151
23291
|
key: "tid",
|
|
23152
23292
|
record: {
|
|
23153
23293
|
type: "object",
|
|
@@ -23155,12 +23295,14 @@ var schemaDict = {
|
|
|
23155
23295
|
properties: {
|
|
23156
23296
|
purpose: {
|
|
23157
23297
|
type: "ref",
|
|
23298
|
+
description: "Defines the purpose of the list (aka, moderation-oriented or curration-oriented)",
|
|
23158
23299
|
ref: "lex:app.bsky.graph.defs#listPurpose"
|
|
23159
23300
|
},
|
|
23160
23301
|
name: {
|
|
23161
23302
|
type: "string",
|
|
23162
23303
|
maxLength: 64,
|
|
23163
|
-
minLength: 1
|
|
23304
|
+
minLength: 1,
|
|
23305
|
+
description: "Display name for list; can not be empty."
|
|
23164
23306
|
},
|
|
23165
23307
|
description: {
|
|
23166
23308
|
type: "string",
|
|
@@ -23198,7 +23340,7 @@ var schemaDict = {
|
|
|
23198
23340
|
defs: {
|
|
23199
23341
|
main: {
|
|
23200
23342
|
type: "record",
|
|
23201
|
-
description: "
|
|
23343
|
+
description: "Record representing a block relationship against an entire an entire list of accounts (actors).",
|
|
23202
23344
|
key: "tid",
|
|
23203
23345
|
record: {
|
|
23204
23346
|
type: "object",
|
|
@@ -23206,7 +23348,8 @@ var schemaDict = {
|
|
|
23206
23348
|
properties: {
|
|
23207
23349
|
subject: {
|
|
23208
23350
|
type: "string",
|
|
23209
|
-
format: "at-uri"
|
|
23351
|
+
format: "at-uri",
|
|
23352
|
+
description: "Reference (AT-URI) to the mod list record."
|
|
23210
23353
|
},
|
|
23211
23354
|
createdAt: {
|
|
23212
23355
|
type: "string",
|
|
@@ -23223,7 +23366,7 @@ var schemaDict = {
|
|
|
23223
23366
|
defs: {
|
|
23224
23367
|
main: {
|
|
23225
23368
|
type: "record",
|
|
23226
|
-
description: "
|
|
23369
|
+
description: "Record representing an account's inclusion on a specific list. The AppView will ignore duplicate listitem records.",
|
|
23227
23370
|
key: "tid",
|
|
23228
23371
|
record: {
|
|
23229
23372
|
type: "object",
|
|
@@ -23231,11 +23374,13 @@ var schemaDict = {
|
|
|
23231
23374
|
properties: {
|
|
23232
23375
|
subject: {
|
|
23233
23376
|
type: "string",
|
|
23234
|
-
format: "did"
|
|
23377
|
+
format: "did",
|
|
23378
|
+
description: "The account which is included on the list."
|
|
23235
23379
|
},
|
|
23236
23380
|
list: {
|
|
23237
23381
|
type: "string",
|
|
23238
|
-
format: "at-uri"
|
|
23382
|
+
format: "at-uri",
|
|
23383
|
+
description: "Reference (AT-URI) to the list record (app.bsky.graph.list)."
|
|
23239
23384
|
},
|
|
23240
23385
|
createdAt: {
|
|
23241
23386
|
type: "string",
|
|
@@ -23252,7 +23397,7 @@ var schemaDict = {
|
|
|
23252
23397
|
defs: {
|
|
23253
23398
|
main: {
|
|
23254
23399
|
type: "procedure",
|
|
23255
|
-
description: "
|
|
23400
|
+
description: "Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth.",
|
|
23256
23401
|
input: {
|
|
23257
23402
|
encoding: "application/json",
|
|
23258
23403
|
schema: {
|
|
@@ -23275,7 +23420,7 @@ var schemaDict = {
|
|
|
23275
23420
|
defs: {
|
|
23276
23421
|
main: {
|
|
23277
23422
|
type: "procedure",
|
|
23278
|
-
description: "
|
|
23423
|
+
description: "Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.",
|
|
23279
23424
|
input: {
|
|
23280
23425
|
encoding: "application/json",
|
|
23281
23426
|
schema: {
|
|
@@ -23298,7 +23443,7 @@ var schemaDict = {
|
|
|
23298
23443
|
defs: {
|
|
23299
23444
|
main: {
|
|
23300
23445
|
type: "procedure",
|
|
23301
|
-
description: "
|
|
23446
|
+
description: "Unmutes the specified account. Requires auth.",
|
|
23302
23447
|
input: {
|
|
23303
23448
|
encoding: "application/json",
|
|
23304
23449
|
schema: {
|
|
@@ -23321,7 +23466,7 @@ var schemaDict = {
|
|
|
23321
23466
|
defs: {
|
|
23322
23467
|
main: {
|
|
23323
23468
|
type: "procedure",
|
|
23324
|
-
description: "
|
|
23469
|
+
description: "Unmutes the specified list of accounts. Requires auth.",
|
|
23325
23470
|
input: {
|
|
23326
23471
|
encoding: "application/json",
|
|
23327
23472
|
schema: {
|
|
@@ -23344,7 +23489,7 @@ var schemaDict = {
|
|
|
23344
23489
|
defs: {
|
|
23345
23490
|
main: {
|
|
23346
23491
|
type: "query",
|
|
23347
|
-
description: "
|
|
23492
|
+
description: "Count the number of unread notifications for the requesting account. Requires auth.",
|
|
23348
23493
|
parameters: {
|
|
23349
23494
|
type: "params",
|
|
23350
23495
|
properties: {
|
|
@@ -23375,7 +23520,7 @@ var schemaDict = {
|
|
|
23375
23520
|
defs: {
|
|
23376
23521
|
main: {
|
|
23377
23522
|
type: "query",
|
|
23378
|
-
description: "
|
|
23523
|
+
description: "Enumerate notifications for the requesting account. Requires auth.",
|
|
23379
23524
|
parameters: {
|
|
23380
23525
|
type: "params",
|
|
23381
23526
|
properties: {
|
|
@@ -23485,7 +23630,7 @@ var schemaDict = {
|
|
|
23485
23630
|
defs: {
|
|
23486
23631
|
main: {
|
|
23487
23632
|
type: "procedure",
|
|
23488
|
-
description: "Register
|
|
23633
|
+
description: "Register to receive push notifications, via a specified service, for the requesting account. Requires auth.",
|
|
23489
23634
|
input: {
|
|
23490
23635
|
encoding: "application/json",
|
|
23491
23636
|
schema: {
|
|
@@ -23518,7 +23663,7 @@ var schemaDict = {
|
|
|
23518
23663
|
defs: {
|
|
23519
23664
|
main: {
|
|
23520
23665
|
type: "procedure",
|
|
23521
|
-
description: "Notify server that the
|
|
23666
|
+
description: "Notify server that the requesting account has seen notifications. Requires auth.",
|
|
23522
23667
|
input: {
|
|
23523
23668
|
encoding: "application/json",
|
|
23524
23669
|
schema: {
|
|
@@ -23541,6 +23686,7 @@ var schemaDict = {
|
|
|
23541
23686
|
defs: {
|
|
23542
23687
|
main: {
|
|
23543
23688
|
type: "object",
|
|
23689
|
+
description: "Annotation of a sub-string within rich text.",
|
|
23544
23690
|
required: ["index", "features"],
|
|
23545
23691
|
properties: {
|
|
23546
23692
|
index: {
|
|
@@ -23562,7 +23708,7 @@ var schemaDict = {
|
|
|
23562
23708
|
},
|
|
23563
23709
|
mention: {
|
|
23564
23710
|
type: "object",
|
|
23565
|
-
description: "
|
|
23711
|
+
description: "Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.",
|
|
23566
23712
|
required: ["did"],
|
|
23567
23713
|
properties: {
|
|
23568
23714
|
did: {
|
|
@@ -23573,7 +23719,7 @@ var schemaDict = {
|
|
|
23573
23719
|
},
|
|
23574
23720
|
link: {
|
|
23575
23721
|
type: "object",
|
|
23576
|
-
description: "
|
|
23722
|
+
description: "Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.",
|
|
23577
23723
|
required: ["uri"],
|
|
23578
23724
|
properties: {
|
|
23579
23725
|
uri: {
|
|
@@ -23584,7 +23730,7 @@ var schemaDict = {
|
|
|
23584
23730
|
},
|
|
23585
23731
|
tag: {
|
|
23586
23732
|
type: "object",
|
|
23587
|
-
description: "
|
|
23733
|
+
description: "Facet feature for a hashtag. The text usually includes a '#' prefix, but the facet reference should not (except in the case of 'double hash tags').",
|
|
23588
23734
|
required: ["tag"],
|
|
23589
23735
|
properties: {
|
|
23590
23736
|
tag: {
|
|
@@ -23596,7 +23742,7 @@ var schemaDict = {
|
|
|
23596
23742
|
},
|
|
23597
23743
|
byteSlice: {
|
|
23598
23744
|
type: "object",
|
|
23599
|
-
description: "
|
|
23745
|
+
description: "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.",
|
|
23600
23746
|
required: ["byteStart", "byteEnd"],
|
|
23601
23747
|
properties: {
|
|
23602
23748
|
byteStart: {
|
|
@@ -25701,6 +25847,7 @@ __export(defs_exports, {
|
|
|
25701
25847
|
isModEventReport: () => isModEventReport,
|
|
25702
25848
|
isModEventResolveAppeal: () => isModEventResolveAppeal,
|
|
25703
25849
|
isModEventReverseTakedown: () => isModEventReverseTakedown,
|
|
25850
|
+
isModEventTag: () => isModEventTag,
|
|
25704
25851
|
isModEventTakedown: () => isModEventTakedown,
|
|
25705
25852
|
isModEventUnmute: () => isModEventUnmute,
|
|
25706
25853
|
isModEventView: () => isModEventView,
|
|
@@ -25733,6 +25880,7 @@ __export(defs_exports, {
|
|
|
25733
25880
|
validateModEventReport: () => validateModEventReport,
|
|
25734
25881
|
validateModEventResolveAppeal: () => validateModEventResolveAppeal,
|
|
25735
25882
|
validateModEventReverseTakedown: () => validateModEventReverseTakedown,
|
|
25883
|
+
validateModEventTag: () => validateModEventTag,
|
|
25736
25884
|
validateModEventTakedown: () => validateModEventTakedown,
|
|
25737
25885
|
validateModEventUnmute: () => validateModEventUnmute,
|
|
25738
25886
|
validateModEventView: () => validateModEventView,
|
|
@@ -25942,6 +26090,12 @@ function isModEventEmail(v) {
|
|
|
25942
26090
|
function validateModEventEmail(v) {
|
|
25943
26091
|
return lexicons.validate("com.atproto.admin.defs#modEventEmail", v);
|
|
25944
26092
|
}
|
|
26093
|
+
function isModEventTag(v) {
|
|
26094
|
+
return isObj2(v) && hasProp2(v, "$type") && v.$type === "com.atproto.admin.defs#modEventTag";
|
|
26095
|
+
}
|
|
26096
|
+
function validateModEventTag(v) {
|
|
26097
|
+
return lexicons.validate("com.atproto.admin.defs#modEventTag", v);
|
|
26098
|
+
}
|
|
25945
26099
|
function isCommunicationTemplateView(v) {
|
|
25946
26100
|
return isObj2(v) && hasProp2(v, "$type") && v.$type === "com.atproto.admin.defs#communicationTemplateView";
|
|
25947
26101
|
}
|