@atproto/api 0.9.5 → 0.9.7
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/LICENSE.txt +1 -1
- package/dist/client/index.d.ts +0 -3
- package/dist/client/lexicons.d.ts +134 -52
- package/dist/client/types/app/bsky/actor/defs.d.ts +1 -0
- package/dist/client/types/com/atproto/admin/defs.d.ts +2 -2
- package/dist/client/types/com/atproto/admin/queryModerationEvents.d.ts +7 -0
- package/dist/index.js +315 -260
- package/dist/index.js.map +3 -3
- package/package.json +2 -2
- package/src/client/index.ts +0 -13
- package/src/client/lexicons.ts +382 -173
- 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 +2 -0
- package/src/client/types/com/atproto/admin/queryModerationEvents.ts +13 -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/client/types/app/bsky/unspecced/getTimelineSkeleton.d.ts +0 -24
- package/src/client/types/app/bsky/unspecced/getTimelineSkeleton.ts +0 -45
package/dist/index.js
CHANGED
|
@@ -8940,7 +8940,6 @@ __export(src_exports2, {
|
|
|
8940
8940
|
AppBskyUnspeccedDefs: () => defs_exports8,
|
|
8941
8941
|
AppBskyUnspeccedGetPopularFeedGenerators: () => getPopularFeedGenerators_exports,
|
|
8942
8942
|
AppBskyUnspeccedGetTaggedSuggestions: () => getTaggedSuggestions_exports,
|
|
8943
|
-
AppBskyUnspeccedGetTimelineSkeleton: () => getTimelineSkeleton_exports,
|
|
8944
8943
|
AppBskyUnspeccedNS: () => AppBskyUnspeccedNS,
|
|
8945
8944
|
AppBskyUnspeccedSearchActorsSkeleton: () => searchActorsSkeleton_exports,
|
|
8946
8945
|
AppBskyUnspeccedSearchPostsSkeleton: () => searchPostsSkeleton_exports,
|
|
@@ -15766,7 +15765,8 @@ var schemaDict = {
|
|
|
15766
15765
|
"lex:com.atproto.admin.defs#modEventAcknowledge",
|
|
15767
15766
|
"lex:com.atproto.admin.defs#modEventEscalate",
|
|
15768
15767
|
"lex:com.atproto.admin.defs#modEventMute",
|
|
15769
|
-
"lex:com.atproto.admin.defs#modEventEmail"
|
|
15768
|
+
"lex:com.atproto.admin.defs#modEventEmail",
|
|
15769
|
+
"lex:com.atproto.admin.defs#modEventResolveAppeal"
|
|
15770
15770
|
]
|
|
15771
15771
|
},
|
|
15772
15772
|
subject: {
|
|
@@ -15823,6 +15823,7 @@ var schemaDict = {
|
|
|
15823
15823
|
"lex:com.atproto.admin.defs#modEventAcknowledge",
|
|
15824
15824
|
"lex:com.atproto.admin.defs#modEventEscalate",
|
|
15825
15825
|
"lex:com.atproto.admin.defs#modEventMute",
|
|
15826
|
+
"lex:com.atproto.admin.defs#modEventEmail",
|
|
15826
15827
|
"lex:com.atproto.admin.defs#modEventResolveAppeal"
|
|
15827
15828
|
]
|
|
15828
15829
|
},
|
|
@@ -17112,6 +17113,16 @@ var schemaDict = {
|
|
|
17112
17113
|
enum: ["asc", "desc"],
|
|
17113
17114
|
description: "Sort direction for the events. Defaults to descending order of created at timestamp."
|
|
17114
17115
|
},
|
|
17116
|
+
createdAfter: {
|
|
17117
|
+
type: "string",
|
|
17118
|
+
format: "datetime",
|
|
17119
|
+
description: "Retrieve events created after a given timestamp"
|
|
17120
|
+
},
|
|
17121
|
+
createdBefore: {
|
|
17122
|
+
type: "string",
|
|
17123
|
+
format: "datetime",
|
|
17124
|
+
description: "Retrieve events created before a given timestamp"
|
|
17125
|
+
},
|
|
17115
17126
|
subject: {
|
|
17116
17127
|
type: "string",
|
|
17117
17128
|
format: "uri"
|
|
@@ -17127,6 +17138,34 @@ var schemaDict = {
|
|
|
17127
17138
|
maximum: 100,
|
|
17128
17139
|
default: 50
|
|
17129
17140
|
},
|
|
17141
|
+
hasComment: {
|
|
17142
|
+
type: "boolean",
|
|
17143
|
+
description: "If true, only events with comments are returned"
|
|
17144
|
+
},
|
|
17145
|
+
comment: {
|
|
17146
|
+
type: "string",
|
|
17147
|
+
description: "If specified, only events with comments containing the keyword are returned"
|
|
17148
|
+
},
|
|
17149
|
+
addedLabels: {
|
|
17150
|
+
type: "array",
|
|
17151
|
+
items: {
|
|
17152
|
+
type: "string"
|
|
17153
|
+
},
|
|
17154
|
+
description: "If specified, only events where all of these labels were added are returned"
|
|
17155
|
+
},
|
|
17156
|
+
removedLabels: {
|
|
17157
|
+
type: "array",
|
|
17158
|
+
items: {
|
|
17159
|
+
type: "string"
|
|
17160
|
+
},
|
|
17161
|
+
description: "If specified, only events where all of these labels were removed are returned"
|
|
17162
|
+
},
|
|
17163
|
+
reportTypes: {
|
|
17164
|
+
type: "array",
|
|
17165
|
+
items: {
|
|
17166
|
+
type: "string"
|
|
17167
|
+
}
|
|
17168
|
+
},
|
|
17130
17169
|
cursor: {
|
|
17131
17170
|
type: "string"
|
|
17132
17171
|
}
|
|
@@ -17524,7 +17563,7 @@ var schemaDict = {
|
|
|
17524
17563
|
defs: {
|
|
17525
17564
|
main: {
|
|
17526
17565
|
type: "query",
|
|
17527
|
-
description: "
|
|
17566
|
+
description: "Resolves a handle (domain name) to a DID.",
|
|
17528
17567
|
parameters: {
|
|
17529
17568
|
type: "params",
|
|
17530
17569
|
required: ["handle"],
|
|
@@ -17558,7 +17597,7 @@ var schemaDict = {
|
|
|
17558
17597
|
defs: {
|
|
17559
17598
|
main: {
|
|
17560
17599
|
type: "procedure",
|
|
17561
|
-
description: "Updates the handle
|
|
17600
|
+
description: "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.",
|
|
17562
17601
|
input: {
|
|
17563
17602
|
encoding: "application/json",
|
|
17564
17603
|
schema: {
|
|
@@ -17567,7 +17606,8 @@ var schemaDict = {
|
|
|
17567
17606
|
properties: {
|
|
17568
17607
|
handle: {
|
|
17569
17608
|
type: "string",
|
|
17570
|
-
format: "handle"
|
|
17609
|
+
format: "handle",
|
|
17610
|
+
description: "The new handle."
|
|
17571
17611
|
}
|
|
17572
17612
|
}
|
|
17573
17613
|
}
|
|
@@ -17650,7 +17690,7 @@ var schemaDict = {
|
|
|
17650
17690
|
defs: {
|
|
17651
17691
|
main: {
|
|
17652
17692
|
type: "query",
|
|
17653
|
-
description: "Find labels relevant to the provided URI patterns.",
|
|
17693
|
+
description: "Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.",
|
|
17654
17694
|
parameters: {
|
|
17655
17695
|
type: "params",
|
|
17656
17696
|
required: ["uriPatterns"],
|
|
@@ -17709,13 +17749,13 @@ var schemaDict = {
|
|
|
17709
17749
|
defs: {
|
|
17710
17750
|
main: {
|
|
17711
17751
|
type: "subscription",
|
|
17712
|
-
description: "Subscribe to
|
|
17752
|
+
description: "Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.",
|
|
17713
17753
|
parameters: {
|
|
17714
17754
|
type: "params",
|
|
17715
17755
|
properties: {
|
|
17716
17756
|
cursor: {
|
|
17717
17757
|
type: "integer",
|
|
17718
|
-
description: "The last known event to backfill from."
|
|
17758
|
+
description: "The last known event seq number to backfill from."
|
|
17719
17759
|
}
|
|
17720
17760
|
}
|
|
17721
17761
|
},
|
|
@@ -17771,7 +17811,7 @@ var schemaDict = {
|
|
|
17771
17811
|
defs: {
|
|
17772
17812
|
main: {
|
|
17773
17813
|
type: "procedure",
|
|
17774
|
-
description: "
|
|
17814
|
+
description: "Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.",
|
|
17775
17815
|
input: {
|
|
17776
17816
|
encoding: "application/json",
|
|
17777
17817
|
schema: {
|
|
@@ -17780,10 +17820,12 @@ var schemaDict = {
|
|
|
17780
17820
|
properties: {
|
|
17781
17821
|
reasonType: {
|
|
17782
17822
|
type: "ref",
|
|
17823
|
+
description: "Indicates the broad category of violation the report is for.",
|
|
17783
17824
|
ref: "lex:com.atproto.moderation.defs#reasonType"
|
|
17784
17825
|
},
|
|
17785
17826
|
reason: {
|
|
17786
|
-
type: "string"
|
|
17827
|
+
type: "string",
|
|
17828
|
+
description: "Additional context about the content and violation."
|
|
17787
17829
|
},
|
|
17788
17830
|
subject: {
|
|
17789
17831
|
type: "union",
|
|
@@ -17892,7 +17934,7 @@ var schemaDict = {
|
|
|
17892
17934
|
defs: {
|
|
17893
17935
|
main: {
|
|
17894
17936
|
type: "procedure",
|
|
17895
|
-
description: "Apply a batch transaction of creates, updates, and deletes.",
|
|
17937
|
+
description: "Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.",
|
|
17896
17938
|
input: {
|
|
17897
17939
|
encoding: "application/json",
|
|
17898
17940
|
schema: {
|
|
@@ -17902,12 +17944,12 @@ var schemaDict = {
|
|
|
17902
17944
|
repo: {
|
|
17903
17945
|
type: "string",
|
|
17904
17946
|
format: "at-identifier",
|
|
17905
|
-
description: "The handle or DID of the repo."
|
|
17947
|
+
description: "The handle or DID of the repo (aka, current account)."
|
|
17906
17948
|
},
|
|
17907
17949
|
validate: {
|
|
17908
17950
|
type: "boolean",
|
|
17909
17951
|
default: true,
|
|
17910
|
-
description: "
|
|
17952
|
+
description: "Can be set to 'false' to skip Lexicon schema validation of record data, for all operations."
|
|
17911
17953
|
},
|
|
17912
17954
|
writes: {
|
|
17913
17955
|
type: "array",
|
|
@@ -17923,6 +17965,7 @@ var schemaDict = {
|
|
|
17923
17965
|
},
|
|
17924
17966
|
swapCommit: {
|
|
17925
17967
|
type: "string",
|
|
17968
|
+
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.",
|
|
17926
17969
|
format: "cid"
|
|
17927
17970
|
}
|
|
17928
17971
|
}
|
|
@@ -17930,13 +17973,14 @@ var schemaDict = {
|
|
|
17930
17973
|
},
|
|
17931
17974
|
errors: [
|
|
17932
17975
|
{
|
|
17933
|
-
name: "InvalidSwap"
|
|
17976
|
+
name: "InvalidSwap",
|
|
17977
|
+
description: "Indicates that the 'swapCommit' parameter did not match current commit."
|
|
17934
17978
|
}
|
|
17935
17979
|
]
|
|
17936
17980
|
},
|
|
17937
17981
|
create: {
|
|
17938
17982
|
type: "object",
|
|
17939
|
-
description: "
|
|
17983
|
+
description: "Operation which creates a new record.",
|
|
17940
17984
|
required: ["collection", "value"],
|
|
17941
17985
|
properties: {
|
|
17942
17986
|
collection: {
|
|
@@ -17954,7 +17998,7 @@ var schemaDict = {
|
|
|
17954
17998
|
},
|
|
17955
17999
|
update: {
|
|
17956
18000
|
type: "object",
|
|
17957
|
-
description: "
|
|
18001
|
+
description: "Operation which updates an existing record.",
|
|
17958
18002
|
required: ["collection", "rkey", "value"],
|
|
17959
18003
|
properties: {
|
|
17960
18004
|
collection: {
|
|
@@ -17971,7 +18015,7 @@ var schemaDict = {
|
|
|
17971
18015
|
},
|
|
17972
18016
|
delete: {
|
|
17973
18017
|
type: "object",
|
|
17974
|
-
description: "
|
|
18018
|
+
description: "Operation which deletes an existing record.",
|
|
17975
18019
|
required: ["collection", "rkey"],
|
|
17976
18020
|
properties: {
|
|
17977
18021
|
collection: {
|
|
@@ -17991,7 +18035,7 @@ var schemaDict = {
|
|
|
17991
18035
|
defs: {
|
|
17992
18036
|
main: {
|
|
17993
18037
|
type: "procedure",
|
|
17994
|
-
description: "Create a new record.",
|
|
18038
|
+
description: "Create a single new repository record. Requires auth, implemented by PDS.",
|
|
17995
18039
|
input: {
|
|
17996
18040
|
encoding: "application/json",
|
|
17997
18041
|
schema: {
|
|
@@ -18001,7 +18045,7 @@ var schemaDict = {
|
|
|
18001
18045
|
repo: {
|
|
18002
18046
|
type: "string",
|
|
18003
18047
|
format: "at-identifier",
|
|
18004
|
-
description: "The handle or DID of the repo."
|
|
18048
|
+
description: "The handle or DID of the repo (aka, current account)."
|
|
18005
18049
|
},
|
|
18006
18050
|
collection: {
|
|
18007
18051
|
type: "string",
|
|
@@ -18010,17 +18054,17 @@ var schemaDict = {
|
|
|
18010
18054
|
},
|
|
18011
18055
|
rkey: {
|
|
18012
18056
|
type: "string",
|
|
18013
|
-
description: "The
|
|
18057
|
+
description: "The Record Key.",
|
|
18014
18058
|
maxLength: 15
|
|
18015
18059
|
},
|
|
18016
18060
|
validate: {
|
|
18017
18061
|
type: "boolean",
|
|
18018
18062
|
default: true,
|
|
18019
|
-
description: "
|
|
18063
|
+
description: "Can be set to 'false' to skip Lexicon schema validation of record data."
|
|
18020
18064
|
},
|
|
18021
18065
|
record: {
|
|
18022
18066
|
type: "unknown",
|
|
18023
|
-
description: "The record
|
|
18067
|
+
description: "The record itself. Must contain a $type field."
|
|
18024
18068
|
},
|
|
18025
18069
|
swapCommit: {
|
|
18026
18070
|
type: "string",
|
|
@@ -18049,7 +18093,8 @@ var schemaDict = {
|
|
|
18049
18093
|
},
|
|
18050
18094
|
errors: [
|
|
18051
18095
|
{
|
|
18052
|
-
name: "InvalidSwap"
|
|
18096
|
+
name: "InvalidSwap",
|
|
18097
|
+
description: "Indicates that 'swapCommit' didn't match current repo commit."
|
|
18053
18098
|
}
|
|
18054
18099
|
]
|
|
18055
18100
|
}
|
|
@@ -18061,7 +18106,7 @@ var schemaDict = {
|
|
|
18061
18106
|
defs: {
|
|
18062
18107
|
main: {
|
|
18063
18108
|
type: "procedure",
|
|
18064
|
-
description: "Delete a record, or ensure it doesn't exist.",
|
|
18109
|
+
description: "Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
|
|
18065
18110
|
input: {
|
|
18066
18111
|
encoding: "application/json",
|
|
18067
18112
|
schema: {
|
|
@@ -18071,7 +18116,7 @@ var schemaDict = {
|
|
|
18071
18116
|
repo: {
|
|
18072
18117
|
type: "string",
|
|
18073
18118
|
format: "at-identifier",
|
|
18074
|
-
description: "The handle or DID of the repo."
|
|
18119
|
+
description: "The handle or DID of the repo (aka, current account)."
|
|
18075
18120
|
},
|
|
18076
18121
|
collection: {
|
|
18077
18122
|
type: "string",
|
|
@@ -18080,7 +18125,7 @@ var schemaDict = {
|
|
|
18080
18125
|
},
|
|
18081
18126
|
rkey: {
|
|
18082
18127
|
type: "string",
|
|
18083
|
-
description: "The
|
|
18128
|
+
description: "The Record Key."
|
|
18084
18129
|
},
|
|
18085
18130
|
swapRecord: {
|
|
18086
18131
|
type: "string",
|
|
@@ -18109,7 +18154,7 @@ var schemaDict = {
|
|
|
18109
18154
|
defs: {
|
|
18110
18155
|
main: {
|
|
18111
18156
|
type: "query",
|
|
18112
|
-
description: "Get information about
|
|
18157
|
+
description: "Get information about an account and repository, including the list of collections. Does not require auth.",
|
|
18113
18158
|
parameters: {
|
|
18114
18159
|
type: "params",
|
|
18115
18160
|
required: ["repo"],
|
|
@@ -18142,17 +18187,20 @@ var schemaDict = {
|
|
|
18142
18187
|
format: "did"
|
|
18143
18188
|
},
|
|
18144
18189
|
didDoc: {
|
|
18145
|
-
type: "unknown"
|
|
18190
|
+
type: "unknown",
|
|
18191
|
+
description: "The complete DID document for this account."
|
|
18146
18192
|
},
|
|
18147
18193
|
collections: {
|
|
18148
18194
|
type: "array",
|
|
18195
|
+
description: "List of all the collections (NSIDs) for which this repo contains at least one record.",
|
|
18149
18196
|
items: {
|
|
18150
18197
|
type: "string",
|
|
18151
18198
|
format: "nsid"
|
|
18152
18199
|
}
|
|
18153
18200
|
},
|
|
18154
18201
|
handleIsCorrect: {
|
|
18155
|
-
type: "boolean"
|
|
18202
|
+
type: "boolean",
|
|
18203
|
+
description: "Indicates if handle is currently valid (resolves bi-directionally)"
|
|
18156
18204
|
}
|
|
18157
18205
|
}
|
|
18158
18206
|
}
|
|
@@ -18166,7 +18214,7 @@ var schemaDict = {
|
|
|
18166
18214
|
defs: {
|
|
18167
18215
|
main: {
|
|
18168
18216
|
type: "query",
|
|
18169
|
-
description: "Get a record.",
|
|
18217
|
+
description: "Get a single record from a repository. Does not require auth.",
|
|
18170
18218
|
parameters: {
|
|
18171
18219
|
type: "params",
|
|
18172
18220
|
required: ["repo", "collection", "rkey"],
|
|
@@ -18183,7 +18231,7 @@ var schemaDict = {
|
|
|
18183
18231
|
},
|
|
18184
18232
|
rkey: {
|
|
18185
18233
|
type: "string",
|
|
18186
|
-
description: "The
|
|
18234
|
+
description: "The Record Key."
|
|
18187
18235
|
},
|
|
18188
18236
|
cid: {
|
|
18189
18237
|
type: "string",
|
|
@@ -18221,7 +18269,7 @@ var schemaDict = {
|
|
|
18221
18269
|
defs: {
|
|
18222
18270
|
main: {
|
|
18223
18271
|
type: "query",
|
|
18224
|
-
description: "List a range of records in a collection.",
|
|
18272
|
+
description: "List a range of records in a repository, matching a specific collection. Does not require auth.",
|
|
18225
18273
|
parameters: {
|
|
18226
18274
|
type: "params",
|
|
18227
18275
|
required: ["repo", "collection"],
|
|
@@ -18305,7 +18353,7 @@ var schemaDict = {
|
|
|
18305
18353
|
defs: {
|
|
18306
18354
|
main: {
|
|
18307
18355
|
type: "procedure",
|
|
18308
|
-
description: "Write a record, creating or updating it as needed.",
|
|
18356
|
+
description: "Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.",
|
|
18309
18357
|
input: {
|
|
18310
18358
|
encoding: "application/json",
|
|
18311
18359
|
schema: {
|
|
@@ -18316,7 +18364,7 @@ var schemaDict = {
|
|
|
18316
18364
|
repo: {
|
|
18317
18365
|
type: "string",
|
|
18318
18366
|
format: "at-identifier",
|
|
18319
|
-
description: "The handle or DID of the repo."
|
|
18367
|
+
description: "The handle or DID of the repo (aka, current account)."
|
|
18320
18368
|
},
|
|
18321
18369
|
collection: {
|
|
18322
18370
|
type: "string",
|
|
@@ -18325,13 +18373,13 @@ var schemaDict = {
|
|
|
18325
18373
|
},
|
|
18326
18374
|
rkey: {
|
|
18327
18375
|
type: "string",
|
|
18328
|
-
description: "The
|
|
18376
|
+
description: "The Record Key.",
|
|
18329
18377
|
maxLength: 15
|
|
18330
18378
|
},
|
|
18331
18379
|
validate: {
|
|
18332
18380
|
type: "boolean",
|
|
18333
18381
|
default: true,
|
|
18334
|
-
description: "
|
|
18382
|
+
description: "Can be set to 'false' to skip Lexicon schema validation of record data."
|
|
18335
18383
|
},
|
|
18336
18384
|
record: {
|
|
18337
18385
|
type: "unknown",
|
|
@@ -18340,7 +18388,7 @@ var schemaDict = {
|
|
|
18340
18388
|
swapRecord: {
|
|
18341
18389
|
type: "string",
|
|
18342
18390
|
format: "cid",
|
|
18343
|
-
description: "Compare and swap with the previous record by CID."
|
|
18391
|
+
description: "Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation"
|
|
18344
18392
|
},
|
|
18345
18393
|
swapCommit: {
|
|
18346
18394
|
type: "string",
|
|
@@ -18402,7 +18450,7 @@ var schemaDict = {
|
|
|
18402
18450
|
defs: {
|
|
18403
18451
|
main: {
|
|
18404
18452
|
type: "procedure",
|
|
18405
|
-
description: "Upload a new blob to be
|
|
18453
|
+
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.",
|
|
18406
18454
|
input: {
|
|
18407
18455
|
encoding: "*/*"
|
|
18408
18456
|
},
|
|
@@ -18466,7 +18514,7 @@ var schemaDict = {
|
|
|
18466
18514
|
defs: {
|
|
18467
18515
|
main: {
|
|
18468
18516
|
type: "procedure",
|
|
18469
|
-
description: "Create an account.",
|
|
18517
|
+
description: "Create an account. Implemented by PDS.",
|
|
18470
18518
|
input: {
|
|
18471
18519
|
encoding: "application/json",
|
|
18472
18520
|
schema: {
|
|
@@ -18478,11 +18526,13 @@ var schemaDict = {
|
|
|
18478
18526
|
},
|
|
18479
18527
|
handle: {
|
|
18480
18528
|
type: "string",
|
|
18481
|
-
format: "handle"
|
|
18529
|
+
format: "handle",
|
|
18530
|
+
description: "Requested handle for the account."
|
|
18482
18531
|
},
|
|
18483
18532
|
did: {
|
|
18484
18533
|
type: "string",
|
|
18485
|
-
format: "did"
|
|
18534
|
+
format: "did",
|
|
18535
|
+
description: "Pre-existing atproto DID, being imported to a new account."
|
|
18486
18536
|
},
|
|
18487
18537
|
inviteCode: {
|
|
18488
18538
|
type: "string"
|
|
@@ -18494,13 +18544,16 @@ var schemaDict = {
|
|
|
18494
18544
|
type: "string"
|
|
18495
18545
|
},
|
|
18496
18546
|
password: {
|
|
18497
|
-
type: "string"
|
|
18547
|
+
type: "string",
|
|
18548
|
+
description: "Initial account password. May need to meet instance-specific password strength requirements."
|
|
18498
18549
|
},
|
|
18499
18550
|
recoveryKey: {
|
|
18500
|
-
type: "string"
|
|
18551
|
+
type: "string",
|
|
18552
|
+
description: "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation."
|
|
18501
18553
|
},
|
|
18502
18554
|
plcOp: {
|
|
18503
|
-
type: "unknown"
|
|
18555
|
+
type: "unknown",
|
|
18556
|
+
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."
|
|
18504
18557
|
}
|
|
18505
18558
|
}
|
|
18506
18559
|
}
|
|
@@ -18509,6 +18562,7 @@ var schemaDict = {
|
|
|
18509
18562
|
encoding: "application/json",
|
|
18510
18563
|
schema: {
|
|
18511
18564
|
type: "object",
|
|
18565
|
+
description: "Account login session returned on successful account creation.",
|
|
18512
18566
|
required: ["accessJwt", "refreshJwt", "handle", "did"],
|
|
18513
18567
|
properties: {
|
|
18514
18568
|
accessJwt: {
|
|
@@ -18523,10 +18577,12 @@ var schemaDict = {
|
|
|
18523
18577
|
},
|
|
18524
18578
|
did: {
|
|
18525
18579
|
type: "string",
|
|
18526
|
-
format: "did"
|
|
18580
|
+
format: "did",
|
|
18581
|
+
description: "The DID of the new account."
|
|
18527
18582
|
},
|
|
18528
18583
|
didDoc: {
|
|
18529
|
-
type: "unknown"
|
|
18584
|
+
type: "unknown",
|
|
18585
|
+
description: "Complete DID document."
|
|
18530
18586
|
}
|
|
18531
18587
|
}
|
|
18532
18588
|
}
|
|
@@ -18571,7 +18627,8 @@ var schemaDict = {
|
|
|
18571
18627
|
required: ["name"],
|
|
18572
18628
|
properties: {
|
|
18573
18629
|
name: {
|
|
18574
|
-
type: "string"
|
|
18630
|
+
type: "string",
|
|
18631
|
+
description: "A short name for the App Password, to help distinguish them."
|
|
18575
18632
|
}
|
|
18576
18633
|
}
|
|
18577
18634
|
}
|
|
@@ -18838,7 +18895,7 @@ var schemaDict = {
|
|
|
18838
18895
|
defs: {
|
|
18839
18896
|
main: {
|
|
18840
18897
|
type: "procedure",
|
|
18841
|
-
description: "Delete an actor's account with a token and password.",
|
|
18898
|
+
description: "Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.",
|
|
18842
18899
|
input: {
|
|
18843
18900
|
encoding: "application/json",
|
|
18844
18901
|
schema: {
|
|
@@ -18875,7 +18932,7 @@ var schemaDict = {
|
|
|
18875
18932
|
defs: {
|
|
18876
18933
|
main: {
|
|
18877
18934
|
type: "procedure",
|
|
18878
|
-
description: "Delete the current session."
|
|
18935
|
+
description: "Delete the current session. Requires auth."
|
|
18879
18936
|
}
|
|
18880
18937
|
}
|
|
18881
18938
|
},
|
|
@@ -18885,7 +18942,7 @@ var schemaDict = {
|
|
|
18885
18942
|
defs: {
|
|
18886
18943
|
main: {
|
|
18887
18944
|
type: "query",
|
|
18888
|
-
description: "
|
|
18945
|
+
description: "Describes the server's account creation requirements and capabilities. Implemented by PDS.",
|
|
18889
18946
|
output: {
|
|
18890
18947
|
encoding: "application/json",
|
|
18891
18948
|
schema: {
|
|
@@ -18893,19 +18950,23 @@ var schemaDict = {
|
|
|
18893
18950
|
required: ["availableUserDomains"],
|
|
18894
18951
|
properties: {
|
|
18895
18952
|
inviteCodeRequired: {
|
|
18896
|
-
type: "boolean"
|
|
18953
|
+
type: "boolean",
|
|
18954
|
+
description: "If true, an invite code must be supplied to create an account on this instance."
|
|
18897
18955
|
},
|
|
18898
18956
|
phoneVerificationRequired: {
|
|
18899
|
-
type: "boolean"
|
|
18957
|
+
type: "boolean",
|
|
18958
|
+
description: "If true, a phone verification token must be supplied to create an account on this instance."
|
|
18900
18959
|
},
|
|
18901
18960
|
availableUserDomains: {
|
|
18902
18961
|
type: "array",
|
|
18962
|
+
description: "List of domain suffixes that can be used in account handles.",
|
|
18903
18963
|
items: {
|
|
18904
18964
|
type: "string"
|
|
18905
18965
|
}
|
|
18906
18966
|
},
|
|
18907
18967
|
links: {
|
|
18908
18968
|
type: "ref",
|
|
18969
|
+
description: "URLs of service policy documents.",
|
|
18909
18970
|
ref: "lex:com.atproto.server.describeServer#links"
|
|
18910
18971
|
}
|
|
18911
18972
|
}
|
|
@@ -18931,7 +18992,7 @@ var schemaDict = {
|
|
|
18931
18992
|
defs: {
|
|
18932
18993
|
main: {
|
|
18933
18994
|
type: "query",
|
|
18934
|
-
description: "Get all invite codes for
|
|
18995
|
+
description: "Get all invite codes for the current account. Requires auth.",
|
|
18935
18996
|
parameters: {
|
|
18936
18997
|
type: "params",
|
|
18937
18998
|
properties: {
|
|
@@ -18941,7 +19002,8 @@ var schemaDict = {
|
|
|
18941
19002
|
},
|
|
18942
19003
|
createAvailable: {
|
|
18943
19004
|
type: "boolean",
|
|
18944
|
-
default: true
|
|
19005
|
+
default: true,
|
|
19006
|
+
description: "Controls whether any new 'earned' but not 'created' invites should be created."
|
|
18945
19007
|
}
|
|
18946
19008
|
}
|
|
18947
19009
|
},
|
|
@@ -18975,7 +19037,7 @@ var schemaDict = {
|
|
|
18975
19037
|
defs: {
|
|
18976
19038
|
main: {
|
|
18977
19039
|
type: "query",
|
|
18978
|
-
description: "Get information about the current session.",
|
|
19040
|
+
description: "Get information about the current auth session. Requires auth.",
|
|
18979
19041
|
output: {
|
|
18980
19042
|
encoding: "application/json",
|
|
18981
19043
|
schema: {
|
|
@@ -19055,7 +19117,7 @@ var schemaDict = {
|
|
|
19055
19117
|
defs: {
|
|
19056
19118
|
main: {
|
|
19057
19119
|
type: "procedure",
|
|
19058
|
-
description: "Refresh an authentication session.",
|
|
19120
|
+
description: "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
|
|
19059
19121
|
output: {
|
|
19060
19122
|
encoding: "application/json",
|
|
19061
19123
|
schema: {
|
|
@@ -19160,7 +19222,7 @@ var schemaDict = {
|
|
|
19160
19222
|
defs: {
|
|
19161
19223
|
main: {
|
|
19162
19224
|
type: "procedure",
|
|
19163
|
-
description: "Reserve a repo signing key for account creation.",
|
|
19225
|
+
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.",
|
|
19164
19226
|
input: {
|
|
19165
19227
|
encoding: "application/json",
|
|
19166
19228
|
schema: {
|
|
@@ -19168,7 +19230,8 @@ var schemaDict = {
|
|
|
19168
19230
|
properties: {
|
|
19169
19231
|
did: {
|
|
19170
19232
|
type: "string",
|
|
19171
|
-
|
|
19233
|
+
format: "did",
|
|
19234
|
+
description: "The DID to reserve a key for."
|
|
19172
19235
|
}
|
|
19173
19236
|
}
|
|
19174
19237
|
}
|
|
@@ -19181,7 +19244,7 @@ var schemaDict = {
|
|
|
19181
19244
|
properties: {
|
|
19182
19245
|
signingKey: {
|
|
19183
19246
|
type: "string",
|
|
19184
|
-
description: "
|
|
19247
|
+
description: "The public key for the reserved signing key, in did:key serialization."
|
|
19185
19248
|
}
|
|
19186
19249
|
}
|
|
19187
19250
|
}
|
|
@@ -19287,7 +19350,7 @@ var schemaDict = {
|
|
|
19287
19350
|
defs: {
|
|
19288
19351
|
main: {
|
|
19289
19352
|
type: "query",
|
|
19290
|
-
description: "Get a blob associated with a given
|
|
19353
|
+
description: "Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.",
|
|
19291
19354
|
parameters: {
|
|
19292
19355
|
type: "params",
|
|
19293
19356
|
required: ["did", "cid"],
|
|
@@ -19295,7 +19358,7 @@ var schemaDict = {
|
|
|
19295
19358
|
did: {
|
|
19296
19359
|
type: "string",
|
|
19297
19360
|
format: "did",
|
|
19298
|
-
description: "The DID of the
|
|
19361
|
+
description: "The DID of the account."
|
|
19299
19362
|
},
|
|
19300
19363
|
cid: {
|
|
19301
19364
|
type: "string",
|
|
@@ -19316,7 +19379,7 @@ var schemaDict = {
|
|
|
19316
19379
|
defs: {
|
|
19317
19380
|
main: {
|
|
19318
19381
|
type: "query",
|
|
19319
|
-
description: "Get blocks from a given repo.",
|
|
19382
|
+
description: "Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.",
|
|
19320
19383
|
parameters: {
|
|
19321
19384
|
type: "params",
|
|
19322
19385
|
required: ["did", "cids"],
|
|
@@ -19410,7 +19473,7 @@ var schemaDict = {
|
|
|
19410
19473
|
defs: {
|
|
19411
19474
|
main: {
|
|
19412
19475
|
type: "query",
|
|
19413
|
-
description: "Get the current commit CID & revision of the repo.",
|
|
19476
|
+
description: "Get the current commit CID & revision of the specified repo. Does not require auth.",
|
|
19414
19477
|
parameters: {
|
|
19415
19478
|
type: "params",
|
|
19416
19479
|
required: ["did"],
|
|
@@ -19452,7 +19515,7 @@ var schemaDict = {
|
|
|
19452
19515
|
defs: {
|
|
19453
19516
|
main: {
|
|
19454
19517
|
type: "query",
|
|
19455
|
-
description: "Get blocks needed
|
|
19518
|
+
description: "Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.",
|
|
19456
19519
|
parameters: {
|
|
19457
19520
|
type: "params",
|
|
19458
19521
|
required: ["did", "collection", "rkey"],
|
|
@@ -19467,7 +19530,8 @@ var schemaDict = {
|
|
|
19467
19530
|
format: "nsid"
|
|
19468
19531
|
},
|
|
19469
19532
|
rkey: {
|
|
19470
|
-
type: "string"
|
|
19533
|
+
type: "string",
|
|
19534
|
+
description: "Record Key"
|
|
19471
19535
|
},
|
|
19472
19536
|
commit: {
|
|
19473
19537
|
type: "string",
|
|
@@ -19488,7 +19552,7 @@ var schemaDict = {
|
|
|
19488
19552
|
defs: {
|
|
19489
19553
|
main: {
|
|
19490
19554
|
type: "query",
|
|
19491
|
-
description: "
|
|
19555
|
+
description: "Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.",
|
|
19492
19556
|
parameters: {
|
|
19493
19557
|
type: "params",
|
|
19494
19558
|
required: ["did"],
|
|
@@ -19500,7 +19564,7 @@ var schemaDict = {
|
|
|
19500
19564
|
},
|
|
19501
19565
|
since: {
|
|
19502
19566
|
type: "string",
|
|
19503
|
-
description: "The revision of the repo to
|
|
19567
|
+
description: "The revision ('rev') of the repo to create a diff from."
|
|
19504
19568
|
}
|
|
19505
19569
|
}
|
|
19506
19570
|
},
|
|
@@ -19516,7 +19580,7 @@ var schemaDict = {
|
|
|
19516
19580
|
defs: {
|
|
19517
19581
|
main: {
|
|
19518
19582
|
type: "query",
|
|
19519
|
-
description: "List blob
|
|
19583
|
+
description: "List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS.",
|
|
19520
19584
|
parameters: {
|
|
19521
19585
|
type: "params",
|
|
19522
19586
|
required: ["did"],
|
|
@@ -19569,7 +19633,7 @@ var schemaDict = {
|
|
|
19569
19633
|
defs: {
|
|
19570
19634
|
main: {
|
|
19571
19635
|
type: "query",
|
|
19572
|
-
description: "
|
|
19636
|
+
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.",
|
|
19573
19637
|
parameters: {
|
|
19574
19638
|
type: "params",
|
|
19575
19639
|
properties: {
|
|
@@ -19614,7 +19678,8 @@ var schemaDict = {
|
|
|
19614
19678
|
},
|
|
19615
19679
|
head: {
|
|
19616
19680
|
type: "string",
|
|
19617
|
-
format: "cid"
|
|
19681
|
+
format: "cid",
|
|
19682
|
+
description: "Current repo commit CID"
|
|
19618
19683
|
},
|
|
19619
19684
|
rev: {
|
|
19620
19685
|
type: "string"
|
|
@@ -19629,7 +19694,7 @@ var schemaDict = {
|
|
|
19629
19694
|
defs: {
|
|
19630
19695
|
main: {
|
|
19631
19696
|
type: "procedure",
|
|
19632
|
-
description: "Notify a crawling service of a recent update
|
|
19697
|
+
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.",
|
|
19633
19698
|
input: {
|
|
19634
19699
|
encoding: "application/json",
|
|
19635
19700
|
schema: {
|
|
@@ -19638,7 +19703,7 @@ var schemaDict = {
|
|
|
19638
19703
|
properties: {
|
|
19639
19704
|
hostname: {
|
|
19640
19705
|
type: "string",
|
|
19641
|
-
description: "Hostname of the service that is notifying of update."
|
|
19706
|
+
description: "Hostname of the current service (usually a PDS) that is notifying of update."
|
|
19642
19707
|
}
|
|
19643
19708
|
}
|
|
19644
19709
|
}
|
|
@@ -19652,7 +19717,7 @@ var schemaDict = {
|
|
|
19652
19717
|
defs: {
|
|
19653
19718
|
main: {
|
|
19654
19719
|
type: "procedure",
|
|
19655
|
-
description: "Request a service to persistently crawl hosted repos.",
|
|
19720
|
+
description: "Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.",
|
|
19656
19721
|
input: {
|
|
19657
19722
|
encoding: "application/json",
|
|
19658
19723
|
schema: {
|
|
@@ -19661,7 +19726,7 @@ var schemaDict = {
|
|
|
19661
19726
|
properties: {
|
|
19662
19727
|
hostname: {
|
|
19663
19728
|
type: "string",
|
|
19664
|
-
description: "Hostname of the service that is requesting to be crawled."
|
|
19729
|
+
description: "Hostname of the current service (eg, PDS) that is requesting to be crawled."
|
|
19665
19730
|
}
|
|
19666
19731
|
}
|
|
19667
19732
|
}
|
|
@@ -19675,13 +19740,13 @@ var schemaDict = {
|
|
|
19675
19740
|
defs: {
|
|
19676
19741
|
main: {
|
|
19677
19742
|
type: "subscription",
|
|
19678
|
-
description: "
|
|
19743
|
+
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.",
|
|
19679
19744
|
parameters: {
|
|
19680
19745
|
type: "params",
|
|
19681
19746
|
properties: {
|
|
19682
19747
|
cursor: {
|
|
19683
19748
|
type: "integer",
|
|
19684
|
-
description: "The last known event to backfill from."
|
|
19749
|
+
description: "The last known event seq number to backfill from."
|
|
19685
19750
|
}
|
|
19686
19751
|
}
|
|
19687
19752
|
},
|
|
@@ -19702,12 +19767,14 @@ var schemaDict = {
|
|
|
19702
19767
|
name: "FutureCursor"
|
|
19703
19768
|
},
|
|
19704
19769
|
{
|
|
19705
|
-
name: "ConsumerTooSlow"
|
|
19770
|
+
name: "ConsumerTooSlow",
|
|
19771
|
+
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."
|
|
19706
19772
|
}
|
|
19707
19773
|
]
|
|
19708
19774
|
},
|
|
19709
19775
|
commit: {
|
|
19710
19776
|
type: "object",
|
|
19777
|
+
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.",
|
|
19711
19778
|
required: [
|
|
19712
19779
|
"seq",
|
|
19713
19780
|
"rebase",
|
|
@@ -19724,59 +19791,69 @@ var schemaDict = {
|
|
|
19724
19791
|
nullable: ["prev", "since"],
|
|
19725
19792
|
properties: {
|
|
19726
19793
|
seq: {
|
|
19727
|
-
type: "integer"
|
|
19794
|
+
type: "integer",
|
|
19795
|
+
description: "The stream sequence number of this message."
|
|
19728
19796
|
},
|
|
19729
19797
|
rebase: {
|
|
19730
|
-
type: "boolean"
|
|
19798
|
+
type: "boolean",
|
|
19799
|
+
description: "DEPRECATED -- unused"
|
|
19731
19800
|
},
|
|
19732
19801
|
tooBig: {
|
|
19733
|
-
type: "boolean"
|
|
19802
|
+
type: "boolean",
|
|
19803
|
+
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."
|
|
19734
19804
|
},
|
|
19735
19805
|
repo: {
|
|
19736
19806
|
type: "string",
|
|
19737
|
-
format: "did"
|
|
19807
|
+
format: "did",
|
|
19808
|
+
description: "The repo this event comes from."
|
|
19738
19809
|
},
|
|
19739
19810
|
commit: {
|
|
19740
|
-
type: "cid-link"
|
|
19811
|
+
type: "cid-link",
|
|
19812
|
+
description: "Repo commit object CID."
|
|
19741
19813
|
},
|
|
19742
19814
|
prev: {
|
|
19743
|
-
type: "cid-link"
|
|
19815
|
+
type: "cid-link",
|
|
19816
|
+
description: "DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability."
|
|
19744
19817
|
},
|
|
19745
19818
|
rev: {
|
|
19746
19819
|
type: "string",
|
|
19747
|
-
description: "The rev of the emitted commit."
|
|
19820
|
+
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."
|
|
19748
19821
|
},
|
|
19749
19822
|
since: {
|
|
19750
19823
|
type: "string",
|
|
19751
|
-
description: "The rev of the last emitted commit from this repo."
|
|
19824
|
+
description: "The rev of the last emitted commit from this repo (if any)."
|
|
19752
19825
|
},
|
|
19753
19826
|
blocks: {
|
|
19754
19827
|
type: "bytes",
|
|
19755
|
-
description: "CAR file containing relevant blocks.",
|
|
19828
|
+
description: "CAR file containing relevant blocks, as a diff since the previous repo state.",
|
|
19756
19829
|
maxLength: 1e6
|
|
19757
19830
|
},
|
|
19758
19831
|
ops: {
|
|
19759
19832
|
type: "array",
|
|
19760
19833
|
items: {
|
|
19761
19834
|
type: "ref",
|
|
19762
|
-
ref: "lex:com.atproto.sync.subscribeRepos#repoOp"
|
|
19835
|
+
ref: "lex:com.atproto.sync.subscribeRepos#repoOp",
|
|
19836
|
+
description: "List of repo mutation operations in this commit (eg, records created, updated, or deleted)."
|
|
19763
19837
|
},
|
|
19764
19838
|
maxLength: 200
|
|
19765
19839
|
},
|
|
19766
19840
|
blobs: {
|
|
19767
19841
|
type: "array",
|
|
19768
19842
|
items: {
|
|
19769
|
-
type: "cid-link"
|
|
19843
|
+
type: "cid-link",
|
|
19844
|
+
description: "List of new blobs (by CID) referenced by records in this commit."
|
|
19770
19845
|
}
|
|
19771
19846
|
},
|
|
19772
19847
|
time: {
|
|
19773
19848
|
type: "string",
|
|
19774
|
-
format: "datetime"
|
|
19849
|
+
format: "datetime",
|
|
19850
|
+
description: "Timestamp of when this message was originally broadcast."
|
|
19775
19851
|
}
|
|
19776
19852
|
}
|
|
19777
19853
|
},
|
|
19778
19854
|
handle: {
|
|
19779
19855
|
type: "object",
|
|
19856
|
+
description: "Represents an update of the account's handle, or transition to/from invalid state.",
|
|
19780
19857
|
required: ["seq", "did", "handle", "time"],
|
|
19781
19858
|
properties: {
|
|
19782
19859
|
seq: {
|
|
@@ -19798,6 +19875,7 @@ var schemaDict = {
|
|
|
19798
19875
|
},
|
|
19799
19876
|
migrate: {
|
|
19800
19877
|
type: "object",
|
|
19878
|
+
description: "Represents an account moving from one PDS instance to another. NOTE: not implemented; full account migration may introduce a new message instead.",
|
|
19801
19879
|
required: ["seq", "did", "migrateTo", "time"],
|
|
19802
19880
|
nullable: ["migrateTo"],
|
|
19803
19881
|
properties: {
|
|
@@ -19819,6 +19897,7 @@ var schemaDict = {
|
|
|
19819
19897
|
},
|
|
19820
19898
|
tombstone: {
|
|
19821
19899
|
type: "object",
|
|
19900
|
+
description: "Indicates that an account has been deleted.",
|
|
19822
19901
|
required: ["seq", "did", "time"],
|
|
19823
19902
|
properties: {
|
|
19824
19903
|
seq: {
|
|
@@ -19849,7 +19928,7 @@ var schemaDict = {
|
|
|
19849
19928
|
},
|
|
19850
19929
|
repoOp: {
|
|
19851
19930
|
type: "object",
|
|
19852
|
-
description: "A repo operation, ie a
|
|
19931
|
+
description: "A repo operation, ie a mutation of a single record.",
|
|
19853
19932
|
required: ["action", "path", "cid"],
|
|
19854
19933
|
nullable: ["cid"],
|
|
19855
19934
|
properties: {
|
|
@@ -19861,7 +19940,8 @@ var schemaDict = {
|
|
|
19861
19940
|
type: "string"
|
|
19862
19941
|
},
|
|
19863
19942
|
cid: {
|
|
19864
|
-
type: "cid-link"
|
|
19943
|
+
type: "cid-link",
|
|
19944
|
+
description: "For creates and updates, the new record CID. For deletions, null."
|
|
19865
19945
|
}
|
|
19866
19946
|
}
|
|
19867
19947
|
}
|
|
@@ -19901,7 +19981,7 @@ var schemaDict = {
|
|
|
19901
19981
|
defs: {
|
|
19902
19982
|
main: {
|
|
19903
19983
|
type: "query",
|
|
19904
|
-
description: "Fetch all labels from a labeler created after a certain date.",
|
|
19984
|
+
description: "Fetch all labels from a labeler created after a certain date. DEPRECATED: use queryLabels or subscribeLabels instead",
|
|
19905
19985
|
parameters: {
|
|
19906
19986
|
type: "params",
|
|
19907
19987
|
properties: {
|
|
@@ -20014,7 +20094,7 @@ var schemaDict = {
|
|
|
20014
20094
|
defs: {
|
|
20015
20095
|
main: {
|
|
20016
20096
|
type: "procedure",
|
|
20017
|
-
description: "Transfer an account.",
|
|
20097
|
+
description: "Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented.",
|
|
20018
20098
|
input: {
|
|
20019
20099
|
encoding: "application/json",
|
|
20020
20100
|
schema: {
|
|
@@ -20087,7 +20167,6 @@ var schemaDict = {
|
|
|
20087
20167
|
AppBskyActorDefs: {
|
|
20088
20168
|
lexicon: 1,
|
|
20089
20169
|
id: "app.bsky.actor.defs",
|
|
20090
|
-
description: "A reference to an actor in the network.",
|
|
20091
20170
|
defs: {
|
|
20092
20171
|
profileViewBasic: {
|
|
20093
20172
|
type: "object",
|
|
@@ -20220,6 +20299,7 @@ var schemaDict = {
|
|
|
20220
20299
|
},
|
|
20221
20300
|
viewerState: {
|
|
20222
20301
|
type: "object",
|
|
20302
|
+
description: "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.",
|
|
20223
20303
|
properties: {
|
|
20224
20304
|
muted: {
|
|
20225
20305
|
type: "boolean"
|
|
@@ -20304,6 +20384,9 @@ var schemaDict = {
|
|
|
20304
20384
|
type: "string",
|
|
20305
20385
|
format: "at-uri"
|
|
20306
20386
|
}
|
|
20387
|
+
},
|
|
20388
|
+
timelineIndex: {
|
|
20389
|
+
type: "integer"
|
|
20307
20390
|
}
|
|
20308
20391
|
}
|
|
20309
20392
|
},
|
|
@@ -20385,7 +20468,7 @@ var schemaDict = {
|
|
|
20385
20468
|
defs: {
|
|
20386
20469
|
main: {
|
|
20387
20470
|
type: "query",
|
|
20388
|
-
description: "Get private preferences attached to the account.",
|
|
20471
|
+
description: "Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.",
|
|
20389
20472
|
parameters: {
|
|
20390
20473
|
type: "params",
|
|
20391
20474
|
properties: {}
|
|
@@ -20412,14 +20495,15 @@ var schemaDict = {
|
|
|
20412
20495
|
defs: {
|
|
20413
20496
|
main: {
|
|
20414
20497
|
type: "query",
|
|
20415
|
-
description: "Get detailed profile view of an actor.",
|
|
20498
|
+
description: "Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.",
|
|
20416
20499
|
parameters: {
|
|
20417
20500
|
type: "params",
|
|
20418
20501
|
required: ["actor"],
|
|
20419
20502
|
properties: {
|
|
20420
20503
|
actor: {
|
|
20421
20504
|
type: "string",
|
|
20422
|
-
format: "at-identifier"
|
|
20505
|
+
format: "at-identifier",
|
|
20506
|
+
description: "Handle or DID of account to fetch profile of."
|
|
20423
20507
|
}
|
|
20424
20508
|
}
|
|
20425
20509
|
},
|
|
@@ -20479,7 +20563,7 @@ var schemaDict = {
|
|
|
20479
20563
|
defs: {
|
|
20480
20564
|
main: {
|
|
20481
20565
|
type: "query",
|
|
20482
|
-
description: "Get a list of suggested actors
|
|
20566
|
+
description: "Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.",
|
|
20483
20567
|
parameters: {
|
|
20484
20568
|
type: "params",
|
|
20485
20569
|
properties: {
|
|
@@ -20522,7 +20606,7 @@ var schemaDict = {
|
|
|
20522
20606
|
defs: {
|
|
20523
20607
|
main: {
|
|
20524
20608
|
type: "record",
|
|
20525
|
-
description: "A declaration of a profile.",
|
|
20609
|
+
description: "A declaration of a Bluesky account profile.",
|
|
20526
20610
|
key: "literal:self",
|
|
20527
20611
|
record: {
|
|
20528
20612
|
type: "object",
|
|
@@ -20534,21 +20618,25 @@ var schemaDict = {
|
|
|
20534
20618
|
},
|
|
20535
20619
|
description: {
|
|
20536
20620
|
type: "string",
|
|
20621
|
+
description: "Free-form profile description text.",
|
|
20537
20622
|
maxGraphemes: 256,
|
|
20538
20623
|
maxLength: 2560
|
|
20539
20624
|
},
|
|
20540
20625
|
avatar: {
|
|
20541
20626
|
type: "blob",
|
|
20627
|
+
description: "Small image to be displayed next to posts from account. AKA, 'profile picture'",
|
|
20542
20628
|
accept: ["image/png", "image/jpeg"],
|
|
20543
20629
|
maxSize: 1e6
|
|
20544
20630
|
},
|
|
20545
20631
|
banner: {
|
|
20546
20632
|
type: "blob",
|
|
20633
|
+
description: "Larger horizontal image to display behind profile view.",
|
|
20547
20634
|
accept: ["image/png", "image/jpeg"],
|
|
20548
20635
|
maxSize: 1e6
|
|
20549
20636
|
},
|
|
20550
20637
|
labels: {
|
|
20551
20638
|
type: "union",
|
|
20639
|
+
description: "Self-label values, specific to the Bluesky application, on the overall account.",
|
|
20552
20640
|
refs: ["lex:com.atproto.label.defs#selfLabels"]
|
|
20553
20641
|
}
|
|
20554
20642
|
}
|
|
@@ -20585,7 +20673,7 @@ var schemaDict = {
|
|
|
20585
20673
|
defs: {
|
|
20586
20674
|
main: {
|
|
20587
20675
|
type: "query",
|
|
20588
|
-
description: "Find actors (profiles) matching search criteria.",
|
|
20676
|
+
description: "Find actors (profiles) matching search criteria. Does not require auth.",
|
|
20589
20677
|
parameters: {
|
|
20590
20678
|
type: "params",
|
|
20591
20679
|
properties: {
|
|
@@ -20636,7 +20724,7 @@ var schemaDict = {
|
|
|
20636
20724
|
defs: {
|
|
20637
20725
|
main: {
|
|
20638
20726
|
type: "query",
|
|
20639
|
-
description: "Find actor suggestions for a prefix search term.",
|
|
20727
|
+
description: "Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.",
|
|
20640
20728
|
parameters: {
|
|
20641
20729
|
type: "params",
|
|
20642
20730
|
properties: {
|
|
@@ -20678,10 +20766,10 @@ var schemaDict = {
|
|
|
20678
20766
|
AppBskyEmbedExternal: {
|
|
20679
20767
|
lexicon: 1,
|
|
20680
20768
|
id: "app.bsky.embed.external",
|
|
20681
|
-
description: "A representation of some externally linked content, embedded in another form of content.",
|
|
20682
20769
|
defs: {
|
|
20683
20770
|
main: {
|
|
20684
20771
|
type: "object",
|
|
20772
|
+
description: "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).",
|
|
20685
20773
|
required: ["external"],
|
|
20686
20774
|
properties: {
|
|
20687
20775
|
external: {
|
|
@@ -20745,7 +20833,7 @@ var schemaDict = {
|
|
|
20745
20833
|
AppBskyEmbedImages: {
|
|
20746
20834
|
lexicon: 1,
|
|
20747
20835
|
id: "app.bsky.embed.images",
|
|
20748
|
-
description: "A set of images embedded in
|
|
20836
|
+
description: "A set of images embedded in a Bluesky record (eg, a post).",
|
|
20749
20837
|
defs: {
|
|
20750
20838
|
main: {
|
|
20751
20839
|
type: "object",
|
|
@@ -20771,7 +20859,8 @@ var schemaDict = {
|
|
|
20771
20859
|
maxSize: 1e6
|
|
20772
20860
|
},
|
|
20773
20861
|
alt: {
|
|
20774
|
-
type: "string"
|
|
20862
|
+
type: "string",
|
|
20863
|
+
description: "Alt text description of the image, for accessibility."
|
|
20775
20864
|
},
|
|
20776
20865
|
aspectRatio: {
|
|
20777
20866
|
type: "ref",
|
|
@@ -20813,13 +20902,16 @@ var schemaDict = {
|
|
|
20813
20902
|
required: ["thumb", "fullsize", "alt"],
|
|
20814
20903
|
properties: {
|
|
20815
20904
|
thumb: {
|
|
20816
|
-
type: "string"
|
|
20905
|
+
type: "string",
|
|
20906
|
+
description: "Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View."
|
|
20817
20907
|
},
|
|
20818
20908
|
fullsize: {
|
|
20819
|
-
type: "string"
|
|
20909
|
+
type: "string",
|
|
20910
|
+
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."
|
|
20820
20911
|
},
|
|
20821
20912
|
alt: {
|
|
20822
|
-
type: "string"
|
|
20913
|
+
type: "string",
|
|
20914
|
+
description: "Alt text description of the image, for accessibility."
|
|
20823
20915
|
},
|
|
20824
20916
|
aspectRatio: {
|
|
20825
20917
|
type: "ref",
|
|
@@ -20832,7 +20924,7 @@ var schemaDict = {
|
|
|
20832
20924
|
AppBskyEmbedRecord: {
|
|
20833
20925
|
lexicon: 1,
|
|
20834
20926
|
id: "app.bsky.embed.record",
|
|
20835
|
-
description: "A representation of a record embedded in
|
|
20927
|
+
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.",
|
|
20836
20928
|
defs: {
|
|
20837
20929
|
main: {
|
|
20838
20930
|
type: "object",
|
|
@@ -20877,7 +20969,8 @@ var schemaDict = {
|
|
|
20877
20969
|
ref: "lex:app.bsky.actor.defs#profileViewBasic"
|
|
20878
20970
|
},
|
|
20879
20971
|
value: {
|
|
20880
|
-
type: "unknown"
|
|
20972
|
+
type: "unknown",
|
|
20973
|
+
description: "The record data itself."
|
|
20881
20974
|
},
|
|
20882
20975
|
labels: {
|
|
20883
20976
|
type: "array",
|
|
@@ -20941,7 +21034,7 @@ var schemaDict = {
|
|
|
20941
21034
|
AppBskyEmbedRecordWithMedia: {
|
|
20942
21035
|
lexicon: 1,
|
|
20943
21036
|
id: "app.bsky.embed.recordWithMedia",
|
|
20944
|
-
description: "A representation of a record embedded in
|
|
21037
|
+
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.",
|
|
20945
21038
|
defs: {
|
|
20946
21039
|
main: {
|
|
20947
21040
|
type: "object",
|
|
@@ -21040,6 +21133,7 @@ var schemaDict = {
|
|
|
21040
21133
|
},
|
|
21041
21134
|
viewerState: {
|
|
21042
21135
|
type: "object",
|
|
21136
|
+
description: "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.",
|
|
21043
21137
|
properties: {
|
|
21044
21138
|
repost: {
|
|
21045
21139
|
type: "string",
|
|
@@ -21299,7 +21393,7 @@ var schemaDict = {
|
|
|
21299
21393
|
defs: {
|
|
21300
21394
|
main: {
|
|
21301
21395
|
type: "query",
|
|
21302
|
-
description: "Get information about a feed generator, including policies and offered feed URIs.",
|
|
21396
|
+
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).",
|
|
21303
21397
|
output: {
|
|
21304
21398
|
encoding: "application/json",
|
|
21305
21399
|
schema: {
|
|
@@ -21354,7 +21448,7 @@ var schemaDict = {
|
|
|
21354
21448
|
defs: {
|
|
21355
21449
|
main: {
|
|
21356
21450
|
type: "record",
|
|
21357
|
-
description: "
|
|
21451
|
+
description: "Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.",
|
|
21358
21452
|
key: "any",
|
|
21359
21453
|
record: {
|
|
21360
21454
|
type: "object",
|
|
@@ -21388,6 +21482,7 @@ var schemaDict = {
|
|
|
21388
21482
|
},
|
|
21389
21483
|
labels: {
|
|
21390
21484
|
type: "union",
|
|
21485
|
+
description: "Self-label values",
|
|
21391
21486
|
refs: ["lex:com.atproto.label.defs#selfLabels"]
|
|
21392
21487
|
},
|
|
21393
21488
|
createdAt: {
|
|
@@ -21405,7 +21500,7 @@ var schemaDict = {
|
|
|
21405
21500
|
defs: {
|
|
21406
21501
|
main: {
|
|
21407
21502
|
type: "query",
|
|
21408
|
-
description: "Get a list of feeds created by the actor.",
|
|
21503
|
+
description: "Get a list of feeds (feed generator records) created by the actor (in the actor's repo).",
|
|
21409
21504
|
parameters: {
|
|
21410
21505
|
type: "params",
|
|
21411
21506
|
required: ["actor"],
|
|
@@ -21453,7 +21548,7 @@ var schemaDict = {
|
|
|
21453
21548
|
defs: {
|
|
21454
21549
|
main: {
|
|
21455
21550
|
type: "query",
|
|
21456
|
-
description: "Get a list of posts liked by an actor.",
|
|
21551
|
+
description: "Get a list of posts liked by an actor. Does not require auth.",
|
|
21457
21552
|
parameters: {
|
|
21458
21553
|
type: "params",
|
|
21459
21554
|
required: ["actor"],
|
|
@@ -21509,7 +21604,7 @@ var schemaDict = {
|
|
|
21509
21604
|
defs: {
|
|
21510
21605
|
main: {
|
|
21511
21606
|
type: "query",
|
|
21512
|
-
description: "Get a view of an actor's feed.",
|
|
21607
|
+
description: "Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.",
|
|
21513
21608
|
parameters: {
|
|
21514
21609
|
type: "params",
|
|
21515
21610
|
required: ["actor"],
|
|
@@ -21529,6 +21624,7 @@ var schemaDict = {
|
|
|
21529
21624
|
},
|
|
21530
21625
|
filter: {
|
|
21531
21626
|
type: "string",
|
|
21627
|
+
description: "Combinations of post/repost types to include in response.",
|
|
21532
21628
|
knownValues: [
|
|
21533
21629
|
"posts_with_replies",
|
|
21534
21630
|
"posts_no_replies",
|
|
@@ -21575,7 +21671,7 @@ var schemaDict = {
|
|
|
21575
21671
|
defs: {
|
|
21576
21672
|
main: {
|
|
21577
21673
|
type: "query",
|
|
21578
|
-
description: "Get a hydrated feed from an actor's selected feed generator.",
|
|
21674
|
+
description: "Get a hydrated feed from an actor's selected feed generator. Implemented by App View.",
|
|
21579
21675
|
parameters: {
|
|
21580
21676
|
type: "params",
|
|
21581
21677
|
required: ["feed"],
|
|
@@ -21628,14 +21724,15 @@ var schemaDict = {
|
|
|
21628
21724
|
defs: {
|
|
21629
21725
|
main: {
|
|
21630
21726
|
type: "query",
|
|
21631
|
-
description: "Get information about a feed generator.",
|
|
21727
|
+
description: "Get information about a feed generator. Implemented by AppView.",
|
|
21632
21728
|
parameters: {
|
|
21633
21729
|
type: "params",
|
|
21634
21730
|
required: ["feed"],
|
|
21635
21731
|
properties: {
|
|
21636
21732
|
feed: {
|
|
21637
21733
|
type: "string",
|
|
21638
|
-
format: "at-uri"
|
|
21734
|
+
format: "at-uri",
|
|
21735
|
+
description: "AT-URI of the feed generator record."
|
|
21639
21736
|
}
|
|
21640
21737
|
}
|
|
21641
21738
|
},
|
|
@@ -21650,10 +21747,12 @@ var schemaDict = {
|
|
|
21650
21747
|
ref: "lex:app.bsky.feed.defs#generatorView"
|
|
21651
21748
|
},
|
|
21652
21749
|
isOnline: {
|
|
21653
|
-
type: "boolean"
|
|
21750
|
+
type: "boolean",
|
|
21751
|
+
description: "Indicates whether the feed generator service has been online recently, or else seems to be inactive."
|
|
21654
21752
|
},
|
|
21655
21753
|
isValid: {
|
|
21656
|
-
type: "boolean"
|
|
21754
|
+
type: "boolean",
|
|
21755
|
+
description: "Indicates whether the feed generator service is compatible with the record declaration."
|
|
21657
21756
|
}
|
|
21658
21757
|
}
|
|
21659
21758
|
}
|
|
@@ -21706,14 +21805,15 @@ var schemaDict = {
|
|
|
21706
21805
|
defs: {
|
|
21707
21806
|
main: {
|
|
21708
21807
|
type: "query",
|
|
21709
|
-
description: "Get a skeleton of a feed provided by a feed generator.",
|
|
21808
|
+
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.",
|
|
21710
21809
|
parameters: {
|
|
21711
21810
|
type: "params",
|
|
21712
21811
|
required: ["feed"],
|
|
21713
21812
|
properties: {
|
|
21714
21813
|
feed: {
|
|
21715
21814
|
type: "string",
|
|
21716
|
-
format: "at-uri"
|
|
21815
|
+
format: "at-uri",
|
|
21816
|
+
description: "Reference to feed generator record describing the specific feed being requested."
|
|
21717
21817
|
},
|
|
21718
21818
|
limit: {
|
|
21719
21819
|
type: "integer",
|
|
@@ -21759,18 +21859,20 @@ var schemaDict = {
|
|
|
21759
21859
|
defs: {
|
|
21760
21860
|
main: {
|
|
21761
21861
|
type: "query",
|
|
21762
|
-
description: "Get
|
|
21862
|
+
description: "Get like records which reference a subject (by AT-URI and CID).",
|
|
21763
21863
|
parameters: {
|
|
21764
21864
|
type: "params",
|
|
21765
21865
|
required: ["uri"],
|
|
21766
21866
|
properties: {
|
|
21767
21867
|
uri: {
|
|
21768
21868
|
type: "string",
|
|
21769
|
-
format: "at-uri"
|
|
21869
|
+
format: "at-uri",
|
|
21870
|
+
description: "AT-URI of the subject (eg, a post record)."
|
|
21770
21871
|
},
|
|
21771
21872
|
cid: {
|
|
21772
21873
|
type: "string",
|
|
21773
|
-
format: "cid"
|
|
21874
|
+
format: "cid",
|
|
21875
|
+
description: "CID of the subject record (aka, specific version of record), to filter likes."
|
|
21774
21876
|
},
|
|
21775
21877
|
limit: {
|
|
21776
21878
|
type: "integer",
|
|
@@ -21837,14 +21939,15 @@ var schemaDict = {
|
|
|
21837
21939
|
defs: {
|
|
21838
21940
|
main: {
|
|
21839
21941
|
type: "query",
|
|
21840
|
-
description: "Get a
|
|
21942
|
+
description: "Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.",
|
|
21841
21943
|
parameters: {
|
|
21842
21944
|
type: "params",
|
|
21843
21945
|
required: ["list"],
|
|
21844
21946
|
properties: {
|
|
21845
21947
|
list: {
|
|
21846
21948
|
type: "string",
|
|
21847
|
-
format: "at-uri"
|
|
21949
|
+
format: "at-uri",
|
|
21950
|
+
description: "Reference (AT-URI) to the list record."
|
|
21848
21951
|
},
|
|
21849
21952
|
limit: {
|
|
21850
21953
|
type: "integer",
|
|
@@ -21890,23 +21993,26 @@ var schemaDict = {
|
|
|
21890
21993
|
defs: {
|
|
21891
21994
|
main: {
|
|
21892
21995
|
type: "query",
|
|
21893
|
-
description: "Get posts in a thread.",
|
|
21996
|
+
description: "Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.",
|
|
21894
21997
|
parameters: {
|
|
21895
21998
|
type: "params",
|
|
21896
21999
|
required: ["uri"],
|
|
21897
22000
|
properties: {
|
|
21898
22001
|
uri: {
|
|
21899
22002
|
type: "string",
|
|
21900
|
-
format: "at-uri"
|
|
22003
|
+
format: "at-uri",
|
|
22004
|
+
description: "Reference (AT-URI) to post record."
|
|
21901
22005
|
},
|
|
21902
22006
|
depth: {
|
|
21903
22007
|
type: "integer",
|
|
22008
|
+
description: "How many levels of reply depth should be included in response.",
|
|
21904
22009
|
default: 6,
|
|
21905
22010
|
minimum: 0,
|
|
21906
22011
|
maximum: 1e3
|
|
21907
22012
|
},
|
|
21908
22013
|
parentHeight: {
|
|
21909
22014
|
type: "integer",
|
|
22015
|
+
description: "How many levels of parent (and grandparent, etc) post to include.",
|
|
21910
22016
|
default: 80,
|
|
21911
22017
|
minimum: 0,
|
|
21912
22018
|
maximum: 1e3
|
|
@@ -21944,13 +22050,14 @@ var schemaDict = {
|
|
|
21944
22050
|
defs: {
|
|
21945
22051
|
main: {
|
|
21946
22052
|
type: "query",
|
|
21947
|
-
description: "
|
|
22053
|
+
description: "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
|
|
21948
22054
|
parameters: {
|
|
21949
22055
|
type: "params",
|
|
21950
22056
|
required: ["uris"],
|
|
21951
22057
|
properties: {
|
|
21952
22058
|
uris: {
|
|
21953
22059
|
type: "array",
|
|
22060
|
+
description: "List of post AT-URIs to return hydrated views for.",
|
|
21954
22061
|
items: {
|
|
21955
22062
|
type: "string",
|
|
21956
22063
|
format: "at-uri"
|
|
@@ -21984,18 +22091,20 @@ var schemaDict = {
|
|
|
21984
22091
|
defs: {
|
|
21985
22092
|
main: {
|
|
21986
22093
|
type: "query",
|
|
21987
|
-
description: "Get a list of reposts.",
|
|
22094
|
+
description: "Get a list of reposts for a given post.",
|
|
21988
22095
|
parameters: {
|
|
21989
22096
|
type: "params",
|
|
21990
22097
|
required: ["uri"],
|
|
21991
22098
|
properties: {
|
|
21992
22099
|
uri: {
|
|
21993
22100
|
type: "string",
|
|
21994
|
-
format: "at-uri"
|
|
22101
|
+
format: "at-uri",
|
|
22102
|
+
description: "Reference (AT-URI) of post record"
|
|
21995
22103
|
},
|
|
21996
22104
|
cid: {
|
|
21997
22105
|
type: "string",
|
|
21998
|
-
format: "cid"
|
|
22106
|
+
format: "cid",
|
|
22107
|
+
description: "If supplied, filters to reposts of specific version (by CID) of the post record."
|
|
21999
22108
|
},
|
|
22000
22109
|
limit: {
|
|
22001
22110
|
type: "integer",
|
|
@@ -22044,7 +22153,7 @@ var schemaDict = {
|
|
|
22044
22153
|
defs: {
|
|
22045
22154
|
main: {
|
|
22046
22155
|
type: "query",
|
|
22047
|
-
description: "Get a list of suggested feeds for the
|
|
22156
|
+
description: "Get a list of suggested feeds (feed generators) for the requesting account.",
|
|
22048
22157
|
parameters: {
|
|
22049
22158
|
type: "params",
|
|
22050
22159
|
properties: {
|
|
@@ -22087,12 +22196,13 @@ var schemaDict = {
|
|
|
22087
22196
|
defs: {
|
|
22088
22197
|
main: {
|
|
22089
22198
|
type: "query",
|
|
22090
|
-
description: "Get a view of the
|
|
22199
|
+
description: "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.",
|
|
22091
22200
|
parameters: {
|
|
22092
22201
|
type: "params",
|
|
22093
22202
|
properties: {
|
|
22094
22203
|
algorithm: {
|
|
22095
|
-
type: "string"
|
|
22204
|
+
type: "string",
|
|
22205
|
+
description: "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism."
|
|
22096
22206
|
},
|
|
22097
22207
|
limit: {
|
|
22098
22208
|
type: "integer",
|
|
@@ -22133,7 +22243,7 @@ var schemaDict = {
|
|
|
22133
22243
|
defs: {
|
|
22134
22244
|
main: {
|
|
22135
22245
|
type: "record",
|
|
22136
|
-
description: "
|
|
22246
|
+
description: "Record declaring a 'like' of a piece of subject content.",
|
|
22137
22247
|
key: "tid",
|
|
22138
22248
|
record: {
|
|
22139
22249
|
type: "object",
|
|
@@ -22158,7 +22268,7 @@ var schemaDict = {
|
|
|
22158
22268
|
defs: {
|
|
22159
22269
|
main: {
|
|
22160
22270
|
type: "record",
|
|
22161
|
-
description: "
|
|
22271
|
+
description: "Record containing a Bluesky post.",
|
|
22162
22272
|
key: "tid",
|
|
22163
22273
|
record: {
|
|
22164
22274
|
type: "object",
|
|
@@ -22167,11 +22277,12 @@ var schemaDict = {
|
|
|
22167
22277
|
text: {
|
|
22168
22278
|
type: "string",
|
|
22169
22279
|
maxLength: 3e3,
|
|
22170
|
-
maxGraphemes: 300
|
|
22280
|
+
maxGraphemes: 300,
|
|
22281
|
+
description: "The primary post content. May be an empty string, if there are embeds."
|
|
22171
22282
|
},
|
|
22172
22283
|
entities: {
|
|
22173
22284
|
type: "array",
|
|
22174
|
-
description: "
|
|
22285
|
+
description: "DEPRECATED: replaced by app.bsky.richtext.facet.",
|
|
22175
22286
|
items: {
|
|
22176
22287
|
type: "ref",
|
|
22177
22288
|
ref: "lex:app.bsky.feed.post#entity"
|
|
@@ -22179,6 +22290,7 @@ var schemaDict = {
|
|
|
22179
22290
|
},
|
|
22180
22291
|
facets: {
|
|
22181
22292
|
type: "array",
|
|
22293
|
+
description: "Annotations of text (mentions, URLs, hashtags, etc)",
|
|
22182
22294
|
items: {
|
|
22183
22295
|
type: "ref",
|
|
22184
22296
|
ref: "lex:app.bsky.richtext.facet"
|
|
@@ -22199,6 +22311,7 @@ var schemaDict = {
|
|
|
22199
22311
|
},
|
|
22200
22312
|
langs: {
|
|
22201
22313
|
type: "array",
|
|
22314
|
+
description: "Indicates human language of post primary text content.",
|
|
22202
22315
|
maxLength: 3,
|
|
22203
22316
|
items: {
|
|
22204
22317
|
type: "string",
|
|
@@ -22207,21 +22320,23 @@ var schemaDict = {
|
|
|
22207
22320
|
},
|
|
22208
22321
|
labels: {
|
|
22209
22322
|
type: "union",
|
|
22323
|
+
description: "Self-label values for this post. Effectively content warnings.",
|
|
22210
22324
|
refs: ["lex:com.atproto.label.defs#selfLabels"]
|
|
22211
22325
|
},
|
|
22212
22326
|
tags: {
|
|
22213
22327
|
type: "array",
|
|
22328
|
+
description: "Additional non-inline tags describing this post.",
|
|
22214
22329
|
maxLength: 8,
|
|
22215
22330
|
items: {
|
|
22216
22331
|
type: "string",
|
|
22217
22332
|
maxLength: 640,
|
|
22218
22333
|
maxGraphemes: 64
|
|
22219
|
-
}
|
|
22220
|
-
description: "Additional non-inline tags describing this post."
|
|
22334
|
+
}
|
|
22221
22335
|
},
|
|
22222
22336
|
createdAt: {
|
|
22223
22337
|
type: "string",
|
|
22224
|
-
format: "datetime"
|
|
22338
|
+
format: "datetime",
|
|
22339
|
+
description: "Client-declared timestamp when this post was originally created."
|
|
22225
22340
|
}
|
|
22226
22341
|
}
|
|
22227
22342
|
}
|
|
@@ -22280,7 +22395,7 @@ var schemaDict = {
|
|
|
22280
22395
|
id: "app.bsky.feed.repost",
|
|
22281
22396
|
defs: {
|
|
22282
22397
|
main: {
|
|
22283
|
-
description: "
|
|
22398
|
+
description: "Record representing a 'repost' of an existing Bluesky post.",
|
|
22284
22399
|
type: "record",
|
|
22285
22400
|
key: "tid",
|
|
22286
22401
|
record: {
|
|
@@ -22306,7 +22421,7 @@ var schemaDict = {
|
|
|
22306
22421
|
defs: {
|
|
22307
22422
|
main: {
|
|
22308
22423
|
type: "query",
|
|
22309
|
-
description: "Find posts matching search criteria.",
|
|
22424
|
+
description: "Find posts matching search criteria, returning views of those posts.",
|
|
22310
22425
|
parameters: {
|
|
22311
22426
|
type: "params",
|
|
22312
22427
|
required: ["q"],
|
|
@@ -22365,14 +22480,15 @@ var schemaDict = {
|
|
|
22365
22480
|
main: {
|
|
22366
22481
|
type: "record",
|
|
22367
22482
|
key: "tid",
|
|
22368
|
-
description: "
|
|
22483
|
+
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..",
|
|
22369
22484
|
record: {
|
|
22370
22485
|
type: "object",
|
|
22371
22486
|
required: ["post", "createdAt"],
|
|
22372
22487
|
properties: {
|
|
22373
22488
|
post: {
|
|
22374
22489
|
type: "string",
|
|
22375
|
-
format: "at-uri"
|
|
22490
|
+
format: "at-uri",
|
|
22491
|
+
description: "Reference (AT-URI) to the post record."
|
|
22376
22492
|
},
|
|
22377
22493
|
allow: {
|
|
22378
22494
|
type: "array",
|
|
@@ -22422,7 +22538,7 @@ var schemaDict = {
|
|
|
22422
22538
|
defs: {
|
|
22423
22539
|
main: {
|
|
22424
22540
|
type: "record",
|
|
22425
|
-
description: "
|
|
22541
|
+
description: "Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details.",
|
|
22426
22542
|
key: "tid",
|
|
22427
22543
|
record: {
|
|
22428
22544
|
type: "object",
|
|
@@ -22430,7 +22546,8 @@ var schemaDict = {
|
|
|
22430
22546
|
properties: {
|
|
22431
22547
|
subject: {
|
|
22432
22548
|
type: "string",
|
|
22433
|
-
format: "did"
|
|
22549
|
+
format: "did",
|
|
22550
|
+
description: "DID of the account to be blocked."
|
|
22434
22551
|
},
|
|
22435
22552
|
createdAt: {
|
|
22436
22553
|
type: "string",
|
|
@@ -22614,7 +22731,7 @@ var schemaDict = {
|
|
|
22614
22731
|
defs: {
|
|
22615
22732
|
main: {
|
|
22616
22733
|
type: "record",
|
|
22617
|
-
description: "
|
|
22734
|
+
description: "Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.",
|
|
22618
22735
|
key: "tid",
|
|
22619
22736
|
record: {
|
|
22620
22737
|
type: "object",
|
|
@@ -22639,7 +22756,7 @@ var schemaDict = {
|
|
|
22639
22756
|
defs: {
|
|
22640
22757
|
main: {
|
|
22641
22758
|
type: "query",
|
|
22642
|
-
description: "
|
|
22759
|
+
description: "Enumerates which accounts the requesting account is currently blocking. Requires auth.",
|
|
22643
22760
|
parameters: {
|
|
22644
22761
|
type: "params",
|
|
22645
22762
|
properties: {
|
|
@@ -22682,7 +22799,7 @@ var schemaDict = {
|
|
|
22682
22799
|
defs: {
|
|
22683
22800
|
main: {
|
|
22684
22801
|
type: "query",
|
|
22685
|
-
description: "
|
|
22802
|
+
description: "Enumerates accounts which follow a specified account (actor).",
|
|
22686
22803
|
parameters: {
|
|
22687
22804
|
type: "params",
|
|
22688
22805
|
required: ["actor"],
|
|
@@ -22734,7 +22851,7 @@ var schemaDict = {
|
|
|
22734
22851
|
defs: {
|
|
22735
22852
|
main: {
|
|
22736
22853
|
type: "query",
|
|
22737
|
-
description: "
|
|
22854
|
+
description: "Enumerates accounts which a specified account (actor) follows.",
|
|
22738
22855
|
parameters: {
|
|
22739
22856
|
type: "params",
|
|
22740
22857
|
required: ["actor"],
|
|
@@ -22786,14 +22903,15 @@ var schemaDict = {
|
|
|
22786
22903
|
defs: {
|
|
22787
22904
|
main: {
|
|
22788
22905
|
type: "query",
|
|
22789
|
-
description: "
|
|
22906
|
+
description: "Gets a 'view' (with additional context) of a specified list.",
|
|
22790
22907
|
parameters: {
|
|
22791
22908
|
type: "params",
|
|
22792
22909
|
required: ["list"],
|
|
22793
22910
|
properties: {
|
|
22794
22911
|
list: {
|
|
22795
22912
|
type: "string",
|
|
22796
|
-
format: "at-uri"
|
|
22913
|
+
format: "at-uri",
|
|
22914
|
+
description: "Reference (AT-URI) of the list record to hydrate."
|
|
22797
22915
|
},
|
|
22798
22916
|
limit: {
|
|
22799
22917
|
type: "integer",
|
|
@@ -22838,7 +22956,7 @@ var schemaDict = {
|
|
|
22838
22956
|
defs: {
|
|
22839
22957
|
main: {
|
|
22840
22958
|
type: "query",
|
|
22841
|
-
description: "Get lists that the actor is blocking.",
|
|
22959
|
+
description: "Get mod lists that the requesting account (actor) is blocking. Requires auth.",
|
|
22842
22960
|
parameters: {
|
|
22843
22961
|
type: "params",
|
|
22844
22962
|
properties: {
|
|
@@ -22881,7 +22999,7 @@ var schemaDict = {
|
|
|
22881
22999
|
defs: {
|
|
22882
23000
|
main: {
|
|
22883
23001
|
type: "query",
|
|
22884
|
-
description: "
|
|
23002
|
+
description: "Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.",
|
|
22885
23003
|
parameters: {
|
|
22886
23004
|
type: "params",
|
|
22887
23005
|
properties: {
|
|
@@ -22924,14 +23042,15 @@ var schemaDict = {
|
|
|
22924
23042
|
defs: {
|
|
22925
23043
|
main: {
|
|
22926
23044
|
type: "query",
|
|
22927
|
-
description: "
|
|
23045
|
+
description: "Enumerates the lists created by a specified account (actor).",
|
|
22928
23046
|
parameters: {
|
|
22929
23047
|
type: "params",
|
|
22930
23048
|
required: ["actor"],
|
|
22931
23049
|
properties: {
|
|
22932
23050
|
actor: {
|
|
22933
23051
|
type: "string",
|
|
22934
|
-
format: "at-identifier"
|
|
23052
|
+
format: "at-identifier",
|
|
23053
|
+
description: "The account (actor) to enumerate lists from."
|
|
22935
23054
|
},
|
|
22936
23055
|
limit: {
|
|
22937
23056
|
type: "integer",
|
|
@@ -22972,7 +23091,7 @@ var schemaDict = {
|
|
|
22972
23091
|
defs: {
|
|
22973
23092
|
main: {
|
|
22974
23093
|
type: "query",
|
|
22975
|
-
description: "
|
|
23094
|
+
description: "Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.",
|
|
22976
23095
|
parameters: {
|
|
22977
23096
|
type: "params",
|
|
22978
23097
|
properties: {
|
|
@@ -23015,17 +23134,19 @@ var schemaDict = {
|
|
|
23015
23134
|
defs: {
|
|
23016
23135
|
main: {
|
|
23017
23136
|
type: "query",
|
|
23018
|
-
description: "Enumerates public relationships between one account, and a list of other accounts",
|
|
23137
|
+
description: "Enumerates public relationships between one account, and a list of other accounts. Does not require auth.",
|
|
23019
23138
|
parameters: {
|
|
23020
23139
|
type: "params",
|
|
23021
23140
|
required: ["actor"],
|
|
23022
23141
|
properties: {
|
|
23023
23142
|
actor: {
|
|
23024
23143
|
type: "string",
|
|
23025
|
-
format: "at-identifier"
|
|
23144
|
+
format: "at-identifier",
|
|
23145
|
+
description: "Primary account requesting relationships for."
|
|
23026
23146
|
},
|
|
23027
23147
|
others: {
|
|
23028
23148
|
type: "array",
|
|
23149
|
+
description: "List of 'other' accounts to be related back to the primary.",
|
|
23029
23150
|
maxLength: 30,
|
|
23030
23151
|
items: {
|
|
23031
23152
|
type: "string",
|
|
@@ -23072,7 +23193,7 @@ var schemaDict = {
|
|
|
23072
23193
|
defs: {
|
|
23073
23194
|
main: {
|
|
23074
23195
|
type: "query",
|
|
23075
|
-
description: "
|
|
23196
|
+
description: "Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.",
|
|
23076
23197
|
parameters: {
|
|
23077
23198
|
type: "params",
|
|
23078
23199
|
required: ["actor"],
|
|
@@ -23108,7 +23229,7 @@ var schemaDict = {
|
|
|
23108
23229
|
defs: {
|
|
23109
23230
|
main: {
|
|
23110
23231
|
type: "record",
|
|
23111
|
-
description: "
|
|
23232
|
+
description: "Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists.",
|
|
23112
23233
|
key: "tid",
|
|
23113
23234
|
record: {
|
|
23114
23235
|
type: "object",
|
|
@@ -23116,12 +23237,14 @@ var schemaDict = {
|
|
|
23116
23237
|
properties: {
|
|
23117
23238
|
purpose: {
|
|
23118
23239
|
type: "ref",
|
|
23240
|
+
description: "Defines the purpose of the list (aka, moderation-oriented or curration-oriented)",
|
|
23119
23241
|
ref: "lex:app.bsky.graph.defs#listPurpose"
|
|
23120
23242
|
},
|
|
23121
23243
|
name: {
|
|
23122
23244
|
type: "string",
|
|
23123
23245
|
maxLength: 64,
|
|
23124
|
-
minLength: 1
|
|
23246
|
+
minLength: 1,
|
|
23247
|
+
description: "Display name for list; can not be empty."
|
|
23125
23248
|
},
|
|
23126
23249
|
description: {
|
|
23127
23250
|
type: "string",
|
|
@@ -23159,7 +23282,7 @@ var schemaDict = {
|
|
|
23159
23282
|
defs: {
|
|
23160
23283
|
main: {
|
|
23161
23284
|
type: "record",
|
|
23162
|
-
description: "
|
|
23285
|
+
description: "Record representing a block relationship against an entire an entire list of accounts (actors).",
|
|
23163
23286
|
key: "tid",
|
|
23164
23287
|
record: {
|
|
23165
23288
|
type: "object",
|
|
@@ -23167,7 +23290,8 @@ var schemaDict = {
|
|
|
23167
23290
|
properties: {
|
|
23168
23291
|
subject: {
|
|
23169
23292
|
type: "string",
|
|
23170
|
-
format: "at-uri"
|
|
23293
|
+
format: "at-uri",
|
|
23294
|
+
description: "Reference (AT-URI) to the mod list record."
|
|
23171
23295
|
},
|
|
23172
23296
|
createdAt: {
|
|
23173
23297
|
type: "string",
|
|
@@ -23184,7 +23308,7 @@ var schemaDict = {
|
|
|
23184
23308
|
defs: {
|
|
23185
23309
|
main: {
|
|
23186
23310
|
type: "record",
|
|
23187
|
-
description: "
|
|
23311
|
+
description: "Record representing an account's inclusion on a specific list. The AppView will ignore duplicate listitem records.",
|
|
23188
23312
|
key: "tid",
|
|
23189
23313
|
record: {
|
|
23190
23314
|
type: "object",
|
|
@@ -23192,11 +23316,13 @@ var schemaDict = {
|
|
|
23192
23316
|
properties: {
|
|
23193
23317
|
subject: {
|
|
23194
23318
|
type: "string",
|
|
23195
|
-
format: "did"
|
|
23319
|
+
format: "did",
|
|
23320
|
+
description: "The account which is included on the list."
|
|
23196
23321
|
},
|
|
23197
23322
|
list: {
|
|
23198
23323
|
type: "string",
|
|
23199
|
-
format: "at-uri"
|
|
23324
|
+
format: "at-uri",
|
|
23325
|
+
description: "Reference (AT-URI) to the list record (app.bsky.graph.list)."
|
|
23200
23326
|
},
|
|
23201
23327
|
createdAt: {
|
|
23202
23328
|
type: "string",
|
|
@@ -23213,7 +23339,7 @@ var schemaDict = {
|
|
|
23213
23339
|
defs: {
|
|
23214
23340
|
main: {
|
|
23215
23341
|
type: "procedure",
|
|
23216
|
-
description: "
|
|
23342
|
+
description: "Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth.",
|
|
23217
23343
|
input: {
|
|
23218
23344
|
encoding: "application/json",
|
|
23219
23345
|
schema: {
|
|
@@ -23236,7 +23362,7 @@ var schemaDict = {
|
|
|
23236
23362
|
defs: {
|
|
23237
23363
|
main: {
|
|
23238
23364
|
type: "procedure",
|
|
23239
|
-
description: "
|
|
23365
|
+
description: "Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.",
|
|
23240
23366
|
input: {
|
|
23241
23367
|
encoding: "application/json",
|
|
23242
23368
|
schema: {
|
|
@@ -23259,7 +23385,7 @@ var schemaDict = {
|
|
|
23259
23385
|
defs: {
|
|
23260
23386
|
main: {
|
|
23261
23387
|
type: "procedure",
|
|
23262
|
-
description: "
|
|
23388
|
+
description: "Unmutes the specified account. Requires auth.",
|
|
23263
23389
|
input: {
|
|
23264
23390
|
encoding: "application/json",
|
|
23265
23391
|
schema: {
|
|
@@ -23282,7 +23408,7 @@ var schemaDict = {
|
|
|
23282
23408
|
defs: {
|
|
23283
23409
|
main: {
|
|
23284
23410
|
type: "procedure",
|
|
23285
|
-
description: "
|
|
23411
|
+
description: "Unmutes the specified list of accounts. Requires auth.",
|
|
23286
23412
|
input: {
|
|
23287
23413
|
encoding: "application/json",
|
|
23288
23414
|
schema: {
|
|
@@ -23305,7 +23431,7 @@ var schemaDict = {
|
|
|
23305
23431
|
defs: {
|
|
23306
23432
|
main: {
|
|
23307
23433
|
type: "query",
|
|
23308
|
-
description: "
|
|
23434
|
+
description: "Count the number of unread notifications for the requesting account. Requires auth.",
|
|
23309
23435
|
parameters: {
|
|
23310
23436
|
type: "params",
|
|
23311
23437
|
properties: {
|
|
@@ -23336,7 +23462,7 @@ var schemaDict = {
|
|
|
23336
23462
|
defs: {
|
|
23337
23463
|
main: {
|
|
23338
23464
|
type: "query",
|
|
23339
|
-
description: "
|
|
23465
|
+
description: "Enumerate notifications for the requesting account. Requires auth.",
|
|
23340
23466
|
parameters: {
|
|
23341
23467
|
type: "params",
|
|
23342
23468
|
properties: {
|
|
@@ -23446,7 +23572,7 @@ var schemaDict = {
|
|
|
23446
23572
|
defs: {
|
|
23447
23573
|
main: {
|
|
23448
23574
|
type: "procedure",
|
|
23449
|
-
description: "Register
|
|
23575
|
+
description: "Register to receive push notifications, via a specified service, for the requesting account. Requires auth.",
|
|
23450
23576
|
input: {
|
|
23451
23577
|
encoding: "application/json",
|
|
23452
23578
|
schema: {
|
|
@@ -23479,7 +23605,7 @@ var schemaDict = {
|
|
|
23479
23605
|
defs: {
|
|
23480
23606
|
main: {
|
|
23481
23607
|
type: "procedure",
|
|
23482
|
-
description: "Notify server that the
|
|
23608
|
+
description: "Notify server that the requesting account has seen notifications. Requires auth.",
|
|
23483
23609
|
input: {
|
|
23484
23610
|
encoding: "application/json",
|
|
23485
23611
|
schema: {
|
|
@@ -23502,6 +23628,7 @@ var schemaDict = {
|
|
|
23502
23628
|
defs: {
|
|
23503
23629
|
main: {
|
|
23504
23630
|
type: "object",
|
|
23631
|
+
description: "Annotation of a sub-string within rich text.",
|
|
23505
23632
|
required: ["index", "features"],
|
|
23506
23633
|
properties: {
|
|
23507
23634
|
index: {
|
|
@@ -23523,7 +23650,7 @@ var schemaDict = {
|
|
|
23523
23650
|
},
|
|
23524
23651
|
mention: {
|
|
23525
23652
|
type: "object",
|
|
23526
|
-
description: "
|
|
23653
|
+
description: "Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.",
|
|
23527
23654
|
required: ["did"],
|
|
23528
23655
|
properties: {
|
|
23529
23656
|
did: {
|
|
@@ -23534,7 +23661,7 @@ var schemaDict = {
|
|
|
23534
23661
|
},
|
|
23535
23662
|
link: {
|
|
23536
23663
|
type: "object",
|
|
23537
|
-
description: "
|
|
23664
|
+
description: "Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.",
|
|
23538
23665
|
required: ["uri"],
|
|
23539
23666
|
properties: {
|
|
23540
23667
|
uri: {
|
|
@@ -23545,7 +23672,7 @@ var schemaDict = {
|
|
|
23545
23672
|
},
|
|
23546
23673
|
tag: {
|
|
23547
23674
|
type: "object",
|
|
23548
|
-
description: "
|
|
23675
|
+
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').",
|
|
23549
23676
|
required: ["tag"],
|
|
23550
23677
|
properties: {
|
|
23551
23678
|
tag: {
|
|
@@ -23557,7 +23684,7 @@ var schemaDict = {
|
|
|
23557
23684
|
},
|
|
23558
23685
|
byteSlice: {
|
|
23559
23686
|
type: "object",
|
|
23560
|
-
description: "
|
|
23687
|
+
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.",
|
|
23561
23688
|
required: ["byteStart", "byteEnd"],
|
|
23562
23689
|
properties: {
|
|
23563
23690
|
byteStart: {
|
|
@@ -23691,54 +23818,6 @@ var schemaDict = {
|
|
|
23691
23818
|
}
|
|
23692
23819
|
}
|
|
23693
23820
|
},
|
|
23694
|
-
AppBskyUnspeccedGetTimelineSkeleton: {
|
|
23695
|
-
lexicon: 1,
|
|
23696
|
-
id: "app.bsky.unspecced.getTimelineSkeleton",
|
|
23697
|
-
defs: {
|
|
23698
|
-
main: {
|
|
23699
|
-
type: "query",
|
|
23700
|
-
description: "DEPRECATED: a skeleton of a timeline. Unspecced and will be unavailable soon.",
|
|
23701
|
-
parameters: {
|
|
23702
|
-
type: "params",
|
|
23703
|
-
properties: {
|
|
23704
|
-
limit: {
|
|
23705
|
-
type: "integer",
|
|
23706
|
-
minimum: 1,
|
|
23707
|
-
maximum: 100,
|
|
23708
|
-
default: 50
|
|
23709
|
-
},
|
|
23710
|
-
cursor: {
|
|
23711
|
-
type: "string"
|
|
23712
|
-
}
|
|
23713
|
-
}
|
|
23714
|
-
},
|
|
23715
|
-
output: {
|
|
23716
|
-
encoding: "application/json",
|
|
23717
|
-
schema: {
|
|
23718
|
-
type: "object",
|
|
23719
|
-
required: ["feed"],
|
|
23720
|
-
properties: {
|
|
23721
|
-
cursor: {
|
|
23722
|
-
type: "string"
|
|
23723
|
-
},
|
|
23724
|
-
feed: {
|
|
23725
|
-
type: "array",
|
|
23726
|
-
items: {
|
|
23727
|
-
type: "ref",
|
|
23728
|
-
ref: "lex:app.bsky.feed.defs#skeletonFeedPost"
|
|
23729
|
-
}
|
|
23730
|
-
}
|
|
23731
|
-
}
|
|
23732
|
-
}
|
|
23733
|
-
},
|
|
23734
|
-
errors: [
|
|
23735
|
-
{
|
|
23736
|
-
name: "UnknownFeed"
|
|
23737
|
-
}
|
|
23738
|
-
]
|
|
23739
|
-
}
|
|
23740
|
-
}
|
|
23741
|
-
},
|
|
23742
23821
|
AppBskyUnspeccedSearchActorsSkeleton: {
|
|
23743
23822
|
lexicon: 1,
|
|
23744
23823
|
id: "app.bsky.unspecced.searchActorsSkeleton",
|
|
@@ -25653,37 +25732,18 @@ function validateSuggestion(v) {
|
|
|
25653
25732
|
return lexicons.validate("app.bsky.unspecced.getTaggedSuggestions#suggestion", v);
|
|
25654
25733
|
}
|
|
25655
25734
|
|
|
25656
|
-
// src/client/types/app/bsky/unspecced/getTimelineSkeleton.ts
|
|
25657
|
-
var getTimelineSkeleton_exports = {};
|
|
25658
|
-
__export(getTimelineSkeleton_exports, {
|
|
25659
|
-
UnknownFeedError: () => UnknownFeedError3,
|
|
25660
|
-
toKnownErr: () => toKnownErr117
|
|
25661
|
-
});
|
|
25662
|
-
var UnknownFeedError3 = class extends XRPCError {
|
|
25663
|
-
constructor(src2) {
|
|
25664
|
-
super(src2.status, src2.error, src2.message, src2.headers);
|
|
25665
|
-
}
|
|
25666
|
-
};
|
|
25667
|
-
function toKnownErr117(e) {
|
|
25668
|
-
if (e instanceof XRPCError) {
|
|
25669
|
-
if (e.error === "UnknownFeed")
|
|
25670
|
-
return new UnknownFeedError3(e);
|
|
25671
|
-
}
|
|
25672
|
-
return e;
|
|
25673
|
-
}
|
|
25674
|
-
|
|
25675
25735
|
// src/client/types/app/bsky/unspecced/searchActorsSkeleton.ts
|
|
25676
25736
|
var searchActorsSkeleton_exports = {};
|
|
25677
25737
|
__export(searchActorsSkeleton_exports, {
|
|
25678
25738
|
BadQueryStringError: () => BadQueryStringError2,
|
|
25679
|
-
toKnownErr: () =>
|
|
25739
|
+
toKnownErr: () => toKnownErr117
|
|
25680
25740
|
});
|
|
25681
25741
|
var BadQueryStringError2 = class extends XRPCError {
|
|
25682
25742
|
constructor(src2) {
|
|
25683
25743
|
super(src2.status, src2.error, src2.message, src2.headers);
|
|
25684
25744
|
}
|
|
25685
25745
|
};
|
|
25686
|
-
function
|
|
25746
|
+
function toKnownErr117(e) {
|
|
25687
25747
|
if (e instanceof XRPCError) {
|
|
25688
25748
|
if (e.error === "BadQueryString")
|
|
25689
25749
|
return new BadQueryStringError2(e);
|
|
@@ -25695,14 +25755,14 @@ function toKnownErr118(e) {
|
|
|
25695
25755
|
var searchPostsSkeleton_exports = {};
|
|
25696
25756
|
__export(searchPostsSkeleton_exports, {
|
|
25697
25757
|
BadQueryStringError: () => BadQueryStringError3,
|
|
25698
|
-
toKnownErr: () =>
|
|
25758
|
+
toKnownErr: () => toKnownErr118
|
|
25699
25759
|
});
|
|
25700
25760
|
var BadQueryStringError3 = class extends XRPCError {
|
|
25701
25761
|
constructor(src2) {
|
|
25702
25762
|
super(src2.status, src2.error, src2.message, src2.headers);
|
|
25703
25763
|
}
|
|
25704
25764
|
};
|
|
25705
|
-
function
|
|
25765
|
+
function toKnownErr118(e) {
|
|
25706
25766
|
if (e instanceof XRPCError) {
|
|
25707
25767
|
if (e.error === "BadQueryString")
|
|
25708
25768
|
return new BadQueryStringError3(e);
|
|
@@ -27843,19 +27903,14 @@ var AppBskyUnspeccedNS = class {
|
|
|
27843
27903
|
throw toKnownErr116(e);
|
|
27844
27904
|
});
|
|
27845
27905
|
}
|
|
27846
|
-
getTimelineSkeleton(params2, opts) {
|
|
27847
|
-
return this._service.xrpc.call("app.bsky.unspecced.getTimelineSkeleton", params2, void 0, opts).catch((e) => {
|
|
27848
|
-
throw toKnownErr117(e);
|
|
27849
|
-
});
|
|
27850
|
-
}
|
|
27851
27906
|
searchActorsSkeleton(params2, opts) {
|
|
27852
27907
|
return this._service.xrpc.call("app.bsky.unspecced.searchActorsSkeleton", params2, void 0, opts).catch((e) => {
|
|
27853
|
-
throw
|
|
27908
|
+
throw toKnownErr117(e);
|
|
27854
27909
|
});
|
|
27855
27910
|
}
|
|
27856
27911
|
searchPostsSkeleton(params2, opts) {
|
|
27857
27912
|
return this._service.xrpc.call("app.bsky.unspecced.searchPostsSkeleton", params2, void 0, opts).catch((e) => {
|
|
27858
|
-
throw
|
|
27913
|
+
throw toKnownErr118(e);
|
|
27859
27914
|
});
|
|
27860
27915
|
}
|
|
27861
27916
|
};
|