@atproto/api 0.9.6 → 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.
Files changed (53) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/client/lexicons.d.ts +96 -5
  3. package/dist/client/types/app/bsky/actor/defs.d.ts +1 -0
  4. package/dist/index.js +268 -180
  5. package/dist/index.js.map +2 -2
  6. package/package.json +2 -2
  7. package/src/client/lexicons.ts +339 -123
  8. package/src/client/types/app/bsky/actor/defs.ts +2 -0
  9. package/src/client/types/app/bsky/actor/getProfile.ts +1 -0
  10. package/src/client/types/app/bsky/actor/profile.ts +3 -0
  11. package/src/client/types/app/bsky/embed/external.ts +1 -0
  12. package/src/client/types/app/bsky/embed/images.ts +4 -0
  13. package/src/client/types/app/bsky/embed/record.ts +1 -0
  14. package/src/client/types/app/bsky/feed/defs.ts +1 -0
  15. package/src/client/types/app/bsky/feed/getAuthorFeed.ts +1 -0
  16. package/src/client/types/app/bsky/feed/getFeedGenerator.ts +3 -0
  17. package/src/client/types/app/bsky/feed/getFeedSkeleton.ts +1 -0
  18. package/src/client/types/app/bsky/feed/getLikes.ts +2 -0
  19. package/src/client/types/app/bsky/feed/getListFeed.ts +1 -0
  20. package/src/client/types/app/bsky/feed/getPostThread.ts +3 -0
  21. package/src/client/types/app/bsky/feed/getPosts.ts +1 -0
  22. package/src/client/types/app/bsky/feed/getRepostedBy.ts +2 -0
  23. package/src/client/types/app/bsky/feed/getTimeline.ts +1 -0
  24. package/src/client/types/app/bsky/feed/post.ts +5 -1
  25. package/src/client/types/app/bsky/feed/threadgate.ts +1 -0
  26. package/src/client/types/app/bsky/graph/block.ts +1 -0
  27. package/src/client/types/app/bsky/graph/getList.ts +1 -0
  28. package/src/client/types/app/bsky/graph/getLists.ts +1 -0
  29. package/src/client/types/app/bsky/graph/getRelationships.ts +2 -0
  30. package/src/client/types/app/bsky/graph/list.ts +1 -0
  31. package/src/client/types/app/bsky/graph/listblock.ts +1 -0
  32. package/src/client/types/app/bsky/graph/listitem.ts +2 -0
  33. package/src/client/types/app/bsky/richtext/facet.ts +5 -4
  34. package/src/client/types/com/atproto/identity/updateHandle.ts +1 -0
  35. package/src/client/types/com/atproto/moderation/createReport.ts +1 -0
  36. package/src/client/types/com/atproto/repo/applyWrites.ts +6 -5
  37. package/src/client/types/com/atproto/repo/createRecord.ts +4 -4
  38. package/src/client/types/com/atproto/repo/deleteRecord.ts +2 -2
  39. package/src/client/types/com/atproto/repo/describeRepo.ts +3 -0
  40. package/src/client/types/com/atproto/repo/getRecord.ts +1 -1
  41. package/src/client/types/com/atproto/repo/putRecord.ts +4 -4
  42. package/src/client/types/com/atproto/server/createAccount.ts +8 -0
  43. package/src/client/types/com/atproto/server/createAppPassword.ts +1 -0
  44. package/src/client/types/com/atproto/server/describeServer.ts +3 -0
  45. package/src/client/types/com/atproto/server/getAccountInviteCodes.ts +1 -0
  46. package/src/client/types/com/atproto/server/reserveSigningKey.ts +2 -2
  47. package/src/client/types/com/atproto/sync/getBlob.ts +1 -1
  48. package/src/client/types/com/atproto/sync/getRecord.ts +1 -0
  49. package/src/client/types/com/atproto/sync/getRepo.ts +1 -1
  50. package/src/client/types/com/atproto/sync/listRepos.ts +1 -0
  51. package/src/client/types/com/atproto/sync/notifyOfUpdate.ts +1 -1
  52. package/src/client/types/com/atproto/sync/requestCrawl.ts +1 -1
  53. package/src/client/types/com/atproto/sync/subscribeRepos.ts +16 -4
package/dist/index.js CHANGED
@@ -17563,7 +17563,7 @@ var schemaDict = {
17563
17563
  defs: {
17564
17564
  main: {
17565
17565
  type: "query",
17566
- description: "Provides the DID of a repo.",
17566
+ description: "Resolves a handle (domain name) to a DID.",
17567
17567
  parameters: {
17568
17568
  type: "params",
17569
17569
  required: ["handle"],
@@ -17597,7 +17597,7 @@ var schemaDict = {
17597
17597
  defs: {
17598
17598
  main: {
17599
17599
  type: "procedure",
17600
- description: "Updates the handle of the account.",
17600
+ description: "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.",
17601
17601
  input: {
17602
17602
  encoding: "application/json",
17603
17603
  schema: {
@@ -17606,7 +17606,8 @@ var schemaDict = {
17606
17606
  properties: {
17607
17607
  handle: {
17608
17608
  type: "string",
17609
- format: "handle"
17609
+ format: "handle",
17610
+ description: "The new handle."
17610
17611
  }
17611
17612
  }
17612
17613
  }
@@ -17689,7 +17690,7 @@ var schemaDict = {
17689
17690
  defs: {
17690
17691
  main: {
17691
17692
  type: "query",
17692
- 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.",
17693
17694
  parameters: {
17694
17695
  type: "params",
17695
17696
  required: ["uriPatterns"],
@@ -17748,13 +17749,13 @@ var schemaDict = {
17748
17749
  defs: {
17749
17750
  main: {
17750
17751
  type: "subscription",
17751
- description: "Subscribe to label updates.",
17752
+ description: "Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.",
17752
17753
  parameters: {
17753
17754
  type: "params",
17754
17755
  properties: {
17755
17756
  cursor: {
17756
17757
  type: "integer",
17757
- description: "The last known event to backfill from."
17758
+ description: "The last known event seq number to backfill from."
17758
17759
  }
17759
17760
  }
17760
17761
  },
@@ -17810,7 +17811,7 @@ var schemaDict = {
17810
17811
  defs: {
17811
17812
  main: {
17812
17813
  type: "procedure",
17813
- description: "Report a repo or a record.",
17814
+ description: "Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.",
17814
17815
  input: {
17815
17816
  encoding: "application/json",
17816
17817
  schema: {
@@ -17819,10 +17820,12 @@ var schemaDict = {
17819
17820
  properties: {
17820
17821
  reasonType: {
17821
17822
  type: "ref",
17823
+ description: "Indicates the broad category of violation the report is for.",
17822
17824
  ref: "lex:com.atproto.moderation.defs#reasonType"
17823
17825
  },
17824
17826
  reason: {
17825
- type: "string"
17827
+ type: "string",
17828
+ description: "Additional context about the content and violation."
17826
17829
  },
17827
17830
  subject: {
17828
17831
  type: "union",
@@ -17931,7 +17934,7 @@ var schemaDict = {
17931
17934
  defs: {
17932
17935
  main: {
17933
17936
  type: "procedure",
17934
- 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.",
17935
17938
  input: {
17936
17939
  encoding: "application/json",
17937
17940
  schema: {
@@ -17941,12 +17944,12 @@ var schemaDict = {
17941
17944
  repo: {
17942
17945
  type: "string",
17943
17946
  format: "at-identifier",
17944
- description: "The handle or DID of the repo."
17947
+ description: "The handle or DID of the repo (aka, current account)."
17945
17948
  },
17946
17949
  validate: {
17947
17950
  type: "boolean",
17948
17951
  default: true,
17949
- description: "Flag for validating the records."
17952
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data, for all operations."
17950
17953
  },
17951
17954
  writes: {
17952
17955
  type: "array",
@@ -17962,6 +17965,7 @@ var schemaDict = {
17962
17965
  },
17963
17966
  swapCommit: {
17964
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.",
17965
17969
  format: "cid"
17966
17970
  }
17967
17971
  }
@@ -17969,13 +17973,14 @@ var schemaDict = {
17969
17973
  },
17970
17974
  errors: [
17971
17975
  {
17972
- name: "InvalidSwap"
17976
+ name: "InvalidSwap",
17977
+ description: "Indicates that the 'swapCommit' parameter did not match current commit."
17973
17978
  }
17974
17979
  ]
17975
17980
  },
17976
17981
  create: {
17977
17982
  type: "object",
17978
- description: "Create a new record.",
17983
+ description: "Operation which creates a new record.",
17979
17984
  required: ["collection", "value"],
17980
17985
  properties: {
17981
17986
  collection: {
@@ -17993,7 +17998,7 @@ var schemaDict = {
17993
17998
  },
17994
17999
  update: {
17995
18000
  type: "object",
17996
- description: "Update an existing record.",
18001
+ description: "Operation which updates an existing record.",
17997
18002
  required: ["collection", "rkey", "value"],
17998
18003
  properties: {
17999
18004
  collection: {
@@ -18010,7 +18015,7 @@ var schemaDict = {
18010
18015
  },
18011
18016
  delete: {
18012
18017
  type: "object",
18013
- description: "Delete an existing record.",
18018
+ description: "Operation which deletes an existing record.",
18014
18019
  required: ["collection", "rkey"],
18015
18020
  properties: {
18016
18021
  collection: {
@@ -18030,7 +18035,7 @@ var schemaDict = {
18030
18035
  defs: {
18031
18036
  main: {
18032
18037
  type: "procedure",
18033
- description: "Create a new record.",
18038
+ description: "Create a single new repository record. Requires auth, implemented by PDS.",
18034
18039
  input: {
18035
18040
  encoding: "application/json",
18036
18041
  schema: {
@@ -18040,7 +18045,7 @@ var schemaDict = {
18040
18045
  repo: {
18041
18046
  type: "string",
18042
18047
  format: "at-identifier",
18043
- description: "The handle or DID of the repo."
18048
+ description: "The handle or DID of the repo (aka, current account)."
18044
18049
  },
18045
18050
  collection: {
18046
18051
  type: "string",
@@ -18049,17 +18054,17 @@ var schemaDict = {
18049
18054
  },
18050
18055
  rkey: {
18051
18056
  type: "string",
18052
- description: "The key of the record.",
18057
+ description: "The Record Key.",
18053
18058
  maxLength: 15
18054
18059
  },
18055
18060
  validate: {
18056
18061
  type: "boolean",
18057
18062
  default: true,
18058
- description: "Flag for validating the record."
18063
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data."
18059
18064
  },
18060
18065
  record: {
18061
18066
  type: "unknown",
18062
- description: "The record to create."
18067
+ description: "The record itself. Must contain a $type field."
18063
18068
  },
18064
18069
  swapCommit: {
18065
18070
  type: "string",
@@ -18088,7 +18093,8 @@ var schemaDict = {
18088
18093
  },
18089
18094
  errors: [
18090
18095
  {
18091
- name: "InvalidSwap"
18096
+ name: "InvalidSwap",
18097
+ description: "Indicates that 'swapCommit' didn't match current repo commit."
18092
18098
  }
18093
18099
  ]
18094
18100
  }
@@ -18100,7 +18106,7 @@ var schemaDict = {
18100
18106
  defs: {
18101
18107
  main: {
18102
18108
  type: "procedure",
18103
- 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.",
18104
18110
  input: {
18105
18111
  encoding: "application/json",
18106
18112
  schema: {
@@ -18110,7 +18116,7 @@ var schemaDict = {
18110
18116
  repo: {
18111
18117
  type: "string",
18112
18118
  format: "at-identifier",
18113
- description: "The handle or DID of the repo."
18119
+ description: "The handle or DID of the repo (aka, current account)."
18114
18120
  },
18115
18121
  collection: {
18116
18122
  type: "string",
@@ -18119,7 +18125,7 @@ var schemaDict = {
18119
18125
  },
18120
18126
  rkey: {
18121
18127
  type: "string",
18122
- description: "The key of the record."
18128
+ description: "The Record Key."
18123
18129
  },
18124
18130
  swapRecord: {
18125
18131
  type: "string",
@@ -18148,7 +18154,7 @@ var schemaDict = {
18148
18154
  defs: {
18149
18155
  main: {
18150
18156
  type: "query",
18151
- description: "Get information about the repo, including the list of collections.",
18157
+ description: "Get information about an account and repository, including the list of collections. Does not require auth.",
18152
18158
  parameters: {
18153
18159
  type: "params",
18154
18160
  required: ["repo"],
@@ -18181,17 +18187,20 @@ var schemaDict = {
18181
18187
  format: "did"
18182
18188
  },
18183
18189
  didDoc: {
18184
- type: "unknown"
18190
+ type: "unknown",
18191
+ description: "The complete DID document for this account."
18185
18192
  },
18186
18193
  collections: {
18187
18194
  type: "array",
18195
+ description: "List of all the collections (NSIDs) for which this repo contains at least one record.",
18188
18196
  items: {
18189
18197
  type: "string",
18190
18198
  format: "nsid"
18191
18199
  }
18192
18200
  },
18193
18201
  handleIsCorrect: {
18194
- type: "boolean"
18202
+ type: "boolean",
18203
+ description: "Indicates if handle is currently valid (resolves bi-directionally)"
18195
18204
  }
18196
18205
  }
18197
18206
  }
@@ -18205,7 +18214,7 @@ var schemaDict = {
18205
18214
  defs: {
18206
18215
  main: {
18207
18216
  type: "query",
18208
- description: "Get a record.",
18217
+ description: "Get a single record from a repository. Does not require auth.",
18209
18218
  parameters: {
18210
18219
  type: "params",
18211
18220
  required: ["repo", "collection", "rkey"],
@@ -18222,7 +18231,7 @@ var schemaDict = {
18222
18231
  },
18223
18232
  rkey: {
18224
18233
  type: "string",
18225
- description: "The key of the record."
18234
+ description: "The Record Key."
18226
18235
  },
18227
18236
  cid: {
18228
18237
  type: "string",
@@ -18260,7 +18269,7 @@ var schemaDict = {
18260
18269
  defs: {
18261
18270
  main: {
18262
18271
  type: "query",
18263
- 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.",
18264
18273
  parameters: {
18265
18274
  type: "params",
18266
18275
  required: ["repo", "collection"],
@@ -18344,7 +18353,7 @@ var schemaDict = {
18344
18353
  defs: {
18345
18354
  main: {
18346
18355
  type: "procedure",
18347
- 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.",
18348
18357
  input: {
18349
18358
  encoding: "application/json",
18350
18359
  schema: {
@@ -18355,7 +18364,7 @@ var schemaDict = {
18355
18364
  repo: {
18356
18365
  type: "string",
18357
18366
  format: "at-identifier",
18358
- description: "The handle or DID of the repo."
18367
+ description: "The handle or DID of the repo (aka, current account)."
18359
18368
  },
18360
18369
  collection: {
18361
18370
  type: "string",
@@ -18364,13 +18373,13 @@ var schemaDict = {
18364
18373
  },
18365
18374
  rkey: {
18366
18375
  type: "string",
18367
- description: "The key of the record.",
18376
+ description: "The Record Key.",
18368
18377
  maxLength: 15
18369
18378
  },
18370
18379
  validate: {
18371
18380
  type: "boolean",
18372
18381
  default: true,
18373
- description: "Flag for validating the record."
18382
+ description: "Can be set to 'false' to skip Lexicon schema validation of record data."
18374
18383
  },
18375
18384
  record: {
18376
18385
  type: "unknown",
@@ -18379,7 +18388,7 @@ var schemaDict = {
18379
18388
  swapRecord: {
18380
18389
  type: "string",
18381
18390
  format: "cid",
18382
- 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"
18383
18392
  },
18384
18393
  swapCommit: {
18385
18394
  type: "string",
@@ -18441,7 +18450,7 @@ var schemaDict = {
18441
18450
  defs: {
18442
18451
  main: {
18443
18452
  type: "procedure",
18444
- description: "Upload a new blob to be added to repo in a later request.",
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.",
18445
18454
  input: {
18446
18455
  encoding: "*/*"
18447
18456
  },
@@ -18505,7 +18514,7 @@ var schemaDict = {
18505
18514
  defs: {
18506
18515
  main: {
18507
18516
  type: "procedure",
18508
- description: "Create an account.",
18517
+ description: "Create an account. Implemented by PDS.",
18509
18518
  input: {
18510
18519
  encoding: "application/json",
18511
18520
  schema: {
@@ -18517,11 +18526,13 @@ var schemaDict = {
18517
18526
  },
18518
18527
  handle: {
18519
18528
  type: "string",
18520
- format: "handle"
18529
+ format: "handle",
18530
+ description: "Requested handle for the account."
18521
18531
  },
18522
18532
  did: {
18523
18533
  type: "string",
18524
- format: "did"
18534
+ format: "did",
18535
+ description: "Pre-existing atproto DID, being imported to a new account."
18525
18536
  },
18526
18537
  inviteCode: {
18527
18538
  type: "string"
@@ -18533,13 +18544,16 @@ var schemaDict = {
18533
18544
  type: "string"
18534
18545
  },
18535
18546
  password: {
18536
- type: "string"
18547
+ type: "string",
18548
+ description: "Initial account password. May need to meet instance-specific password strength requirements."
18537
18549
  },
18538
18550
  recoveryKey: {
18539
- type: "string"
18551
+ type: "string",
18552
+ description: "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation."
18540
18553
  },
18541
18554
  plcOp: {
18542
- 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."
18543
18557
  }
18544
18558
  }
18545
18559
  }
@@ -18548,6 +18562,7 @@ var schemaDict = {
18548
18562
  encoding: "application/json",
18549
18563
  schema: {
18550
18564
  type: "object",
18565
+ description: "Account login session returned on successful account creation.",
18551
18566
  required: ["accessJwt", "refreshJwt", "handle", "did"],
18552
18567
  properties: {
18553
18568
  accessJwt: {
@@ -18562,10 +18577,12 @@ var schemaDict = {
18562
18577
  },
18563
18578
  did: {
18564
18579
  type: "string",
18565
- format: "did"
18580
+ format: "did",
18581
+ description: "The DID of the new account."
18566
18582
  },
18567
18583
  didDoc: {
18568
- type: "unknown"
18584
+ type: "unknown",
18585
+ description: "Complete DID document."
18569
18586
  }
18570
18587
  }
18571
18588
  }
@@ -18610,7 +18627,8 @@ var schemaDict = {
18610
18627
  required: ["name"],
18611
18628
  properties: {
18612
18629
  name: {
18613
- type: "string"
18630
+ type: "string",
18631
+ description: "A short name for the App Password, to help distinguish them."
18614
18632
  }
18615
18633
  }
18616
18634
  }
@@ -18877,7 +18895,7 @@ var schemaDict = {
18877
18895
  defs: {
18878
18896
  main: {
18879
18897
  type: "procedure",
18880
- 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.",
18881
18899
  input: {
18882
18900
  encoding: "application/json",
18883
18901
  schema: {
@@ -18914,7 +18932,7 @@ var schemaDict = {
18914
18932
  defs: {
18915
18933
  main: {
18916
18934
  type: "procedure",
18917
- description: "Delete the current session."
18935
+ description: "Delete the current session. Requires auth."
18918
18936
  }
18919
18937
  }
18920
18938
  },
@@ -18924,7 +18942,7 @@ var schemaDict = {
18924
18942
  defs: {
18925
18943
  main: {
18926
18944
  type: "query",
18927
- description: "Get a document describing the service's accounts configuration.",
18945
+ description: "Describes the server's account creation requirements and capabilities. Implemented by PDS.",
18928
18946
  output: {
18929
18947
  encoding: "application/json",
18930
18948
  schema: {
@@ -18932,19 +18950,23 @@ var schemaDict = {
18932
18950
  required: ["availableUserDomains"],
18933
18951
  properties: {
18934
18952
  inviteCodeRequired: {
18935
- type: "boolean"
18953
+ type: "boolean",
18954
+ description: "If true, an invite code must be supplied to create an account on this instance."
18936
18955
  },
18937
18956
  phoneVerificationRequired: {
18938
- type: "boolean"
18957
+ type: "boolean",
18958
+ description: "If true, a phone verification token must be supplied to create an account on this instance."
18939
18959
  },
18940
18960
  availableUserDomains: {
18941
18961
  type: "array",
18962
+ description: "List of domain suffixes that can be used in account handles.",
18942
18963
  items: {
18943
18964
  type: "string"
18944
18965
  }
18945
18966
  },
18946
18967
  links: {
18947
18968
  type: "ref",
18969
+ description: "URLs of service policy documents.",
18948
18970
  ref: "lex:com.atproto.server.describeServer#links"
18949
18971
  }
18950
18972
  }
@@ -18970,7 +18992,7 @@ var schemaDict = {
18970
18992
  defs: {
18971
18993
  main: {
18972
18994
  type: "query",
18973
- description: "Get all invite codes for a given account.",
18995
+ description: "Get all invite codes for the current account. Requires auth.",
18974
18996
  parameters: {
18975
18997
  type: "params",
18976
18998
  properties: {
@@ -18980,7 +19002,8 @@ var schemaDict = {
18980
19002
  },
18981
19003
  createAvailable: {
18982
19004
  type: "boolean",
18983
- default: true
19005
+ default: true,
19006
+ description: "Controls whether any new 'earned' but not 'created' invites should be created."
18984
19007
  }
18985
19008
  }
18986
19009
  },
@@ -19014,7 +19037,7 @@ var schemaDict = {
19014
19037
  defs: {
19015
19038
  main: {
19016
19039
  type: "query",
19017
- description: "Get information about the current session.",
19040
+ description: "Get information about the current auth session. Requires auth.",
19018
19041
  output: {
19019
19042
  encoding: "application/json",
19020
19043
  schema: {
@@ -19094,7 +19117,7 @@ var schemaDict = {
19094
19117
  defs: {
19095
19118
  main: {
19096
19119
  type: "procedure",
19097
- description: "Refresh an authentication session.",
19120
+ description: "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
19098
19121
  output: {
19099
19122
  encoding: "application/json",
19100
19123
  schema: {
@@ -19199,7 +19222,7 @@ var schemaDict = {
19199
19222
  defs: {
19200
19223
  main: {
19201
19224
  type: "procedure",
19202
- 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.",
19203
19226
  input: {
19204
19227
  encoding: "application/json",
19205
19228
  schema: {
@@ -19207,7 +19230,8 @@ var schemaDict = {
19207
19230
  properties: {
19208
19231
  did: {
19209
19232
  type: "string",
19210
- description: "The did to reserve a new did:key for"
19233
+ format: "did",
19234
+ description: "The DID to reserve a key for."
19211
19235
  }
19212
19236
  }
19213
19237
  }
@@ -19220,7 +19244,7 @@ var schemaDict = {
19220
19244
  properties: {
19221
19245
  signingKey: {
19222
19246
  type: "string",
19223
- description: "Public signing key in the form of a did:key."
19247
+ description: "The public key for the reserved signing key, in did:key serialization."
19224
19248
  }
19225
19249
  }
19226
19250
  }
@@ -19326,7 +19350,7 @@ var schemaDict = {
19326
19350
  defs: {
19327
19351
  main: {
19328
19352
  type: "query",
19329
- description: "Get a blob associated with a given repo.",
19353
+ description: "Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.",
19330
19354
  parameters: {
19331
19355
  type: "params",
19332
19356
  required: ["did", "cid"],
@@ -19334,7 +19358,7 @@ var schemaDict = {
19334
19358
  did: {
19335
19359
  type: "string",
19336
19360
  format: "did",
19337
- description: "The DID of the repo."
19361
+ description: "The DID of the account."
19338
19362
  },
19339
19363
  cid: {
19340
19364
  type: "string",
@@ -19355,7 +19379,7 @@ var schemaDict = {
19355
19379
  defs: {
19356
19380
  main: {
19357
19381
  type: "query",
19358
- 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.",
19359
19383
  parameters: {
19360
19384
  type: "params",
19361
19385
  required: ["did", "cids"],
@@ -19449,7 +19473,7 @@ var schemaDict = {
19449
19473
  defs: {
19450
19474
  main: {
19451
19475
  type: "query",
19452
- 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.",
19453
19477
  parameters: {
19454
19478
  type: "params",
19455
19479
  required: ["did"],
@@ -19491,7 +19515,7 @@ var schemaDict = {
19491
19515
  defs: {
19492
19516
  main: {
19493
19517
  type: "query",
19494
- description: "Get blocks needed for existence or non-existence of record.",
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.",
19495
19519
  parameters: {
19496
19520
  type: "params",
19497
19521
  required: ["did", "collection", "rkey"],
@@ -19506,7 +19530,8 @@ var schemaDict = {
19506
19530
  format: "nsid"
19507
19531
  },
19508
19532
  rkey: {
19509
- type: "string"
19533
+ type: "string",
19534
+ description: "Record Key"
19510
19535
  },
19511
19536
  commit: {
19512
19537
  type: "string",
@@ -19527,7 +19552,7 @@ var schemaDict = {
19527
19552
  defs: {
19528
19553
  main: {
19529
19554
  type: "query",
19530
- description: "Gets the DID's repo, optionally catching up from a specific revision.",
19555
+ description: "Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.",
19531
19556
  parameters: {
19532
19557
  type: "params",
19533
19558
  required: ["did"],
@@ -19539,7 +19564,7 @@ var schemaDict = {
19539
19564
  },
19540
19565
  since: {
19541
19566
  type: "string",
19542
- description: "The revision of the repo to catch up from."
19567
+ description: "The revision ('rev') of the repo to create a diff from."
19543
19568
  }
19544
19569
  }
19545
19570
  },
@@ -19555,7 +19580,7 @@ var schemaDict = {
19555
19580
  defs: {
19556
19581
  main: {
19557
19582
  type: "query",
19558
- description: "List blob CIDs since some revision.",
19583
+ description: "List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS.",
19559
19584
  parameters: {
19560
19585
  type: "params",
19561
19586
  required: ["did"],
@@ -19608,7 +19633,7 @@ var schemaDict = {
19608
19633
  defs: {
19609
19634
  main: {
19610
19635
  type: "query",
19611
- description: "List DIDs and root CIDs of hosted repos.",
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.",
19612
19637
  parameters: {
19613
19638
  type: "params",
19614
19639
  properties: {
@@ -19653,7 +19678,8 @@ var schemaDict = {
19653
19678
  },
19654
19679
  head: {
19655
19680
  type: "string",
19656
- format: "cid"
19681
+ format: "cid",
19682
+ description: "Current repo commit CID"
19657
19683
  },
19658
19684
  rev: {
19659
19685
  type: "string"
@@ -19668,7 +19694,7 @@ var schemaDict = {
19668
19694
  defs: {
19669
19695
  main: {
19670
19696
  type: "procedure",
19671
- description: "Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break.",
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.",
19672
19698
  input: {
19673
19699
  encoding: "application/json",
19674
19700
  schema: {
@@ -19677,7 +19703,7 @@ var schemaDict = {
19677
19703
  properties: {
19678
19704
  hostname: {
19679
19705
  type: "string",
19680
- 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."
19681
19707
  }
19682
19708
  }
19683
19709
  }
@@ -19691,7 +19717,7 @@ var schemaDict = {
19691
19717
  defs: {
19692
19718
  main: {
19693
19719
  type: "procedure",
19694
- 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.",
19695
19721
  input: {
19696
19722
  encoding: "application/json",
19697
19723
  schema: {
@@ -19700,7 +19726,7 @@ var schemaDict = {
19700
19726
  properties: {
19701
19727
  hostname: {
19702
19728
  type: "string",
19703
- 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."
19704
19730
  }
19705
19731
  }
19706
19732
  }
@@ -19714,13 +19740,13 @@ var schemaDict = {
19714
19740
  defs: {
19715
19741
  main: {
19716
19742
  type: "subscription",
19717
- description: "Subscribe to repo updates.",
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.",
19718
19744
  parameters: {
19719
19745
  type: "params",
19720
19746
  properties: {
19721
19747
  cursor: {
19722
19748
  type: "integer",
19723
- description: "The last known event to backfill from."
19749
+ description: "The last known event seq number to backfill from."
19724
19750
  }
19725
19751
  }
19726
19752
  },
@@ -19741,12 +19767,14 @@ var schemaDict = {
19741
19767
  name: "FutureCursor"
19742
19768
  },
19743
19769
  {
19744
- 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."
19745
19772
  }
19746
19773
  ]
19747
19774
  },
19748
19775
  commit: {
19749
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.",
19750
19778
  required: [
19751
19779
  "seq",
19752
19780
  "rebase",
@@ -19763,59 +19791,69 @@ var schemaDict = {
19763
19791
  nullable: ["prev", "since"],
19764
19792
  properties: {
19765
19793
  seq: {
19766
- type: "integer"
19794
+ type: "integer",
19795
+ description: "The stream sequence number of this message."
19767
19796
  },
19768
19797
  rebase: {
19769
- type: "boolean"
19798
+ type: "boolean",
19799
+ description: "DEPRECATED -- unused"
19770
19800
  },
19771
19801
  tooBig: {
19772
- 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."
19773
19804
  },
19774
19805
  repo: {
19775
19806
  type: "string",
19776
- format: "did"
19807
+ format: "did",
19808
+ description: "The repo this event comes from."
19777
19809
  },
19778
19810
  commit: {
19779
- type: "cid-link"
19811
+ type: "cid-link",
19812
+ description: "Repo commit object CID."
19780
19813
  },
19781
19814
  prev: {
19782
- type: "cid-link"
19815
+ type: "cid-link",
19816
+ description: "DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability."
19783
19817
  },
19784
19818
  rev: {
19785
19819
  type: "string",
19786
- 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."
19787
19821
  },
19788
19822
  since: {
19789
19823
  type: "string",
19790
- 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)."
19791
19825
  },
19792
19826
  blocks: {
19793
19827
  type: "bytes",
19794
- description: "CAR file containing relevant blocks.",
19828
+ description: "CAR file containing relevant blocks, as a diff since the previous repo state.",
19795
19829
  maxLength: 1e6
19796
19830
  },
19797
19831
  ops: {
19798
19832
  type: "array",
19799
19833
  items: {
19800
19834
  type: "ref",
19801
- 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)."
19802
19837
  },
19803
19838
  maxLength: 200
19804
19839
  },
19805
19840
  blobs: {
19806
19841
  type: "array",
19807
19842
  items: {
19808
- type: "cid-link"
19843
+ type: "cid-link",
19844
+ description: "List of new blobs (by CID) referenced by records in this commit."
19809
19845
  }
19810
19846
  },
19811
19847
  time: {
19812
19848
  type: "string",
19813
- format: "datetime"
19849
+ format: "datetime",
19850
+ description: "Timestamp of when this message was originally broadcast."
19814
19851
  }
19815
19852
  }
19816
19853
  },
19817
19854
  handle: {
19818
19855
  type: "object",
19856
+ description: "Represents an update of the account's handle, or transition to/from invalid state.",
19819
19857
  required: ["seq", "did", "handle", "time"],
19820
19858
  properties: {
19821
19859
  seq: {
@@ -19837,6 +19875,7 @@ var schemaDict = {
19837
19875
  },
19838
19876
  migrate: {
19839
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.",
19840
19879
  required: ["seq", "did", "migrateTo", "time"],
19841
19880
  nullable: ["migrateTo"],
19842
19881
  properties: {
@@ -19858,6 +19897,7 @@ var schemaDict = {
19858
19897
  },
19859
19898
  tombstone: {
19860
19899
  type: "object",
19900
+ description: "Indicates that an account has been deleted.",
19861
19901
  required: ["seq", "did", "time"],
19862
19902
  properties: {
19863
19903
  seq: {
@@ -19888,7 +19928,7 @@ var schemaDict = {
19888
19928
  },
19889
19929
  repoOp: {
19890
19930
  type: "object",
19891
- description: "A repo operation, ie a write of a single record. For creates and updates, CID is the record's CID as of this operation. For deletes, it's null.",
19931
+ description: "A repo operation, ie a mutation of a single record.",
19892
19932
  required: ["action", "path", "cid"],
19893
19933
  nullable: ["cid"],
19894
19934
  properties: {
@@ -19900,7 +19940,8 @@ var schemaDict = {
19900
19940
  type: "string"
19901
19941
  },
19902
19942
  cid: {
19903
- type: "cid-link"
19943
+ type: "cid-link",
19944
+ description: "For creates and updates, the new record CID. For deletions, null."
19904
19945
  }
19905
19946
  }
19906
19947
  }
@@ -19940,7 +19981,7 @@ var schemaDict = {
19940
19981
  defs: {
19941
19982
  main: {
19942
19983
  type: "query",
19943
- 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",
19944
19985
  parameters: {
19945
19986
  type: "params",
19946
19987
  properties: {
@@ -20053,7 +20094,7 @@ var schemaDict = {
20053
20094
  defs: {
20054
20095
  main: {
20055
20096
  type: "procedure",
20056
- description: "Transfer an account.",
20097
+ description: "Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented.",
20057
20098
  input: {
20058
20099
  encoding: "application/json",
20059
20100
  schema: {
@@ -20126,7 +20167,6 @@ var schemaDict = {
20126
20167
  AppBskyActorDefs: {
20127
20168
  lexicon: 1,
20128
20169
  id: "app.bsky.actor.defs",
20129
- description: "A reference to an actor in the network.",
20130
20170
  defs: {
20131
20171
  profileViewBasic: {
20132
20172
  type: "object",
@@ -20259,6 +20299,7 @@ var schemaDict = {
20259
20299
  },
20260
20300
  viewerState: {
20261
20301
  type: "object",
20302
+ description: "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.",
20262
20303
  properties: {
20263
20304
  muted: {
20264
20305
  type: "boolean"
@@ -20343,6 +20384,9 @@ var schemaDict = {
20343
20384
  type: "string",
20344
20385
  format: "at-uri"
20345
20386
  }
20387
+ },
20388
+ timelineIndex: {
20389
+ type: "integer"
20346
20390
  }
20347
20391
  }
20348
20392
  },
@@ -20424,7 +20468,7 @@ var schemaDict = {
20424
20468
  defs: {
20425
20469
  main: {
20426
20470
  type: "query",
20427
- 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.",
20428
20472
  parameters: {
20429
20473
  type: "params",
20430
20474
  properties: {}
@@ -20451,14 +20495,15 @@ var schemaDict = {
20451
20495
  defs: {
20452
20496
  main: {
20453
20497
  type: "query",
20454
- 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.",
20455
20499
  parameters: {
20456
20500
  type: "params",
20457
20501
  required: ["actor"],
20458
20502
  properties: {
20459
20503
  actor: {
20460
20504
  type: "string",
20461
- format: "at-identifier"
20505
+ format: "at-identifier",
20506
+ description: "Handle or DID of account to fetch profile of."
20462
20507
  }
20463
20508
  }
20464
20509
  },
@@ -20518,7 +20563,7 @@ var schemaDict = {
20518
20563
  defs: {
20519
20564
  main: {
20520
20565
  type: "query",
20521
- description: "Get a list of suggested actors, used for discovery.",
20566
+ description: "Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.",
20522
20567
  parameters: {
20523
20568
  type: "params",
20524
20569
  properties: {
@@ -20561,7 +20606,7 @@ var schemaDict = {
20561
20606
  defs: {
20562
20607
  main: {
20563
20608
  type: "record",
20564
- description: "A declaration of a profile.",
20609
+ description: "A declaration of a Bluesky account profile.",
20565
20610
  key: "literal:self",
20566
20611
  record: {
20567
20612
  type: "object",
@@ -20573,21 +20618,25 @@ var schemaDict = {
20573
20618
  },
20574
20619
  description: {
20575
20620
  type: "string",
20621
+ description: "Free-form profile description text.",
20576
20622
  maxGraphemes: 256,
20577
20623
  maxLength: 2560
20578
20624
  },
20579
20625
  avatar: {
20580
20626
  type: "blob",
20627
+ description: "Small image to be displayed next to posts from account. AKA, 'profile picture'",
20581
20628
  accept: ["image/png", "image/jpeg"],
20582
20629
  maxSize: 1e6
20583
20630
  },
20584
20631
  banner: {
20585
20632
  type: "blob",
20633
+ description: "Larger horizontal image to display behind profile view.",
20586
20634
  accept: ["image/png", "image/jpeg"],
20587
20635
  maxSize: 1e6
20588
20636
  },
20589
20637
  labels: {
20590
20638
  type: "union",
20639
+ description: "Self-label values, specific to the Bluesky application, on the overall account.",
20591
20640
  refs: ["lex:com.atproto.label.defs#selfLabels"]
20592
20641
  }
20593
20642
  }
@@ -20624,7 +20673,7 @@ var schemaDict = {
20624
20673
  defs: {
20625
20674
  main: {
20626
20675
  type: "query",
20627
- description: "Find actors (profiles) matching search criteria.",
20676
+ description: "Find actors (profiles) matching search criteria. Does not require auth.",
20628
20677
  parameters: {
20629
20678
  type: "params",
20630
20679
  properties: {
@@ -20675,7 +20724,7 @@ var schemaDict = {
20675
20724
  defs: {
20676
20725
  main: {
20677
20726
  type: "query",
20678
- 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.",
20679
20728
  parameters: {
20680
20729
  type: "params",
20681
20730
  properties: {
@@ -20717,10 +20766,10 @@ var schemaDict = {
20717
20766
  AppBskyEmbedExternal: {
20718
20767
  lexicon: 1,
20719
20768
  id: "app.bsky.embed.external",
20720
- description: "A representation of some externally linked content, embedded in another form of content.",
20721
20769
  defs: {
20722
20770
  main: {
20723
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).",
20724
20773
  required: ["external"],
20725
20774
  properties: {
20726
20775
  external: {
@@ -20784,7 +20833,7 @@ var schemaDict = {
20784
20833
  AppBskyEmbedImages: {
20785
20834
  lexicon: 1,
20786
20835
  id: "app.bsky.embed.images",
20787
- description: "A set of images embedded in some other form of content.",
20836
+ description: "A set of images embedded in a Bluesky record (eg, a post).",
20788
20837
  defs: {
20789
20838
  main: {
20790
20839
  type: "object",
@@ -20810,7 +20859,8 @@ var schemaDict = {
20810
20859
  maxSize: 1e6
20811
20860
  },
20812
20861
  alt: {
20813
- type: "string"
20862
+ type: "string",
20863
+ description: "Alt text description of the image, for accessibility."
20814
20864
  },
20815
20865
  aspectRatio: {
20816
20866
  type: "ref",
@@ -20852,13 +20902,16 @@ var schemaDict = {
20852
20902
  required: ["thumb", "fullsize", "alt"],
20853
20903
  properties: {
20854
20904
  thumb: {
20855
- 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."
20856
20907
  },
20857
20908
  fullsize: {
20858
- 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."
20859
20911
  },
20860
20912
  alt: {
20861
- type: "string"
20913
+ type: "string",
20914
+ description: "Alt text description of the image, for accessibility."
20862
20915
  },
20863
20916
  aspectRatio: {
20864
20917
  type: "ref",
@@ -20871,7 +20924,7 @@ var schemaDict = {
20871
20924
  AppBskyEmbedRecord: {
20872
20925
  lexicon: 1,
20873
20926
  id: "app.bsky.embed.record",
20874
- description: "A representation of a record embedded in another form of content.",
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.",
20875
20928
  defs: {
20876
20929
  main: {
20877
20930
  type: "object",
@@ -20916,7 +20969,8 @@ var schemaDict = {
20916
20969
  ref: "lex:app.bsky.actor.defs#profileViewBasic"
20917
20970
  },
20918
20971
  value: {
20919
- type: "unknown"
20972
+ type: "unknown",
20973
+ description: "The record data itself."
20920
20974
  },
20921
20975
  labels: {
20922
20976
  type: "array",
@@ -20980,7 +21034,7 @@ var schemaDict = {
20980
21034
  AppBskyEmbedRecordWithMedia: {
20981
21035
  lexicon: 1,
20982
21036
  id: "app.bsky.embed.recordWithMedia",
20983
- description: "A representation of a record embedded in another form of content, alongside other compatible embeds.",
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.",
20984
21038
  defs: {
20985
21039
  main: {
20986
21040
  type: "object",
@@ -21079,6 +21133,7 @@ var schemaDict = {
21079
21133
  },
21080
21134
  viewerState: {
21081
21135
  type: "object",
21136
+ description: "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.",
21082
21137
  properties: {
21083
21138
  repost: {
21084
21139
  type: "string",
@@ -21338,7 +21393,7 @@ var schemaDict = {
21338
21393
  defs: {
21339
21394
  main: {
21340
21395
  type: "query",
21341
- 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).",
21342
21397
  output: {
21343
21398
  encoding: "application/json",
21344
21399
  schema: {
@@ -21393,7 +21448,7 @@ var schemaDict = {
21393
21448
  defs: {
21394
21449
  main: {
21395
21450
  type: "record",
21396
- description: "A declaration of the existence of a feed generator.",
21451
+ description: "Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.",
21397
21452
  key: "any",
21398
21453
  record: {
21399
21454
  type: "object",
@@ -21427,6 +21482,7 @@ var schemaDict = {
21427
21482
  },
21428
21483
  labels: {
21429
21484
  type: "union",
21485
+ description: "Self-label values",
21430
21486
  refs: ["lex:com.atproto.label.defs#selfLabels"]
21431
21487
  },
21432
21488
  createdAt: {
@@ -21444,7 +21500,7 @@ var schemaDict = {
21444
21500
  defs: {
21445
21501
  main: {
21446
21502
  type: "query",
21447
- 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).",
21448
21504
  parameters: {
21449
21505
  type: "params",
21450
21506
  required: ["actor"],
@@ -21492,7 +21548,7 @@ var schemaDict = {
21492
21548
  defs: {
21493
21549
  main: {
21494
21550
  type: "query",
21495
- 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.",
21496
21552
  parameters: {
21497
21553
  type: "params",
21498
21554
  required: ["actor"],
@@ -21548,7 +21604,7 @@ var schemaDict = {
21548
21604
  defs: {
21549
21605
  main: {
21550
21606
  type: "query",
21551
- 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.",
21552
21608
  parameters: {
21553
21609
  type: "params",
21554
21610
  required: ["actor"],
@@ -21568,6 +21624,7 @@ var schemaDict = {
21568
21624
  },
21569
21625
  filter: {
21570
21626
  type: "string",
21627
+ description: "Combinations of post/repost types to include in response.",
21571
21628
  knownValues: [
21572
21629
  "posts_with_replies",
21573
21630
  "posts_no_replies",
@@ -21614,7 +21671,7 @@ var schemaDict = {
21614
21671
  defs: {
21615
21672
  main: {
21616
21673
  type: "query",
21617
- 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.",
21618
21675
  parameters: {
21619
21676
  type: "params",
21620
21677
  required: ["feed"],
@@ -21667,14 +21724,15 @@ var schemaDict = {
21667
21724
  defs: {
21668
21725
  main: {
21669
21726
  type: "query",
21670
- description: "Get information about a feed generator.",
21727
+ description: "Get information about a feed generator. Implemented by AppView.",
21671
21728
  parameters: {
21672
21729
  type: "params",
21673
21730
  required: ["feed"],
21674
21731
  properties: {
21675
21732
  feed: {
21676
21733
  type: "string",
21677
- format: "at-uri"
21734
+ format: "at-uri",
21735
+ description: "AT-URI of the feed generator record."
21678
21736
  }
21679
21737
  }
21680
21738
  },
@@ -21689,10 +21747,12 @@ var schemaDict = {
21689
21747
  ref: "lex:app.bsky.feed.defs#generatorView"
21690
21748
  },
21691
21749
  isOnline: {
21692
- type: "boolean"
21750
+ type: "boolean",
21751
+ description: "Indicates whether the feed generator service has been online recently, or else seems to be inactive."
21693
21752
  },
21694
21753
  isValid: {
21695
- type: "boolean"
21754
+ type: "boolean",
21755
+ description: "Indicates whether the feed generator service is compatible with the record declaration."
21696
21756
  }
21697
21757
  }
21698
21758
  }
@@ -21745,14 +21805,15 @@ var schemaDict = {
21745
21805
  defs: {
21746
21806
  main: {
21747
21807
  type: "query",
21748
- 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.",
21749
21809
  parameters: {
21750
21810
  type: "params",
21751
21811
  required: ["feed"],
21752
21812
  properties: {
21753
21813
  feed: {
21754
21814
  type: "string",
21755
- format: "at-uri"
21815
+ format: "at-uri",
21816
+ description: "Reference to feed generator record describing the specific feed being requested."
21756
21817
  },
21757
21818
  limit: {
21758
21819
  type: "integer",
@@ -21798,18 +21859,20 @@ var schemaDict = {
21798
21859
  defs: {
21799
21860
  main: {
21800
21861
  type: "query",
21801
- description: "Get the list of likes.",
21862
+ description: "Get like records which reference a subject (by AT-URI and CID).",
21802
21863
  parameters: {
21803
21864
  type: "params",
21804
21865
  required: ["uri"],
21805
21866
  properties: {
21806
21867
  uri: {
21807
21868
  type: "string",
21808
- format: "at-uri"
21869
+ format: "at-uri",
21870
+ description: "AT-URI of the subject (eg, a post record)."
21809
21871
  },
21810
21872
  cid: {
21811
21873
  type: "string",
21812
- format: "cid"
21874
+ format: "cid",
21875
+ description: "CID of the subject record (aka, specific version of record), to filter likes."
21813
21876
  },
21814
21877
  limit: {
21815
21878
  type: "integer",
@@ -21876,14 +21939,15 @@ var schemaDict = {
21876
21939
  defs: {
21877
21940
  main: {
21878
21941
  type: "query",
21879
- description: "Get a view of a recent posts from actors in a list.",
21942
+ description: "Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.",
21880
21943
  parameters: {
21881
21944
  type: "params",
21882
21945
  required: ["list"],
21883
21946
  properties: {
21884
21947
  list: {
21885
21948
  type: "string",
21886
- format: "at-uri"
21949
+ format: "at-uri",
21950
+ description: "Reference (AT-URI) to the list record."
21887
21951
  },
21888
21952
  limit: {
21889
21953
  type: "integer",
@@ -21929,23 +21993,26 @@ var schemaDict = {
21929
21993
  defs: {
21930
21994
  main: {
21931
21995
  type: "query",
21932
- 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.",
21933
21997
  parameters: {
21934
21998
  type: "params",
21935
21999
  required: ["uri"],
21936
22000
  properties: {
21937
22001
  uri: {
21938
22002
  type: "string",
21939
- format: "at-uri"
22003
+ format: "at-uri",
22004
+ description: "Reference (AT-URI) to post record."
21940
22005
  },
21941
22006
  depth: {
21942
22007
  type: "integer",
22008
+ description: "How many levels of reply depth should be included in response.",
21943
22009
  default: 6,
21944
22010
  minimum: 0,
21945
22011
  maximum: 1e3
21946
22012
  },
21947
22013
  parentHeight: {
21948
22014
  type: "integer",
22015
+ description: "How many levels of parent (and grandparent, etc) post to include.",
21949
22016
  default: 80,
21950
22017
  minimum: 0,
21951
22018
  maximum: 1e3
@@ -21983,13 +22050,14 @@ var schemaDict = {
21983
22050
  defs: {
21984
22051
  main: {
21985
22052
  type: "query",
21986
- description: "Get a view of an actor's feed.",
22053
+ description: "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.",
21987
22054
  parameters: {
21988
22055
  type: "params",
21989
22056
  required: ["uris"],
21990
22057
  properties: {
21991
22058
  uris: {
21992
22059
  type: "array",
22060
+ description: "List of post AT-URIs to return hydrated views for.",
21993
22061
  items: {
21994
22062
  type: "string",
21995
22063
  format: "at-uri"
@@ -22023,18 +22091,20 @@ var schemaDict = {
22023
22091
  defs: {
22024
22092
  main: {
22025
22093
  type: "query",
22026
- description: "Get a list of reposts.",
22094
+ description: "Get a list of reposts for a given post.",
22027
22095
  parameters: {
22028
22096
  type: "params",
22029
22097
  required: ["uri"],
22030
22098
  properties: {
22031
22099
  uri: {
22032
22100
  type: "string",
22033
- format: "at-uri"
22101
+ format: "at-uri",
22102
+ description: "Reference (AT-URI) of post record"
22034
22103
  },
22035
22104
  cid: {
22036
22105
  type: "string",
22037
- format: "cid"
22106
+ format: "cid",
22107
+ description: "If supplied, filters to reposts of specific version (by CID) of the post record."
22038
22108
  },
22039
22109
  limit: {
22040
22110
  type: "integer",
@@ -22083,7 +22153,7 @@ var schemaDict = {
22083
22153
  defs: {
22084
22154
  main: {
22085
22155
  type: "query",
22086
- description: "Get a list of suggested feeds for the viewer.",
22156
+ description: "Get a list of suggested feeds (feed generators) for the requesting account.",
22087
22157
  parameters: {
22088
22158
  type: "params",
22089
22159
  properties: {
@@ -22126,12 +22196,13 @@ var schemaDict = {
22126
22196
  defs: {
22127
22197
  main: {
22128
22198
  type: "query",
22129
- description: "Get a view of the actor's home timeline.",
22199
+ description: "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.",
22130
22200
  parameters: {
22131
22201
  type: "params",
22132
22202
  properties: {
22133
22203
  algorithm: {
22134
- type: "string"
22204
+ type: "string",
22205
+ description: "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism."
22135
22206
  },
22136
22207
  limit: {
22137
22208
  type: "integer",
@@ -22172,7 +22243,7 @@ var schemaDict = {
22172
22243
  defs: {
22173
22244
  main: {
22174
22245
  type: "record",
22175
- description: "A declaration of a like.",
22246
+ description: "Record declaring a 'like' of a piece of subject content.",
22176
22247
  key: "tid",
22177
22248
  record: {
22178
22249
  type: "object",
@@ -22197,7 +22268,7 @@ var schemaDict = {
22197
22268
  defs: {
22198
22269
  main: {
22199
22270
  type: "record",
22200
- description: "A declaration of a post.",
22271
+ description: "Record containing a Bluesky post.",
22201
22272
  key: "tid",
22202
22273
  record: {
22203
22274
  type: "object",
@@ -22206,11 +22277,12 @@ var schemaDict = {
22206
22277
  text: {
22207
22278
  type: "string",
22208
22279
  maxLength: 3e3,
22209
- maxGraphemes: 300
22280
+ maxGraphemes: 300,
22281
+ description: "The primary post content. May be an empty string, if there are embeds."
22210
22282
  },
22211
22283
  entities: {
22212
22284
  type: "array",
22213
- description: "Deprecated: replaced by app.bsky.richtext.facet.",
22285
+ description: "DEPRECATED: replaced by app.bsky.richtext.facet.",
22214
22286
  items: {
22215
22287
  type: "ref",
22216
22288
  ref: "lex:app.bsky.feed.post#entity"
@@ -22218,6 +22290,7 @@ var schemaDict = {
22218
22290
  },
22219
22291
  facets: {
22220
22292
  type: "array",
22293
+ description: "Annotations of text (mentions, URLs, hashtags, etc)",
22221
22294
  items: {
22222
22295
  type: "ref",
22223
22296
  ref: "lex:app.bsky.richtext.facet"
@@ -22238,6 +22311,7 @@ var schemaDict = {
22238
22311
  },
22239
22312
  langs: {
22240
22313
  type: "array",
22314
+ description: "Indicates human language of post primary text content.",
22241
22315
  maxLength: 3,
22242
22316
  items: {
22243
22317
  type: "string",
@@ -22246,21 +22320,23 @@ var schemaDict = {
22246
22320
  },
22247
22321
  labels: {
22248
22322
  type: "union",
22323
+ description: "Self-label values for this post. Effectively content warnings.",
22249
22324
  refs: ["lex:com.atproto.label.defs#selfLabels"]
22250
22325
  },
22251
22326
  tags: {
22252
22327
  type: "array",
22328
+ description: "Additional non-inline tags describing this post.",
22253
22329
  maxLength: 8,
22254
22330
  items: {
22255
22331
  type: "string",
22256
22332
  maxLength: 640,
22257
22333
  maxGraphemes: 64
22258
- },
22259
- description: "Additional non-inline tags describing this post."
22334
+ }
22260
22335
  },
22261
22336
  createdAt: {
22262
22337
  type: "string",
22263
- format: "datetime"
22338
+ format: "datetime",
22339
+ description: "Client-declared timestamp when this post was originally created."
22264
22340
  }
22265
22341
  }
22266
22342
  }
@@ -22319,7 +22395,7 @@ var schemaDict = {
22319
22395
  id: "app.bsky.feed.repost",
22320
22396
  defs: {
22321
22397
  main: {
22322
- description: "A declaration of a repost.",
22398
+ description: "Record representing a 'repost' of an existing Bluesky post.",
22323
22399
  type: "record",
22324
22400
  key: "tid",
22325
22401
  record: {
@@ -22345,7 +22421,7 @@ var schemaDict = {
22345
22421
  defs: {
22346
22422
  main: {
22347
22423
  type: "query",
22348
- description: "Find posts matching search criteria.",
22424
+ description: "Find posts matching search criteria, returning views of those posts.",
22349
22425
  parameters: {
22350
22426
  type: "params",
22351
22427
  required: ["q"],
@@ -22404,14 +22480,15 @@ var schemaDict = {
22404
22480
  main: {
22405
22481
  type: "record",
22406
22482
  key: "tid",
22407
- description: "Defines interaction gating rules for a thread. The rkey of the threadgate record should match the rkey of the thread's root post.",
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..",
22408
22484
  record: {
22409
22485
  type: "object",
22410
22486
  required: ["post", "createdAt"],
22411
22487
  properties: {
22412
22488
  post: {
22413
22489
  type: "string",
22414
- format: "at-uri"
22490
+ format: "at-uri",
22491
+ description: "Reference (AT-URI) to the post record."
22415
22492
  },
22416
22493
  allow: {
22417
22494
  type: "array",
@@ -22461,7 +22538,7 @@ var schemaDict = {
22461
22538
  defs: {
22462
22539
  main: {
22463
22540
  type: "record",
22464
- description: "A declaration of a block.",
22541
+ description: "Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details.",
22465
22542
  key: "tid",
22466
22543
  record: {
22467
22544
  type: "object",
@@ -22469,7 +22546,8 @@ var schemaDict = {
22469
22546
  properties: {
22470
22547
  subject: {
22471
22548
  type: "string",
22472
- format: "did"
22549
+ format: "did",
22550
+ description: "DID of the account to be blocked."
22473
22551
  },
22474
22552
  createdAt: {
22475
22553
  type: "string",
@@ -22653,7 +22731,7 @@ var schemaDict = {
22653
22731
  defs: {
22654
22732
  main: {
22655
22733
  type: "record",
22656
- description: "A declaration of a social follow.",
22734
+ description: "Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.",
22657
22735
  key: "tid",
22658
22736
  record: {
22659
22737
  type: "object",
@@ -22678,7 +22756,7 @@ var schemaDict = {
22678
22756
  defs: {
22679
22757
  main: {
22680
22758
  type: "query",
22681
- description: "Get a list of who the actor is blocking.",
22759
+ description: "Enumerates which accounts the requesting account is currently blocking. Requires auth.",
22682
22760
  parameters: {
22683
22761
  type: "params",
22684
22762
  properties: {
@@ -22721,7 +22799,7 @@ var schemaDict = {
22721
22799
  defs: {
22722
22800
  main: {
22723
22801
  type: "query",
22724
- description: "Get a list of an actor's followers.",
22802
+ description: "Enumerates accounts which follow a specified account (actor).",
22725
22803
  parameters: {
22726
22804
  type: "params",
22727
22805
  required: ["actor"],
@@ -22773,7 +22851,7 @@ var schemaDict = {
22773
22851
  defs: {
22774
22852
  main: {
22775
22853
  type: "query",
22776
- description: "Get a list of who the actor follows.",
22854
+ description: "Enumerates accounts which a specified account (actor) follows.",
22777
22855
  parameters: {
22778
22856
  type: "params",
22779
22857
  required: ["actor"],
@@ -22825,14 +22903,15 @@ var schemaDict = {
22825
22903
  defs: {
22826
22904
  main: {
22827
22905
  type: "query",
22828
- description: "Get a list of actors.",
22906
+ description: "Gets a 'view' (with additional context) of a specified list.",
22829
22907
  parameters: {
22830
22908
  type: "params",
22831
22909
  required: ["list"],
22832
22910
  properties: {
22833
22911
  list: {
22834
22912
  type: "string",
22835
- format: "at-uri"
22913
+ format: "at-uri",
22914
+ description: "Reference (AT-URI) of the list record to hydrate."
22836
22915
  },
22837
22916
  limit: {
22838
22917
  type: "integer",
@@ -22877,7 +22956,7 @@ var schemaDict = {
22877
22956
  defs: {
22878
22957
  main: {
22879
22958
  type: "query",
22880
- description: "Get lists that the actor is blocking.",
22959
+ description: "Get mod lists that the requesting account (actor) is blocking. Requires auth.",
22881
22960
  parameters: {
22882
22961
  type: "params",
22883
22962
  properties: {
@@ -22920,7 +22999,7 @@ var schemaDict = {
22920
22999
  defs: {
22921
23000
  main: {
22922
23001
  type: "query",
22923
- description: "Get lists that the actor is muting.",
23002
+ description: "Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.",
22924
23003
  parameters: {
22925
23004
  type: "params",
22926
23005
  properties: {
@@ -22963,14 +23042,15 @@ var schemaDict = {
22963
23042
  defs: {
22964
23043
  main: {
22965
23044
  type: "query",
22966
- description: "Get a list of lists that belong to an actor.",
23045
+ description: "Enumerates the lists created by a specified account (actor).",
22967
23046
  parameters: {
22968
23047
  type: "params",
22969
23048
  required: ["actor"],
22970
23049
  properties: {
22971
23050
  actor: {
22972
23051
  type: "string",
22973
- format: "at-identifier"
23052
+ format: "at-identifier",
23053
+ description: "The account (actor) to enumerate lists from."
22974
23054
  },
22975
23055
  limit: {
22976
23056
  type: "integer",
@@ -23011,7 +23091,7 @@ var schemaDict = {
23011
23091
  defs: {
23012
23092
  main: {
23013
23093
  type: "query",
23014
- description: "Get a list of who the actor mutes.",
23094
+ description: "Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.",
23015
23095
  parameters: {
23016
23096
  type: "params",
23017
23097
  properties: {
@@ -23054,17 +23134,19 @@ var schemaDict = {
23054
23134
  defs: {
23055
23135
  main: {
23056
23136
  type: "query",
23057
- 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.",
23058
23138
  parameters: {
23059
23139
  type: "params",
23060
23140
  required: ["actor"],
23061
23141
  properties: {
23062
23142
  actor: {
23063
23143
  type: "string",
23064
- format: "at-identifier"
23144
+ format: "at-identifier",
23145
+ description: "Primary account requesting relationships for."
23065
23146
  },
23066
23147
  others: {
23067
23148
  type: "array",
23149
+ description: "List of 'other' accounts to be related back to the primary.",
23068
23150
  maxLength: 30,
23069
23151
  items: {
23070
23152
  type: "string",
@@ -23111,7 +23193,7 @@ var schemaDict = {
23111
23193
  defs: {
23112
23194
  main: {
23113
23195
  type: "query",
23114
- description: "Get suggested follows related to a given actor.",
23196
+ description: "Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.",
23115
23197
  parameters: {
23116
23198
  type: "params",
23117
23199
  required: ["actor"],
@@ -23147,7 +23229,7 @@ var schemaDict = {
23147
23229
  defs: {
23148
23230
  main: {
23149
23231
  type: "record",
23150
- description: "A declaration of a list of actors.",
23232
+ description: "Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists.",
23151
23233
  key: "tid",
23152
23234
  record: {
23153
23235
  type: "object",
@@ -23155,12 +23237,14 @@ var schemaDict = {
23155
23237
  properties: {
23156
23238
  purpose: {
23157
23239
  type: "ref",
23240
+ description: "Defines the purpose of the list (aka, moderation-oriented or curration-oriented)",
23158
23241
  ref: "lex:app.bsky.graph.defs#listPurpose"
23159
23242
  },
23160
23243
  name: {
23161
23244
  type: "string",
23162
23245
  maxLength: 64,
23163
- minLength: 1
23246
+ minLength: 1,
23247
+ description: "Display name for list; can not be empty."
23164
23248
  },
23165
23249
  description: {
23166
23250
  type: "string",
@@ -23198,7 +23282,7 @@ var schemaDict = {
23198
23282
  defs: {
23199
23283
  main: {
23200
23284
  type: "record",
23201
- description: "A block of an entire list of actors.",
23285
+ description: "Record representing a block relationship against an entire an entire list of accounts (actors).",
23202
23286
  key: "tid",
23203
23287
  record: {
23204
23288
  type: "object",
@@ -23206,7 +23290,8 @@ var schemaDict = {
23206
23290
  properties: {
23207
23291
  subject: {
23208
23292
  type: "string",
23209
- format: "at-uri"
23293
+ format: "at-uri",
23294
+ description: "Reference (AT-URI) to the mod list record."
23210
23295
  },
23211
23296
  createdAt: {
23212
23297
  type: "string",
@@ -23223,7 +23308,7 @@ var schemaDict = {
23223
23308
  defs: {
23224
23309
  main: {
23225
23310
  type: "record",
23226
- description: "An item under a declared list of actors.",
23311
+ description: "Record representing an account's inclusion on a specific list. The AppView will ignore duplicate listitem records.",
23227
23312
  key: "tid",
23228
23313
  record: {
23229
23314
  type: "object",
@@ -23231,11 +23316,13 @@ var schemaDict = {
23231
23316
  properties: {
23232
23317
  subject: {
23233
23318
  type: "string",
23234
- format: "did"
23319
+ format: "did",
23320
+ description: "The account which is included on the list."
23235
23321
  },
23236
23322
  list: {
23237
23323
  type: "string",
23238
- format: "at-uri"
23324
+ format: "at-uri",
23325
+ description: "Reference (AT-URI) to the list record (app.bsky.graph.list)."
23239
23326
  },
23240
23327
  createdAt: {
23241
23328
  type: "string",
@@ -23252,7 +23339,7 @@ var schemaDict = {
23252
23339
  defs: {
23253
23340
  main: {
23254
23341
  type: "procedure",
23255
- description: "Mute an actor by DID or handle.",
23342
+ description: "Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth.",
23256
23343
  input: {
23257
23344
  encoding: "application/json",
23258
23345
  schema: {
@@ -23275,7 +23362,7 @@ var schemaDict = {
23275
23362
  defs: {
23276
23363
  main: {
23277
23364
  type: "procedure",
23278
- description: "Mute a list of actors.",
23365
+ description: "Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.",
23279
23366
  input: {
23280
23367
  encoding: "application/json",
23281
23368
  schema: {
@@ -23298,7 +23385,7 @@ var schemaDict = {
23298
23385
  defs: {
23299
23386
  main: {
23300
23387
  type: "procedure",
23301
- description: "Unmute an actor by DID or handle.",
23388
+ description: "Unmutes the specified account. Requires auth.",
23302
23389
  input: {
23303
23390
  encoding: "application/json",
23304
23391
  schema: {
@@ -23321,7 +23408,7 @@ var schemaDict = {
23321
23408
  defs: {
23322
23409
  main: {
23323
23410
  type: "procedure",
23324
- description: "Unmute a list of actors.",
23411
+ description: "Unmutes the specified list of accounts. Requires auth.",
23325
23412
  input: {
23326
23413
  encoding: "application/json",
23327
23414
  schema: {
@@ -23344,7 +23431,7 @@ var schemaDict = {
23344
23431
  defs: {
23345
23432
  main: {
23346
23433
  type: "query",
23347
- description: "Get the count of unread notifications.",
23434
+ description: "Count the number of unread notifications for the requesting account. Requires auth.",
23348
23435
  parameters: {
23349
23436
  type: "params",
23350
23437
  properties: {
@@ -23375,7 +23462,7 @@ var schemaDict = {
23375
23462
  defs: {
23376
23463
  main: {
23377
23464
  type: "query",
23378
- description: "Get a list of notifications.",
23465
+ description: "Enumerate notifications for the requesting account. Requires auth.",
23379
23466
  parameters: {
23380
23467
  type: "params",
23381
23468
  properties: {
@@ -23485,7 +23572,7 @@ var schemaDict = {
23485
23572
  defs: {
23486
23573
  main: {
23487
23574
  type: "procedure",
23488
- description: "Register for push notifications with a service.",
23575
+ description: "Register to receive push notifications, via a specified service, for the requesting account. Requires auth.",
23489
23576
  input: {
23490
23577
  encoding: "application/json",
23491
23578
  schema: {
@@ -23518,7 +23605,7 @@ var schemaDict = {
23518
23605
  defs: {
23519
23606
  main: {
23520
23607
  type: "procedure",
23521
- description: "Notify server that the user has seen notifications.",
23608
+ description: "Notify server that the requesting account has seen notifications. Requires auth.",
23522
23609
  input: {
23523
23610
  encoding: "application/json",
23524
23611
  schema: {
@@ -23541,6 +23628,7 @@ var schemaDict = {
23541
23628
  defs: {
23542
23629
  main: {
23543
23630
  type: "object",
23631
+ description: "Annotation of a sub-string within rich text.",
23544
23632
  required: ["index", "features"],
23545
23633
  properties: {
23546
23634
  index: {
@@ -23562,7 +23650,7 @@ var schemaDict = {
23562
23650
  },
23563
23651
  mention: {
23564
23652
  type: "object",
23565
- description: "A facet feature for actor mentions.",
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.",
23566
23654
  required: ["did"],
23567
23655
  properties: {
23568
23656
  did: {
@@ -23573,7 +23661,7 @@ var schemaDict = {
23573
23661
  },
23574
23662
  link: {
23575
23663
  type: "object",
23576
- description: "A facet feature for links.",
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.",
23577
23665
  required: ["uri"],
23578
23666
  properties: {
23579
23667
  uri: {
@@ -23584,7 +23672,7 @@ var schemaDict = {
23584
23672
  },
23585
23673
  tag: {
23586
23674
  type: "object",
23587
- description: "A hashtag.",
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').",
23588
23676
  required: ["tag"],
23589
23677
  properties: {
23590
23678
  tag: {
@@ -23596,7 +23684,7 @@ var schemaDict = {
23596
23684
  },
23597
23685
  byteSlice: {
23598
23686
  type: "object",
23599
- description: "A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.",
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.",
23600
23688
  required: ["byteStart", "byteEnd"],
23601
23689
  properties: {
23602
23690
  byteStart: {