From 98bdd7e0f20d19296aa2b8940a3b3b5817398ccd Mon Sep 17 00:00:00 2001 From: "Ilya (Marshal)" Date: Sat, 17 Feb 2024 13:37:10 +0000 Subject: [PATCH] Update lexicons fetched from 8c94979 committed 2024-02-16T02:12:39Z --- ...t.methods_mixin.backward_compatibility.rst | 7 + ....strong_ref_arg_backward_compatibility.rst | 7 - lexicons/app.bsky.actor.defs.json | 5 +- lexicons/app.bsky.actor.getPreferences.json | 2 +- lexicons/app.bsky.actor.getProfile.json | 8 +- lexicons/app.bsky.actor.getSuggestions.json | 2 +- lexicons/app.bsky.actor.profile.json | 6 +- lexicons/app.bsky.actor.searchActors.json | 2 +- .../app.bsky.actor.searchActorsTypeahead.json | 2 +- lexicons/app.bsky.embed.external.json | 2 +- lexicons/app.bsky.embed.images.json | 22 ++- lexicons/app.bsky.embed.record.json | 7 +- lexicons/app.bsky.embed.recordWithMedia.json | 2 +- lexicons/app.bsky.feed.defs.json | 1 + .../app.bsky.feed.describeFeedGenerator.json | 2 +- lexicons/app.bsky.feed.generator.json | 3 +- lexicons/app.bsky.feed.getActorFeeds.json | 2 +- lexicons/app.bsky.feed.getActorLikes.json | 2 +- lexicons/app.bsky.feed.getAuthorFeed.json | 3 +- lexicons/app.bsky.feed.getFeed.json | 2 +- lexicons/app.bsky.feed.getFeedGenerator.json | 18 ++- lexicons/app.bsky.feed.getFeedSkeleton.json | 8 +- lexicons/app.bsky.feed.getLikes.json | 14 +- lexicons/app.bsky.feed.getListFeed.json | 8 +- lexicons/app.bsky.feed.getPostThread.json | 10 +- lexicons/app.bsky.feed.getPosts.json | 3 +- lexicons/app.bsky.feed.getRepostedBy.json | 14 +- lexicons/app.bsky.feed.getSuggestedFeeds.json | 2 +- lexicons/app.bsky.feed.getTimeline.json | 7 +- lexicons/app.bsky.feed.like.json | 2 +- lexicons/app.bsky.feed.post.json | 24 ++- lexicons/app.bsky.feed.repost.json | 2 +- lexicons/app.bsky.feed.searchPosts.json | 2 +- lexicons/app.bsky.feed.threadgate.json | 8 +- lexicons/app.bsky.graph.block.json | 8 +- lexicons/app.bsky.graph.follow.json | 2 +- lexicons/app.bsky.graph.getBlocks.json | 2 +- lexicons/app.bsky.graph.getFollowers.json | 2 +- lexicons/app.bsky.graph.getFollows.json | 2 +- lexicons/app.bsky.graph.getList.json | 8 +- lexicons/app.bsky.graph.getListBlocks.json | 2 +- lexicons/app.bsky.graph.getListMutes.json | 2 +- lexicons/app.bsky.graph.getLists.json | 8 +- lexicons/app.bsky.graph.getMutes.json | 2 +- lexicons/app.bsky.graph.getRelationships.json | 9 +- ...bsky.graph.getSuggestedFollowsByActor.json | 2 +- lexicons/app.bsky.graph.list.json | 10 +- lexicons/app.bsky.graph.listblock.json | 8 +- lexicons/app.bsky.graph.listitem.json | 14 +- lexicons/app.bsky.graph.muteActor.json | 2 +- lexicons/app.bsky.graph.muteActorList.json | 2 +- lexicons/app.bsky.graph.unmuteActor.json | 2 +- lexicons/app.bsky.graph.unmuteActorList.json | 2 +- .../app.bsky.notification.getUnreadCount.json | 2 +- ...p.bsky.notification.listNotifications.json | 2 +- .../app.bsky.notification.registerPush.json | 2 +- .../app.bsky.notification.updateSeen.json | 2 +- lexicons/app.bsky.richtext.facet.json | 9 +- .../com.atproto.identity.resolveHandle.json | 2 +- .../com.atproto.identity.updateHandle.json | 8 +- lexicons/com.atproto.label.queryLabels.json | 2 +- .../com.atproto.label.subscribeLabels.json | 4 +- .../com.atproto.moderation.createReport.json | 8 +- lexicons/com.atproto.repo.applyWrites.json | 20 ++- lexicons/com.atproto.repo.createRecord.json | 17 ++- lexicons/com.atproto.repo.deleteRecord.json | 6 +- lexicons/com.atproto.repo.describeRepo.json | 13 +- lexicons/com.atproto.repo.getRecord.json | 4 +- lexicons/com.atproto.repo.listRecords.json | 2 +- lexicons/com.atproto.repo.putRecord.json | 10 +- lexicons/com.atproto.repo.uploadBlob.json | 2 +- .../com.atproto.server.createAccount.json | 41 +++++- .../com.atproto.server.createAppPassword.json | 5 +- .../com.atproto.server.deleteAccount.json | 2 +- .../com.atproto.server.deleteSession.json | 2 +- .../com.atproto.server.describeServer.json | 19 ++- ....atproto.server.getAccountInviteCodes.json | 8 +- lexicons/com.atproto.server.getSession.json | 2 +- .../com.atproto.server.refreshSession.json | 2 +- .../com.atproto.server.reserveSigningKey.json | 7 +- lexicons/com.atproto.sync.getBlob.json | 4 +- lexicons/com.atproto.sync.getBlocks.json | 2 +- .../com.atproto.sync.getLatestCommit.json | 2 +- lexicons/com.atproto.sync.getRecord.json | 4 +- lexicons/com.atproto.sync.getRepo.json | 4 +- lexicons/com.atproto.sync.listBlobs.json | 2 +- lexicons/com.atproto.sync.listRepos.json | 8 +- lexicons/com.atproto.sync.notifyOfUpdate.json | 4 +- lexicons/com.atproto.sync.requestCrawl.json | 4 +- lexicons/com.atproto.sync.subscribeRepos.json | 74 +++++++--- lexicons/com.atproto.temp.fetchLabels.json | 2 +- .../com.atproto.temp.transferAccount.json | 2 +- .../models/app/bsky/actor/defs.py | 3 +- .../models/app/bsky/actor/get_profile.py | 4 +- .../models/app/bsky/actor/profile.py | 10 +- .../models/app/bsky/embed/external.py | 2 +- .../models/app/bsky/embed/images.py | 8 +- .../models/app/bsky/embed/record.py | 2 +- .../models/app/bsky/feed/defs.py | 2 +- .../models/app/bsky/feed/generator.py | 2 +- .../models/app/bsky/feed/get_author_feed.py | 4 +- .../app/bsky/feed/get_feed_generator.py | 10 +- .../models/app/bsky/feed/get_feed_skeleton.py | 4 +- .../models/app/bsky/feed/get_likes.py | 10 +- .../models/app/bsky/feed/get_list_feed.py | 4 +- .../models/app/bsky/feed/get_post_thread.py | 16 +- .../models/app/bsky/feed/get_posts.py | 4 +- .../models/app/bsky/feed/get_reposted_by.py | 10 +- .../models/app/bsky/feed/get_timeline.py | 8 +- .../models/app/bsky/feed/post.py | 18 ++- .../models/app/bsky/feed/threadgate.py | 2 +- .../models/app/bsky/graph/block.py | 2 +- .../models/app/bsky/graph/get_list.py | 4 +- .../models/app/bsky/graph/get_lists.py | 4 +- .../app/bsky/graph/get_relationships.py | 10 +- .../models/app/bsky/graph/list.py | 6 +- .../models/app/bsky/graph/listblock.py | 2 +- .../models/app/bsky/graph/listitem.py | 4 +- .../models/app/bsky/richtext/facet.py | 10 +- .../com/atproto/identity/update_handle.py | 4 +- .../com/atproto/label/subscribe_labels.py | 4 +- .../com/atproto/moderation/create_report.py | 12 +- .../models/com/atproto/repo/apply_writes.py | 26 ++-- .../models/com/atproto/repo/create_record.py | 18 ++- .../models/com/atproto/repo/delete_record.py | 8 +- .../models/com/atproto/repo/describe_repo.py | 6 +- .../models/com/atproto/repo/get_record.py | 4 +- .../models/com/atproto/repo/put_record.py | 22 ++- .../com/atproto/server/create_account.py | 38 +++-- .../com/atproto/server/create_app_password.py | 4 +- .../com/atproto/server/describe_server.py | 12 +- .../server/get_account_invite_codes.py | 8 +- .../com/atproto/server/reserve_signing_key.py | 6 +- .../models/com/atproto/sync/get_blob.py | 4 +- .../models/com/atproto/sync/get_record.py | 4 +- .../models/com/atproto/sync/get_repo.py | 4 +- .../models/com/atproto/sync/list_repos.py | 2 +- .../com/atproto/sync/notify_of_update.py | 4 +- .../models/com/atproto/sync/request_crawl.py | 4 +- .../com/atproto/sync/subscribe_repos.py | 40 ++--- .../atproto_client/namespaces/async_ns.py | 138 +++++++++--------- packages/atproto_client/namespaces/sync_ns.py | 138 +++++++++--------- 142 files changed, 799 insertions(+), 491 deletions(-) create mode 100644 docs/source/atproto/atproto_client.client.methods_mixin.backward_compatibility.rst delete mode 100644 docs/source/atproto/atproto_client.client.methods_mixin.strong_ref_arg_backward_compatibility.rst diff --git a/docs/source/atproto/atproto_client.client.methods_mixin.backward_compatibility.rst b/docs/source/atproto/atproto_client.client.methods_mixin.backward_compatibility.rst new file mode 100644 index 00000000..24971194 --- /dev/null +++ b/docs/source/atproto/atproto_client.client.methods_mixin.backward_compatibility.rst @@ -0,0 +1,7 @@ +atproto\_client.client.methods\_mixin.backward\_compatibility +============================================================= + +.. automodule:: atproto_client.client.methods_mixin.backward_compatibility + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/atproto/atproto_client.client.methods_mixin.strong_ref_arg_backward_compatibility.rst b/docs/source/atproto/atproto_client.client.methods_mixin.strong_ref_arg_backward_compatibility.rst deleted file mode 100644 index fd1b19bb..00000000 --- a/docs/source/atproto/atproto_client.client.methods_mixin.strong_ref_arg_backward_compatibility.rst +++ /dev/null @@ -1,7 +0,0 @@ -atproto\_client.client.methods\_mixin.strong\_ref\_arg\_backward\_compatibility -=============================================================================== - -.. automodule:: atproto_client.client.methods_mixin.strong_ref_arg_backward_compatibility - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file diff --git a/lexicons/app.bsky.actor.defs.json b/lexicons/app.bsky.actor.defs.json index 9f8e2ea9..fa3772c4 100644 --- a/lexicons/app.bsky.actor.defs.json +++ b/lexicons/app.bsky.actor.defs.json @@ -1,7 +1,6 @@ { "lexicon": 1, "id": "app.bsky.actor.defs", - "description": "A reference to an actor in the network.", "defs": { "profileViewBasic": { "type": "object", @@ -78,6 +77,7 @@ }, "viewerState": { "type": "object", + "description": "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.", "properties": { "muted": { "type": "boolean" }, "mutedByList": { @@ -144,6 +144,9 @@ "type": "string", "format": "at-uri" } + }, + "timelineIndex": { + "type": "integer" } } }, diff --git a/lexicons/app.bsky.actor.getPreferences.json b/lexicons/app.bsky.actor.getPreferences.json index cbd6b60b..e6356a86 100644 --- a/lexicons/app.bsky.actor.getPreferences.json +++ b/lexicons/app.bsky.actor.getPreferences.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get private preferences attached to the account.", + "description": "Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.", "parameters": { "type": "params", "properties": {} diff --git a/lexicons/app.bsky.actor.getProfile.json b/lexicons/app.bsky.actor.getProfile.json index 1bb2ad2f..15b0fcc2 100644 --- a/lexicons/app.bsky.actor.getProfile.json +++ b/lexicons/app.bsky.actor.getProfile.json @@ -4,12 +4,16 @@ "defs": { "main": { "type": "query", - "description": "Get detailed profile view of an actor.", + "description": "Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth.", "parameters": { "type": "params", "required": ["actor"], "properties": { - "actor": { "type": "string", "format": "at-identifier" } + "actor": { + "type": "string", + "format": "at-identifier", + "description": "Handle or DID of account to fetch profile of." + } } }, "output": { diff --git a/lexicons/app.bsky.actor.getSuggestions.json b/lexicons/app.bsky.actor.getSuggestions.json index 74465dfd..2004ae6f 100644 --- a/lexicons/app.bsky.actor.getSuggestions.json +++ b/lexicons/app.bsky.actor.getSuggestions.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of suggested actors, used for discovery.", + "description": "Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.actor.profile.json b/lexicons/app.bsky.actor.profile.json index e1b7c6a2..feb083d5 100644 --- a/lexicons/app.bsky.actor.profile.json +++ b/lexicons/app.bsky.actor.profile.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "record", - "description": "A declaration of a profile.", + "description": "A declaration of a Bluesky account profile.", "key": "literal:self", "record": { "type": "object", @@ -16,21 +16,25 @@ }, "description": { "type": "string", + "description": "Free-form profile description text.", "maxGraphemes": 256, "maxLength": 2560 }, "avatar": { "type": "blob", + "description": "Small image to be displayed next to posts from account. AKA, 'profile picture'", "accept": ["image/png", "image/jpeg"], "maxSize": 1000000 }, "banner": { "type": "blob", + "description": "Larger horizontal image to display behind profile view.", "accept": ["image/png", "image/jpeg"], "maxSize": 1000000 }, "labels": { "type": "union", + "description": "Self-label values, specific to the Bluesky application, on the overall account.", "refs": ["com.atproto.label.defs#selfLabels"] } } diff --git a/lexicons/app.bsky.actor.searchActors.json b/lexicons/app.bsky.actor.searchActors.json index 48fbacf4..15ccb082 100644 --- a/lexicons/app.bsky.actor.searchActors.json +++ b/lexicons/app.bsky.actor.searchActors.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Find actors (profiles) matching search criteria.", + "description": "Find actors (profiles) matching search criteria. Does not require auth.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.actor.searchActorsTypeahead.json b/lexicons/app.bsky.actor.searchActorsTypeahead.json index 495b7081..4e3cb1b4 100644 --- a/lexicons/app.bsky.actor.searchActorsTypeahead.json +++ b/lexicons/app.bsky.actor.searchActorsTypeahead.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Find actor suggestions for a prefix search term.", + "description": "Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.embed.external.json b/lexicons/app.bsky.embed.external.json index 89463828..b9c8c159 100644 --- a/lexicons/app.bsky.embed.external.json +++ b/lexicons/app.bsky.embed.external.json @@ -1,10 +1,10 @@ { "lexicon": 1, "id": "app.bsky.embed.external", - "description": "A representation of some externally linked content, embedded in another form of content.", "defs": { "main": { "type": "object", + "description": "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).", "required": ["external"], "properties": { "external": { diff --git a/lexicons/app.bsky.embed.images.json b/lexicons/app.bsky.embed.images.json index 5baa7ab3..307607bb 100644 --- a/lexicons/app.bsky.embed.images.json +++ b/lexicons/app.bsky.embed.images.json @@ -1,7 +1,7 @@ { "lexicon": 1, "id": "app.bsky.embed.images", - "description": "A set of images embedded in some other form of content.", + "description": "A set of images embedded in a Bluesky record (eg, a post).", "defs": { "main": { "type": "object", @@ -23,7 +23,10 @@ "accept": ["image/*"], "maxSize": 1000000 }, - "alt": { "type": "string" }, + "alt": { + "type": "string", + "description": "Alt text description of the image, for accessibility." + }, "aspectRatio": { "type": "ref", "ref": "#aspectRatio" } } }, @@ -51,9 +54,18 @@ "type": "object", "required": ["thumb", "fullsize", "alt"], "properties": { - "thumb": { "type": "string" }, - "fullsize": { "type": "string" }, - "alt": { "type": "string" }, + "thumb": { + "type": "string", + "description": "Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View." + }, + "fullsize": { + "type": "string", + "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." + }, + "alt": { + "type": "string", + "description": "Alt text description of the image, for accessibility." + }, "aspectRatio": { "type": "ref", "ref": "#aspectRatio" } } } diff --git a/lexicons/app.bsky.embed.record.json b/lexicons/app.bsky.embed.record.json index 4b3d4f81..fff97302 100644 --- a/lexicons/app.bsky.embed.record.json +++ b/lexicons/app.bsky.embed.record.json @@ -1,7 +1,7 @@ { "lexicon": 1, "id": "app.bsky.embed.record", - "description": "A representation of a record embedded in another form of content.", + "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.", "defs": { "main": { "type": "object", @@ -36,7 +36,10 @@ "type": "ref", "ref": "app.bsky.actor.defs#profileViewBasic" }, - "value": { "type": "unknown" }, + "value": { + "type": "unknown", + "description": "The record data itself." + }, "labels": { "type": "array", "items": { "type": "ref", "ref": "com.atproto.label.defs#label" } diff --git a/lexicons/app.bsky.embed.recordWithMedia.json b/lexicons/app.bsky.embed.recordWithMedia.json index 9bc5fe09..46145464 100644 --- a/lexicons/app.bsky.embed.recordWithMedia.json +++ b/lexicons/app.bsky.embed.recordWithMedia.json @@ -1,7 +1,7 @@ { "lexicon": 1, "id": "app.bsky.embed.recordWithMedia", - "description": "A representation of a record embedded in another form of content, alongside other compatible embeds.", + "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.", "defs": { "main": { "type": "object", diff --git a/lexicons/app.bsky.feed.defs.json b/lexicons/app.bsky.feed.defs.json index 15a7cb7a..7f121e88 100644 --- a/lexicons/app.bsky.feed.defs.json +++ b/lexicons/app.bsky.feed.defs.json @@ -36,6 +36,7 @@ }, "viewerState": { "type": "object", + "description": "Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.", "properties": { "repost": { "type": "string", "format": "at-uri" }, "like": { "type": "string", "format": "at-uri" }, diff --git a/lexicons/app.bsky.feed.describeFeedGenerator.json b/lexicons/app.bsky.feed.describeFeedGenerator.json index f9502718..0c7b8c86 100644 --- a/lexicons/app.bsky.feed.describeFeedGenerator.json +++ b/lexicons/app.bsky.feed.describeFeedGenerator.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get information about a feed generator, including policies and offered feed URIs.", + "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).", "output": { "encoding": "application/json", "schema": { diff --git a/lexicons/app.bsky.feed.generator.json b/lexicons/app.bsky.feed.generator.json index 8c00884a..d0e361b7 100644 --- a/lexicons/app.bsky.feed.generator.json +++ b/lexicons/app.bsky.feed.generator.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "record", - "description": "A declaration of the existence of a feed generator.", + "description": "Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository.", "key": "any", "record": { "type": "object", @@ -32,6 +32,7 @@ }, "labels": { "type": "union", + "description": "Self-label values", "refs": ["com.atproto.label.defs#selfLabels"] }, "createdAt": { "type": "string", "format": "datetime" } diff --git a/lexicons/app.bsky.feed.getActorFeeds.json b/lexicons/app.bsky.feed.getActorFeeds.json index a0620477..9a7dae0a 100644 --- a/lexicons/app.bsky.feed.getActorFeeds.json +++ b/lexicons/app.bsky.feed.getActorFeeds.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of feeds created by the actor.", + "description": "Get a list of feeds (feed generator records) created by the actor (in the actor's repo).", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app.bsky.feed.getActorLikes.json b/lexicons/app.bsky.feed.getActorLikes.json index b3baa58a..22f8ed98 100644 --- a/lexicons/app.bsky.feed.getActorLikes.json +++ b/lexicons/app.bsky.feed.getActorLikes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of posts liked by an actor.", + "description": "Get a list of posts liked by an actor. Does not require auth.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app.bsky.feed.getAuthorFeed.json b/lexicons/app.bsky.feed.getAuthorFeed.json index 1939fa9a..90e4d1a7 100644 --- a/lexicons/app.bsky.feed.getAuthorFeed.json +++ b/lexicons/app.bsky.feed.getAuthorFeed.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a view of an actor's feed.", + "description": "Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.", "parameters": { "type": "params", "required": ["actor"], @@ -19,6 +19,7 @@ "cursor": { "type": "string" }, "filter": { "type": "string", + "description": "Combinations of post/repost types to include in response.", "knownValues": [ "posts_with_replies", "posts_no_replies", diff --git a/lexicons/app.bsky.feed.getFeed.json b/lexicons/app.bsky.feed.getFeed.json index 84407bde..ada3098b 100644 --- a/lexicons/app.bsky.feed.getFeed.json +++ b/lexicons/app.bsky.feed.getFeed.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a hydrated feed from an actor's selected feed generator.", + "description": "Get a hydrated feed from an actor's selected feed generator. Implemented by App View.", "parameters": { "type": "params", "required": ["feed"], diff --git a/lexicons/app.bsky.feed.getFeedGenerator.json b/lexicons/app.bsky.feed.getFeedGenerator.json index 8b3d4d05..190eca85 100644 --- a/lexicons/app.bsky.feed.getFeedGenerator.json +++ b/lexicons/app.bsky.feed.getFeedGenerator.json @@ -4,12 +4,16 @@ "defs": { "main": { "type": "query", - "description": "Get information about a feed generator.", + "description": "Get information about a feed generator. Implemented by AppView.", "parameters": { "type": "params", "required": ["feed"], "properties": { - "feed": { "type": "string", "format": "at-uri" } + "feed": { + "type": "string", + "format": "at-uri", + "description": "AT-URI of the feed generator record." + } } }, "output": { @@ -22,8 +26,14 @@ "type": "ref", "ref": "app.bsky.feed.defs#generatorView" }, - "isOnline": { "type": "boolean" }, - "isValid": { "type": "boolean" } + "isOnline": { + "type": "boolean", + "description": "Indicates whether the feed generator service has been online recently, or else seems to be inactive." + }, + "isValid": { + "type": "boolean", + "description": "Indicates whether the feed generator service is compatible with the record declaration." + } } } } diff --git a/lexicons/app.bsky.feed.getFeedSkeleton.json b/lexicons/app.bsky.feed.getFeedSkeleton.json index 03f3ba04..2bcaa13d 100644 --- a/lexicons/app.bsky.feed.getFeedSkeleton.json +++ b/lexicons/app.bsky.feed.getFeedSkeleton.json @@ -4,12 +4,16 @@ "defs": { "main": { "type": "query", - "description": "Get a skeleton of a feed provided by a feed generator.", + "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.", "parameters": { "type": "params", "required": ["feed"], "properties": { - "feed": { "type": "string", "format": "at-uri" }, + "feed": { + "type": "string", + "format": "at-uri", + "description": "Reference to feed generator record describing the specific feed being requested." + }, "limit": { "type": "integer", "minimum": 1, diff --git a/lexicons/app.bsky.feed.getLikes.json b/lexicons/app.bsky.feed.getLikes.json index ffcbc01a..d2c5b1a7 100644 --- a/lexicons/app.bsky.feed.getLikes.json +++ b/lexicons/app.bsky.feed.getLikes.json @@ -4,13 +4,21 @@ "defs": { "main": { "type": "query", - "description": "Get the list of likes.", + "description": "Get like records which reference a subject (by AT-URI and CID).", "parameters": { "type": "params", "required": ["uri"], "properties": { - "uri": { "type": "string", "format": "at-uri" }, - "cid": { "type": "string", "format": "cid" }, + "uri": { + "type": "string", + "format": "at-uri", + "description": "AT-URI of the subject (eg, a post record)." + }, + "cid": { + "type": "string", + "format": "cid", + "description": "CID of the subject record (aka, specific version of record), to filter likes." + }, "limit": { "type": "integer", "minimum": 1, diff --git a/lexicons/app.bsky.feed.getListFeed.json b/lexicons/app.bsky.feed.getListFeed.json index 4c5358fc..9dd9fdc7 100644 --- a/lexicons/app.bsky.feed.getListFeed.json +++ b/lexicons/app.bsky.feed.getListFeed.json @@ -4,12 +4,16 @@ "defs": { "main": { "type": "query", - "description": "Get a view of a recent posts from actors in a list.", + "description": "Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth.", "parameters": { "type": "params", "required": ["list"], "properties": { - "list": { "type": "string", "format": "at-uri" }, + "list": { + "type": "string", + "format": "at-uri", + "description": "Reference (AT-URI) to the list record." + }, "limit": { "type": "integer", "minimum": 1, diff --git a/lexicons/app.bsky.feed.getPostThread.json b/lexicons/app.bsky.feed.getPostThread.json index b9836170..89e99d9c 100644 --- a/lexicons/app.bsky.feed.getPostThread.json +++ b/lexicons/app.bsky.feed.getPostThread.json @@ -4,20 +4,26 @@ "defs": { "main": { "type": "query", - "description": "Get posts in a thread.", + "description": "Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests.", "parameters": { "type": "params", "required": ["uri"], "properties": { - "uri": { "type": "string", "format": "at-uri" }, + "uri": { + "type": "string", + "format": "at-uri", + "description": "Reference (AT-URI) to post record." + }, "depth": { "type": "integer", + "description": "How many levels of reply depth should be included in response.", "default": 6, "minimum": 0, "maximum": 1000 }, "parentHeight": { "type": "integer", + "description": "How many levels of parent (and grandparent, etc) post to include.", "default": 80, "minimum": 0, "maximum": 1000 diff --git a/lexicons/app.bsky.feed.getPosts.json b/lexicons/app.bsky.feed.getPosts.json index c985a5cf..e555ee16 100644 --- a/lexicons/app.bsky.feed.getPosts.json +++ b/lexicons/app.bsky.feed.getPosts.json @@ -4,13 +4,14 @@ "defs": { "main": { "type": "query", - "description": "Get a view of an actor's feed.", + "description": "Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'.", "parameters": { "type": "params", "required": ["uris"], "properties": { "uris": { "type": "array", + "description": "List of post AT-URIs to return hydrated views for.", "items": { "type": "string", "format": "at-uri" }, "maxLength": 25 } diff --git a/lexicons/app.bsky.feed.getRepostedBy.json b/lexicons/app.bsky.feed.getRepostedBy.json index 99abc6d5..db395346 100644 --- a/lexicons/app.bsky.feed.getRepostedBy.json +++ b/lexicons/app.bsky.feed.getRepostedBy.json @@ -4,13 +4,21 @@ "defs": { "main": { "type": "query", - "description": "Get a list of reposts.", + "description": "Get a list of reposts for a given post.", "parameters": { "type": "params", "required": ["uri"], "properties": { - "uri": { "type": "string", "format": "at-uri" }, - "cid": { "type": "string", "format": "cid" }, + "uri": { + "type": "string", + "format": "at-uri", + "description": "Reference (AT-URI) of post record" + }, + "cid": { + "type": "string", + "format": "cid", + "description": "If supplied, filters to reposts of specific version (by CID) of the post record." + }, "limit": { "type": "integer", "minimum": 1, diff --git a/lexicons/app.bsky.feed.getSuggestedFeeds.json b/lexicons/app.bsky.feed.getSuggestedFeeds.json index de7c4fef..e643d339 100644 --- a/lexicons/app.bsky.feed.getSuggestedFeeds.json +++ b/lexicons/app.bsky.feed.getSuggestedFeeds.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of suggested feeds for the viewer.", + "description": "Get a list of suggested feeds (feed generators) for the requesting account.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.feed.getTimeline.json b/lexicons/app.bsky.feed.getTimeline.json index c3b11638..816380fe 100644 --- a/lexicons/app.bsky.feed.getTimeline.json +++ b/lexicons/app.bsky.feed.getTimeline.json @@ -4,11 +4,14 @@ "defs": { "main": { "type": "query", - "description": "Get a view of the actor's home timeline.", + "description": "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.", "parameters": { "type": "params", "properties": { - "algorithm": { "type": "string" }, + "algorithm": { + "type": "string", + "description": "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism." + }, "limit": { "type": "integer", "minimum": 1, diff --git a/lexicons/app.bsky.feed.like.json b/lexicons/app.bsky.feed.like.json index d82f93bb..c0de3b71 100644 --- a/lexicons/app.bsky.feed.like.json +++ b/lexicons/app.bsky.feed.like.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "record", - "description": "A declaration of a like.", + "description": "Record declaring a 'like' of a piece of subject content.", "key": "tid", "record": { "type": "object", diff --git a/lexicons/app.bsky.feed.post.json b/lexicons/app.bsky.feed.post.json index d5f92969..b9b236b4 100644 --- a/lexicons/app.bsky.feed.post.json +++ b/lexicons/app.bsky.feed.post.json @@ -4,20 +4,26 @@ "defs": { "main": { "type": "record", - "description": "A declaration of a post.", + "description": "Record containing a Bluesky post.", "key": "tid", "record": { "type": "object", "required": ["text", "createdAt"], "properties": { - "text": { "type": "string", "maxLength": 3000, "maxGraphemes": 300 }, + "text": { + "type": "string", + "maxLength": 3000, + "maxGraphemes": 300, + "description": "The primary post content. May be an empty string, if there are embeds." + }, "entities": { "type": "array", - "description": "Deprecated: replaced by app.bsky.richtext.facet.", + "description": "DEPRECATED: replaced by app.bsky.richtext.facet.", "items": { "type": "ref", "ref": "#entity" } }, "facets": { "type": "array", + "description": "Annotations of text (mentions, URLs, hashtags, etc)", "items": { "type": "ref", "ref": "app.bsky.richtext.facet" } }, "reply": { "type": "ref", "ref": "#replyRef" }, @@ -32,20 +38,26 @@ }, "langs": { "type": "array", + "description": "Indicates human language of post primary text content.", "maxLength": 3, "items": { "type": "string", "format": "language" } }, "labels": { "type": "union", + "description": "Self-label values for this post. Effectively content warnings.", "refs": ["com.atproto.label.defs#selfLabels"] }, "tags": { "type": "array", + "description": "Additional hashtags, in addition to any included in post text and facets.", "maxLength": 8, - "items": { "type": "string", "maxLength": 640, "maxGraphemes": 64 }, - "description": "Additional non-inline tags describing this post." + "items": { "type": "string", "maxLength": 640, "maxGraphemes": 64 } }, - "createdAt": { "type": "string", "format": "datetime" } + "createdAt": { + "type": "string", + "format": "datetime", + "description": "Client-declared timestamp when this post was originally created." + } } } }, diff --git a/lexicons/app.bsky.feed.repost.json b/lexicons/app.bsky.feed.repost.json index 4dbef10b..028fd627 100644 --- a/lexicons/app.bsky.feed.repost.json +++ b/lexicons/app.bsky.feed.repost.json @@ -3,7 +3,7 @@ "id": "app.bsky.feed.repost", "defs": { "main": { - "description": "A declaration of a repost.", + "description": "Record representing a 'repost' of an existing Bluesky post.", "type": "record", "key": "tid", "record": { diff --git a/lexicons/app.bsky.feed.searchPosts.json b/lexicons/app.bsky.feed.searchPosts.json index a3e0bc47..c89655dd 100644 --- a/lexicons/app.bsky.feed.searchPosts.json +++ b/lexicons/app.bsky.feed.searchPosts.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Find posts matching search criteria.", + "description": "Find posts matching search criteria, returning views of those posts.", "parameters": { "type": "params", "required": ["q"], diff --git a/lexicons/app.bsky.feed.threadgate.json b/lexicons/app.bsky.feed.threadgate.json index 7969b636..ff258da4 100644 --- a/lexicons/app.bsky.feed.threadgate.json +++ b/lexicons/app.bsky.feed.threadgate.json @@ -5,12 +5,16 @@ "main": { "type": "record", "key": "tid", - "description": "Defines interaction gating rules for a thread. The rkey of the threadgate record should match the rkey of the thread's root post.", + "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..", "record": { "type": "object", "required": ["post", "createdAt"], "properties": { - "post": { "type": "string", "format": "at-uri" }, + "post": { + "type": "string", + "format": "at-uri", + "description": "Reference (AT-URI) to the post record." + }, "allow": { "type": "array", "maxLength": 5, diff --git a/lexicons/app.bsky.graph.block.json b/lexicons/app.bsky.graph.block.json index 6231eb04..b64b11a9 100644 --- a/lexicons/app.bsky.graph.block.json +++ b/lexicons/app.bsky.graph.block.json @@ -4,13 +4,17 @@ "defs": { "main": { "type": "record", - "description": "A declaration of a block.", + "description": "Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details.", "key": "tid", "record": { "type": "object", "required": ["subject", "createdAt"], "properties": { - "subject": { "type": "string", "format": "did" }, + "subject": { + "type": "string", + "format": "did", + "description": "DID of the account to be blocked." + }, "createdAt": { "type": "string", "format": "datetime" } } } diff --git a/lexicons/app.bsky.graph.follow.json b/lexicons/app.bsky.graph.follow.json index df4f4319..dd6347ac 100644 --- a/lexicons/app.bsky.graph.follow.json +++ b/lexicons/app.bsky.graph.follow.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "record", - "description": "A declaration of a social follow.", + "description": "Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView.", "key": "tid", "record": { "type": "object", diff --git a/lexicons/app.bsky.graph.getBlocks.json b/lexicons/app.bsky.graph.getBlocks.json index bbfe956f..79a28f66 100644 --- a/lexicons/app.bsky.graph.getBlocks.json +++ b/lexicons/app.bsky.graph.getBlocks.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of who the actor is blocking.", + "description": "Enumerates which accounts the requesting account is currently blocking. Requires auth.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.graph.getFollowers.json b/lexicons/app.bsky.graph.getFollowers.json index 378c7a7a..a6c4facd 100644 --- a/lexicons/app.bsky.graph.getFollowers.json +++ b/lexicons/app.bsky.graph.getFollowers.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of an actor's followers.", + "description": "Enumerates accounts which follow a specified account (actor).", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app.bsky.graph.getFollows.json b/lexicons/app.bsky.graph.getFollows.json index b90f7613..81f1b6ab 100644 --- a/lexicons/app.bsky.graph.getFollows.json +++ b/lexicons/app.bsky.graph.getFollows.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of who the actor follows.", + "description": "Enumerates accounts which a specified account (actor) follows.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app.bsky.graph.getList.json b/lexicons/app.bsky.graph.getList.json index fd24668e..cb95a003 100644 --- a/lexicons/app.bsky.graph.getList.json +++ b/lexicons/app.bsky.graph.getList.json @@ -4,12 +4,16 @@ "defs": { "main": { "type": "query", - "description": "Get a list of actors.", + "description": "Gets a 'view' (with additional context) of a specified list.", "parameters": { "type": "params", "required": ["list"], "properties": { - "list": { "type": "string", "format": "at-uri" }, + "list": { + "type": "string", + "format": "at-uri", + "description": "Reference (AT-URI) of the list record to hydrate." + }, "limit": { "type": "integer", "minimum": 1, diff --git a/lexicons/app.bsky.graph.getListBlocks.json b/lexicons/app.bsky.graph.getListBlocks.json index 9f9f5982..1bc97661 100644 --- a/lexicons/app.bsky.graph.getListBlocks.json +++ b/lexicons/app.bsky.graph.getListBlocks.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get lists that the actor is blocking.", + "description": "Get mod lists that the requesting account (actor) is blocking. Requires auth.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.graph.getListMutes.json b/lexicons/app.bsky.graph.getListMutes.json index 8d42ac40..a56a8257 100644 --- a/lexicons/app.bsky.graph.getListMutes.json +++ b/lexicons/app.bsky.graph.getListMutes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get lists that the actor is muting.", + "description": "Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.graph.getLists.json b/lexicons/app.bsky.graph.getLists.json index 602dd153..127b13e5 100644 --- a/lexicons/app.bsky.graph.getLists.json +++ b/lexicons/app.bsky.graph.getLists.json @@ -4,12 +4,16 @@ "defs": { "main": { "type": "query", - "description": "Get a list of lists that belong to an actor.", + "description": "Enumerates the lists created by a specified account (actor).", "parameters": { "type": "params", "required": ["actor"], "properties": { - "actor": { "type": "string", "format": "at-identifier" }, + "actor": { + "type": "string", + "format": "at-identifier", + "description": "The account (actor) to enumerate lists from." + }, "limit": { "type": "integer", "minimum": 1, diff --git a/lexicons/app.bsky.graph.getMutes.json b/lexicons/app.bsky.graph.getMutes.json index 8ceae00f..22eaf0d3 100644 --- a/lexicons/app.bsky.graph.getMutes.json +++ b/lexicons/app.bsky.graph.getMutes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of who the actor mutes.", + "description": "Enumerates accounts that the requesting account (actor) currently has muted. Requires auth.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.graph.getRelationships.json b/lexicons/app.bsky.graph.getRelationships.json index ccd495de..03490a25 100644 --- a/lexicons/app.bsky.graph.getRelationships.json +++ b/lexicons/app.bsky.graph.getRelationships.json @@ -4,14 +4,19 @@ "defs": { "main": { "type": "query", - "description": "Enumerates public relationships between one account, and a list of other accounts", + "description": "Enumerates public relationships between one account, and a list of other accounts. Does not require auth.", "parameters": { "type": "params", "required": ["actor"], "properties": { - "actor": { "type": "string", "format": "at-identifier" }, + "actor": { + "type": "string", + "format": "at-identifier", + "description": "Primary account requesting relationships for." + }, "others": { "type": "array", + "description": "List of 'other' accounts to be related back to the primary.", "maxLength": 30, "items": { "type": "string", diff --git a/lexicons/app.bsky.graph.getSuggestedFollowsByActor.json b/lexicons/app.bsky.graph.getSuggestedFollowsByActor.json index 32873a53..5b0cfdeb 100644 --- a/lexicons/app.bsky.graph.getSuggestedFollowsByActor.json +++ b/lexicons/app.bsky.graph.getSuggestedFollowsByActor.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get suggested follows related to a given actor.", + "description": "Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app.bsky.graph.list.json b/lexicons/app.bsky.graph.list.json index ccc845a6..13111412 100644 --- a/lexicons/app.bsky.graph.list.json +++ b/lexicons/app.bsky.graph.list.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "record", - "description": "A declaration of a list of actors.", + "description": "Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists.", "key": "tid", "record": { "type": "object", @@ -12,9 +12,15 @@ "properties": { "purpose": { "type": "ref", + "description": "Defines the purpose of the list (aka, moderation-oriented or curration-oriented)", "ref": "app.bsky.graph.defs#listPurpose" }, - "name": { "type": "string", "maxLength": 64, "minLength": 1 }, + "name": { + "type": "string", + "maxLength": 64, + "minLength": 1, + "description": "Display name for list; can not be empty." + }, "description": { "type": "string", "maxGraphemes": 300, diff --git a/lexicons/app.bsky.graph.listblock.json b/lexicons/app.bsky.graph.listblock.json index b3a839c5..df2e17f3 100644 --- a/lexicons/app.bsky.graph.listblock.json +++ b/lexicons/app.bsky.graph.listblock.json @@ -4,13 +4,17 @@ "defs": { "main": { "type": "record", - "description": "A block of an entire list of actors.", + "description": "Record representing a block relationship against an entire an entire list of accounts (actors).", "key": "tid", "record": { "type": "object", "required": ["subject", "createdAt"], "properties": { - "subject": { "type": "string", "format": "at-uri" }, + "subject": { + "type": "string", + "format": "at-uri", + "description": "Reference (AT-URI) to the mod list record." + }, "createdAt": { "type": "string", "format": "datetime" } } } diff --git a/lexicons/app.bsky.graph.listitem.json b/lexicons/app.bsky.graph.listitem.json index 2eafb134..adbd96e7 100644 --- a/lexicons/app.bsky.graph.listitem.json +++ b/lexicons/app.bsky.graph.listitem.json @@ -4,14 +4,22 @@ "defs": { "main": { "type": "record", - "description": "An item under a declared list of actors.", + "description": "Record representing an account's inclusion on a specific list. The AppView will ignore duplicate listitem records.", "key": "tid", "record": { "type": "object", "required": ["subject", "list", "createdAt"], "properties": { - "subject": { "type": "string", "format": "did" }, - "list": { "type": "string", "format": "at-uri" }, + "subject": { + "type": "string", + "format": "did", + "description": "The account which is included on the list." + }, + "list": { + "type": "string", + "format": "at-uri", + "description": "Reference (AT-URI) to the list record (app.bsky.graph.list)." + }, "createdAt": { "type": "string", "format": "datetime" } } } diff --git a/lexicons/app.bsky.graph.muteActor.json b/lexicons/app.bsky.graph.muteActor.json index f1c3dd18..c2bf09a3 100644 --- a/lexicons/app.bsky.graph.muteActor.json +++ b/lexicons/app.bsky.graph.muteActor.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Mute an actor by DID or handle.", + "description": "Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app.bsky.graph.muteActorList.json b/lexicons/app.bsky.graph.muteActorList.json index c75cc783..ad05e634 100644 --- a/lexicons/app.bsky.graph.muteActorList.json +++ b/lexicons/app.bsky.graph.muteActorList.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Mute a list of actors.", + "description": "Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app.bsky.graph.unmuteActor.json b/lexicons/app.bsky.graph.unmuteActor.json index 114af204..bcea72db 100644 --- a/lexicons/app.bsky.graph.unmuteActor.json +++ b/lexicons/app.bsky.graph.unmuteActor.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Unmute an actor by DID or handle.", + "description": "Unmutes the specified account. Requires auth.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app.bsky.graph.unmuteActorList.json b/lexicons/app.bsky.graph.unmuteActorList.json index d9644cdd..a597838e 100644 --- a/lexicons/app.bsky.graph.unmuteActorList.json +++ b/lexicons/app.bsky.graph.unmuteActorList.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Unmute a list of actors.", + "description": "Unmutes the specified list of accounts. Requires auth.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app.bsky.notification.getUnreadCount.json b/lexicons/app.bsky.notification.getUnreadCount.json index ab716b2a..5eebbbf4 100644 --- a/lexicons/app.bsky.notification.getUnreadCount.json +++ b/lexicons/app.bsky.notification.getUnreadCount.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get the count of unread notifications.", + "description": "Count the number of unread notifications for the requesting account. Requires auth.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.notification.listNotifications.json b/lexicons/app.bsky.notification.listNotifications.json index ea74c5fb..6c5095e1 100644 --- a/lexicons/app.bsky.notification.listNotifications.json +++ b/lexicons/app.bsky.notification.listNotifications.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a list of notifications.", + "description": "Enumerate notifications for the requesting account. Requires auth.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app.bsky.notification.registerPush.json b/lexicons/app.bsky.notification.registerPush.json index 80819ece..c4e50d11 100644 --- a/lexicons/app.bsky.notification.registerPush.json +++ b/lexicons/app.bsky.notification.registerPush.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Register for push notifications with a service.", + "description": "Register to receive push notifications, via a specified service, for the requesting account. Requires auth.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app.bsky.notification.updateSeen.json b/lexicons/app.bsky.notification.updateSeen.json index 33626343..84bb0e7d 100644 --- a/lexicons/app.bsky.notification.updateSeen.json +++ b/lexicons/app.bsky.notification.updateSeen.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Notify server that the user has seen notifications.", + "description": "Notify server that the requesting account has seen notifications. Requires auth.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app.bsky.richtext.facet.json b/lexicons/app.bsky.richtext.facet.json index ea8f2cba..388a3a5e 100644 --- a/lexicons/app.bsky.richtext.facet.json +++ b/lexicons/app.bsky.richtext.facet.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "object", + "description": "Annotation of a sub-string within rich text.", "required": ["index", "features"], "properties": { "index": { "type": "ref", "ref": "#byteSlice" }, @@ -15,7 +16,7 @@ }, "mention": { "type": "object", - "description": "A facet feature for actor mentions.", + "description": "Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.", "required": ["did"], "properties": { "did": { "type": "string", "format": "did" } @@ -23,7 +24,7 @@ }, "link": { "type": "object", - "description": "A facet feature for links.", + "description": "Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.", "required": ["uri"], "properties": { "uri": { "type": "string", "format": "uri" } @@ -31,7 +32,7 @@ }, "tag": { "type": "object", - "description": "A hashtag.", + "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').", "required": ["tag"], "properties": { "tag": { "type": "string", "maxLength": 640, "maxGraphemes": 64 } @@ -39,7 +40,7 @@ }, "byteSlice": { "type": "object", - "description": "A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.", + "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.", "required": ["byteStart", "byteEnd"], "properties": { "byteStart": { "type": "integer", "minimum": 0 }, diff --git a/lexicons/com.atproto.identity.resolveHandle.json b/lexicons/com.atproto.identity.resolveHandle.json index ae5aab8f..95885088 100644 --- a/lexicons/com.atproto.identity.resolveHandle.json +++ b/lexicons/com.atproto.identity.resolveHandle.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Provides the DID of a repo.", + "description": "Resolves a handle (domain name) to a DID.", "parameters": { "type": "params", "required": ["handle"], diff --git a/lexicons/com.atproto.identity.updateHandle.json b/lexicons/com.atproto.identity.updateHandle.json index 5fe392bb..9bb5c347 100644 --- a/lexicons/com.atproto.identity.updateHandle.json +++ b/lexicons/com.atproto.identity.updateHandle.json @@ -4,14 +4,18 @@ "defs": { "main": { "type": "procedure", - "description": "Updates the handle of the account.", + "description": "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.", "input": { "encoding": "application/json", "schema": { "type": "object", "required": ["handle"], "properties": { - "handle": { "type": "string", "format": "handle" } + "handle": { + "type": "string", + "format": "handle", + "description": "The new handle." + } } } } diff --git a/lexicons/com.atproto.label.queryLabels.json b/lexicons/com.atproto.label.queryLabels.json index 7b6fbe23..6c81cb0b 100644 --- a/lexicons/com.atproto.label.queryLabels.json +++ b/lexicons/com.atproto.label.queryLabels.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Find labels relevant to the provided URI patterns.", + "description": "Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.", "parameters": { "type": "params", "required": ["uriPatterns"], diff --git a/lexicons/com.atproto.label.subscribeLabels.json b/lexicons/com.atproto.label.subscribeLabels.json index 9813ffc1..5fb1a852 100644 --- a/lexicons/com.atproto.label.subscribeLabels.json +++ b/lexicons/com.atproto.label.subscribeLabels.json @@ -4,13 +4,13 @@ "defs": { "main": { "type": "subscription", - "description": "Subscribe to label updates.", + "description": "Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.", "parameters": { "type": "params", "properties": { "cursor": { "type": "integer", - "description": "The last known event to backfill from." + "description": "The last known event seq number to backfill from." } } }, diff --git a/lexicons/com.atproto.moderation.createReport.json b/lexicons/com.atproto.moderation.createReport.json index 161d622f..f41d28d0 100644 --- a/lexicons/com.atproto.moderation.createReport.json +++ b/lexicons/com.atproto.moderation.createReport.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Report a repo or a record.", + "description": "Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.", "input": { "encoding": "application/json", "schema": { @@ -13,9 +13,13 @@ "properties": { "reasonType": { "type": "ref", + "description": "Indicates the broad category of violation the report is for.", "ref": "com.atproto.moderation.defs#reasonType" }, - "reason": { "type": "string" }, + "reason": { + "type": "string", + "description": "Additional context about the content and violation." + }, "subject": { "type": "union", "refs": [ diff --git a/lexicons/com.atproto.repo.applyWrites.json b/lexicons/com.atproto.repo.applyWrites.json index 050b6efb..427fc84c 100644 --- a/lexicons/com.atproto.repo.applyWrites.json +++ b/lexicons/com.atproto.repo.applyWrites.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Apply a batch transaction of creates, updates, and deletes.", + "description": "Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.", "input": { "encoding": "application/json", "schema": { @@ -14,12 +14,12 @@ "repo": { "type": "string", "format": "at-identifier", - "description": "The handle or DID of the repo." + "description": "The handle or DID of the repo (aka, current account)." }, "validate": { "type": "boolean", "default": true, - "description": "Flag for validating the records." + "description": "Can be set to 'false' to skip Lexicon schema validation of record data, for all operations." }, "writes": { "type": "array", @@ -31,16 +31,22 @@ }, "swapCommit": { "type": "string", + "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.", "format": "cid" } } } }, - "errors": [{ "name": "InvalidSwap" }] + "errors": [ + { + "name": "InvalidSwap", + "description": "Indicates that the 'swapCommit' parameter did not match current commit." + } + ] }, "create": { "type": "object", - "description": "Create a new record.", + "description": "Operation which creates a new record.", "required": ["collection", "value"], "properties": { "collection": { "type": "string", "format": "nsid" }, @@ -50,7 +56,7 @@ }, "update": { "type": "object", - "description": "Update an existing record.", + "description": "Operation which updates an existing record.", "required": ["collection", "rkey", "value"], "properties": { "collection": { "type": "string", "format": "nsid" }, @@ -60,7 +66,7 @@ }, "delete": { "type": "object", - "description": "Delete an existing record.", + "description": "Operation which deletes an existing record.", "required": ["collection", "rkey"], "properties": { "collection": { "type": "string", "format": "nsid" }, diff --git a/lexicons/com.atproto.repo.createRecord.json b/lexicons/com.atproto.repo.createRecord.json index baef20c8..185f5250 100644 --- a/lexicons/com.atproto.repo.createRecord.json +++ b/lexicons/com.atproto.repo.createRecord.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Create a new record.", + "description": "Create a single new repository record. Requires auth, implemented by PDS.", "input": { "encoding": "application/json", "schema": { @@ -14,7 +14,7 @@ "repo": { "type": "string", "format": "at-identifier", - "description": "The handle or DID of the repo." + "description": "The handle or DID of the repo (aka, current account)." }, "collection": { "type": "string", @@ -23,17 +23,17 @@ }, "rkey": { "type": "string", - "description": "The key of the record.", + "description": "The Record Key.", "maxLength": 15 }, "validate": { "type": "boolean", "default": true, - "description": "Flag for validating the record." + "description": "Can be set to 'false' to skip Lexicon schema validation of record data." }, "record": { "type": "unknown", - "description": "The record to create." + "description": "The record itself. Must contain a $type field." }, "swapCommit": { "type": "string", @@ -54,7 +54,12 @@ } } }, - "errors": [{ "name": "InvalidSwap" }] + "errors": [ + { + "name": "InvalidSwap", + "description": "Indicates that 'swapCommit' didn't match current repo commit." + } + ] } } } diff --git a/lexicons/com.atproto.repo.deleteRecord.json b/lexicons/com.atproto.repo.deleteRecord.json index d8d7955b..65b9f8f9 100644 --- a/lexicons/com.atproto.repo.deleteRecord.json +++ b/lexicons/com.atproto.repo.deleteRecord.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Delete a record, or ensure it doesn't exist.", + "description": "Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.", "input": { "encoding": "application/json", "schema": { @@ -14,7 +14,7 @@ "repo": { "type": "string", "format": "at-identifier", - "description": "The handle or DID of the repo." + "description": "The handle or DID of the repo (aka, current account)." }, "collection": { "type": "string", @@ -23,7 +23,7 @@ }, "rkey": { "type": "string", - "description": "The key of the record." + "description": "The Record Key." }, "swapRecord": { "type": "string", diff --git a/lexicons/com.atproto.repo.describeRepo.json b/lexicons/com.atproto.repo.describeRepo.json index b7f283bf..b1ce2b6c 100644 --- a/lexicons/com.atproto.repo.describeRepo.json +++ b/lexicons/com.atproto.repo.describeRepo.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get information about the repo, including the list of collections.", + "description": "Get information about an account and repository, including the list of collections. Does not require auth.", "parameters": { "type": "params", "required": ["repo"], @@ -30,12 +30,19 @@ "properties": { "handle": { "type": "string", "format": "handle" }, "did": { "type": "string", "format": "did" }, - "didDoc": { "type": "unknown" }, + "didDoc": { + "type": "unknown", + "description": "The complete DID document for this account." + }, "collections": { "type": "array", + "description": "List of all the collections (NSIDs) for which this repo contains at least one record.", "items": { "type": "string", "format": "nsid" } }, - "handleIsCorrect": { "type": "boolean" } + "handleIsCorrect": { + "type": "boolean", + "description": "Indicates if handle is currently valid (resolves bi-directionally)" + } } } } diff --git a/lexicons/com.atproto.repo.getRecord.json b/lexicons/com.atproto.repo.getRecord.json index ec4d17e4..5d8bb173 100644 --- a/lexicons/com.atproto.repo.getRecord.json +++ b/lexicons/com.atproto.repo.getRecord.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a record.", + "description": "Get a single record from a repository. Does not require auth.", "parameters": { "type": "params", "required": ["repo", "collection", "rkey"], @@ -19,7 +19,7 @@ "format": "nsid", "description": "The NSID of the record collection." }, - "rkey": { "type": "string", "description": "The key of the record." }, + "rkey": { "type": "string", "description": "The Record Key." }, "cid": { "type": "string", "format": "cid", diff --git a/lexicons/com.atproto.repo.listRecords.json b/lexicons/com.atproto.repo.listRecords.json index ac04e3e8..bc91c952 100644 --- a/lexicons/com.atproto.repo.listRecords.json +++ b/lexicons/com.atproto.repo.listRecords.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "List a range of records in a collection.", + "description": "List a range of records in a repository, matching a specific collection. Does not require auth.", "parameters": { "type": "params", "required": ["repo", "collection"], diff --git a/lexicons/com.atproto.repo.putRecord.json b/lexicons/com.atproto.repo.putRecord.json index ae39bd95..51f11c0f 100644 --- a/lexicons/com.atproto.repo.putRecord.json +++ b/lexicons/com.atproto.repo.putRecord.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Write a record, creating or updating it as needed.", + "description": "Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.", "input": { "encoding": "application/json", "schema": { @@ -15,7 +15,7 @@ "repo": { "type": "string", "format": "at-identifier", - "description": "The handle or DID of the repo." + "description": "The handle or DID of the repo (aka, current account)." }, "collection": { "type": "string", @@ -24,13 +24,13 @@ }, "rkey": { "type": "string", - "description": "The key of the record.", + "description": "The Record Key.", "maxLength": 15 }, "validate": { "type": "boolean", "default": true, - "description": "Flag for validating the record." + "description": "Can be set to 'false' to skip Lexicon schema validation of record data." }, "record": { "type": "unknown", @@ -39,7 +39,7 @@ "swapRecord": { "type": "string", "format": "cid", - "description": "Compare and swap with the previous record by CID." + "description": "Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation" }, "swapCommit": { "type": "string", diff --git a/lexicons/com.atproto.repo.uploadBlob.json b/lexicons/com.atproto.repo.uploadBlob.json index 63d1671b..547a995a 100644 --- a/lexicons/com.atproto.repo.uploadBlob.json +++ b/lexicons/com.atproto.repo.uploadBlob.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Upload a new blob to be added to repo in a later request.", + "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.", "input": { "encoding": "*/*" }, diff --git a/lexicons/com.atproto.server.createAccount.json b/lexicons/com.atproto.server.createAccount.json index d1456e09..b32bbe15 100644 --- a/lexicons/com.atproto.server.createAccount.json +++ b/lexicons/com.atproto.server.createAccount.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Create an account.", + "description": "Create an account. Implemented by PDS.", "input": { "encoding": "application/json", "schema": { @@ -12,14 +12,31 @@ "required": ["handle"], "properties": { "email": { "type": "string" }, - "handle": { "type": "string", "format": "handle" }, - "did": { "type": "string", "format": "did" }, + "handle": { + "type": "string", + "format": "handle", + "description": "Requested handle for the account." + }, + "did": { + "type": "string", + "format": "did", + "description": "Pre-existing atproto DID, being imported to a new account." + }, "inviteCode": { "type": "string" }, "verificationCode": { "type": "string" }, "verificationPhone": { "type": "string" }, - "password": { "type": "string" }, - "recoveryKey": { "type": "string" }, - "plcOp": { "type": "unknown" } + "password": { + "type": "string", + "description": "Initial account password. May need to meet instance-specific password strength requirements." + }, + "recoveryKey": { + "type": "string", + "description": "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation." + }, + "plcOp": { + "type": "unknown", + "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." + } } } }, @@ -27,13 +44,21 @@ "encoding": "application/json", "schema": { "type": "object", + "description": "Account login session returned on successful account creation.", "required": ["accessJwt", "refreshJwt", "handle", "did"], "properties": { "accessJwt": { "type": "string" }, "refreshJwt": { "type": "string" }, "handle": { "type": "string", "format": "handle" }, - "did": { "type": "string", "format": "did" }, - "didDoc": { "type": "unknown" } + "did": { + "type": "string", + "format": "did", + "description": "The DID of the new account." + }, + "didDoc": { + "type": "unknown", + "description": "Complete DID document." + } } } }, diff --git a/lexicons/com.atproto.server.createAppPassword.json b/lexicons/com.atproto.server.createAppPassword.json index f12e8e25..0a60e4e3 100644 --- a/lexicons/com.atproto.server.createAppPassword.json +++ b/lexicons/com.atproto.server.createAppPassword.json @@ -11,7 +11,10 @@ "type": "object", "required": ["name"], "properties": { - "name": { "type": "string" } + "name": { + "type": "string", + "description": "A short name for the App Password, to help distinguish them." + } } } }, diff --git a/lexicons/com.atproto.server.deleteAccount.json b/lexicons/com.atproto.server.deleteAccount.json index 3747189d..cf4babfe 100644 --- a/lexicons/com.atproto.server.deleteAccount.json +++ b/lexicons/com.atproto.server.deleteAccount.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Delete an actor's account with a token and password.", + "description": "Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com.atproto.server.deleteSession.json b/lexicons/com.atproto.server.deleteSession.json index e05d0190..807a89dc 100644 --- a/lexicons/com.atproto.server.deleteSession.json +++ b/lexicons/com.atproto.server.deleteSession.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Delete the current session." + "description": "Delete the current session. Requires auth." } } } diff --git a/lexicons/com.atproto.server.describeServer.json b/lexicons/com.atproto.server.describeServer.json index 3c60a58e..908cb212 100644 --- a/lexicons/com.atproto.server.describeServer.json +++ b/lexicons/com.atproto.server.describeServer.json @@ -4,20 +4,31 @@ "defs": { "main": { "type": "query", - "description": "Get a document describing the service's accounts configuration.", + "description": "Describes the server's account creation requirements and capabilities. Implemented by PDS.", "output": { "encoding": "application/json", "schema": { "type": "object", "required": ["availableUserDomains"], "properties": { - "inviteCodeRequired": { "type": "boolean" }, - "phoneVerificationRequired": { "type": "boolean" }, + "inviteCodeRequired": { + "type": "boolean", + "description": "If true, an invite code must be supplied to create an account on this instance." + }, + "phoneVerificationRequired": { + "type": "boolean", + "description": "If true, a phone verification token must be supplied to create an account on this instance." + }, "availableUserDomains": { "type": "array", + "description": "List of domain suffixes that can be used in account handles.", "items": { "type": "string" } }, - "links": { "type": "ref", "ref": "#links" } + "links": { + "type": "ref", + "description": "URLs of service policy documents.", + "ref": "#links" + } } } } diff --git a/lexicons/com.atproto.server.getAccountInviteCodes.json b/lexicons/com.atproto.server.getAccountInviteCodes.json index ac23b11f..72f08227 100644 --- a/lexicons/com.atproto.server.getAccountInviteCodes.json +++ b/lexicons/com.atproto.server.getAccountInviteCodes.json @@ -4,12 +4,16 @@ "defs": { "main": { "type": "query", - "description": "Get all invite codes for a given account.", + "description": "Get all invite codes for the current account. Requires auth.", "parameters": { "type": "params", "properties": { "includeUsed": { "type": "boolean", "default": true }, - "createAvailable": { "type": "boolean", "default": true } + "createAvailable": { + "type": "boolean", + "default": true, + "description": "Controls whether any new 'earned' but not 'created' invites should be created." + } } }, "output": { diff --git a/lexicons/com.atproto.server.getSession.json b/lexicons/com.atproto.server.getSession.json index 5f770088..6b5f280e 100644 --- a/lexicons/com.atproto.server.getSession.json +++ b/lexicons/com.atproto.server.getSession.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get information about the current session.", + "description": "Get information about the current auth session. Requires auth.", "output": { "encoding": "application/json", "schema": { diff --git a/lexicons/com.atproto.server.refreshSession.json b/lexicons/com.atproto.server.refreshSession.json index 3f4d7fdf..0b067f86 100644 --- a/lexicons/com.atproto.server.refreshSession.json +++ b/lexicons/com.atproto.server.refreshSession.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Refresh an authentication session.", + "description": "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').", "output": { "encoding": "application/json", "schema": { diff --git a/lexicons/com.atproto.server.reserveSigningKey.json b/lexicons/com.atproto.server.reserveSigningKey.json index 3a67ad0a..a33e1ede 100644 --- a/lexicons/com.atproto.server.reserveSigningKey.json +++ b/lexicons/com.atproto.server.reserveSigningKey.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Reserve a repo signing key for account creation.", + "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.", "input": { "encoding": "application/json", "schema": { @@ -12,7 +12,8 @@ "properties": { "did": { "type": "string", - "description": "The did to reserve a new did:key for" + "format": "did", + "description": "The DID to reserve a key for." } } } @@ -25,7 +26,7 @@ "properties": { "signingKey": { "type": "string", - "description": "Public signing key in the form of a did:key." + "description": "The public key for the reserved signing key, in did:key serialization." } } } diff --git a/lexicons/com.atproto.sync.getBlob.json b/lexicons/com.atproto.sync.getBlob.json index 23e18a4f..57ece7a9 100644 --- a/lexicons/com.atproto.sync.getBlob.json +++ b/lexicons/com.atproto.sync.getBlob.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get a blob associated with a given repo.", + "description": "Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.", "parameters": { "type": "params", "required": ["did", "cid"], @@ -12,7 +12,7 @@ "did": { "type": "string", "format": "did", - "description": "The DID of the repo." + "description": "The DID of the account." }, "cid": { "type": "string", diff --git a/lexicons/com.atproto.sync.getBlocks.json b/lexicons/com.atproto.sync.getBlocks.json index cf776a0c..29dd4971 100644 --- a/lexicons/com.atproto.sync.getBlocks.json +++ b/lexicons/com.atproto.sync.getBlocks.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get blocks from a given repo.", + "description": "Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.", "parameters": { "type": "params", "required": ["did", "cids"], diff --git a/lexicons/com.atproto.sync.getLatestCommit.json b/lexicons/com.atproto.sync.getLatestCommit.json index d8754f09..ac7faf57 100644 --- a/lexicons/com.atproto.sync.getLatestCommit.json +++ b/lexicons/com.atproto.sync.getLatestCommit.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get the current commit CID & revision of the repo.", + "description": "Get the current commit CID & revision of the specified repo. Does not require auth.", "parameters": { "type": "params", "required": ["did"], diff --git a/lexicons/com.atproto.sync.getRecord.json b/lexicons/com.atproto.sync.getRecord.json index cbd0ad3a..718245a5 100644 --- a/lexicons/com.atproto.sync.getRecord.json +++ b/lexicons/com.atproto.sync.getRecord.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get blocks needed for existence or non-existence of record.", + "description": "Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.", "parameters": { "type": "params", "required": ["did", "collection", "rkey"], @@ -15,7 +15,7 @@ "description": "The DID of the repo." }, "collection": { "type": "string", "format": "nsid" }, - "rkey": { "type": "string" }, + "rkey": { "type": "string", "description": "Record Key" }, "commit": { "type": "string", "format": "cid", diff --git a/lexicons/com.atproto.sync.getRepo.json b/lexicons/com.atproto.sync.getRepo.json index fb68ab67..7fa710ab 100644 --- a/lexicons/com.atproto.sync.getRepo.json +++ b/lexicons/com.atproto.sync.getRepo.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Gets the DID's repo, optionally catching up from a specific revision.", + "description": "Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.", "parameters": { "type": "params", "required": ["did"], @@ -16,7 +16,7 @@ }, "since": { "type": "string", - "description": "The revision of the repo to catch up from." + "description": "The revision ('rev') of the repo to create a diff from." } } }, diff --git a/lexicons/com.atproto.sync.listBlobs.json b/lexicons/com.atproto.sync.listBlobs.json index 46815eeb..b4c954d9 100644 --- a/lexicons/com.atproto.sync.listBlobs.json +++ b/lexicons/com.atproto.sync.listBlobs.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "List blob CIDs since some revision.", + "description": "List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS.", "parameters": { "type": "params", "required": ["did"], diff --git a/lexicons/com.atproto.sync.listRepos.json b/lexicons/com.atproto.sync.listRepos.json index 440e8693..07ae35e2 100644 --- a/lexicons/com.atproto.sync.listRepos.json +++ b/lexicons/com.atproto.sync.listRepos.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "List DIDs and root CIDs of hosted repos.", + "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.", "parameters": { "type": "params", "properties": { @@ -37,7 +37,11 @@ "required": ["did", "head", "rev"], "properties": { "did": { "type": "string", "format": "did" }, - "head": { "type": "string", "format": "cid" }, + "head": { + "type": "string", + "format": "cid", + "description": "Current repo commit CID" + }, "rev": { "type": "string" } } } diff --git a/lexicons/com.atproto.sync.notifyOfUpdate.json b/lexicons/com.atproto.sync.notifyOfUpdate.json index 48cb4b24..034a9655 100644 --- a/lexicons/com.atproto.sync.notifyOfUpdate.json +++ b/lexicons/com.atproto.sync.notifyOfUpdate.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "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.", + "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.", "input": { "encoding": "application/json", "schema": { @@ -13,7 +13,7 @@ "properties": { "hostname": { "type": "string", - "description": "Hostname of the service that is notifying of update." + "description": "Hostname of the current service (usually a PDS) that is notifying of update." } } } diff --git a/lexicons/com.atproto.sync.requestCrawl.json b/lexicons/com.atproto.sync.requestCrawl.json index a3520a33..8e075a37 100644 --- a/lexicons/com.atproto.sync.requestCrawl.json +++ b/lexicons/com.atproto.sync.requestCrawl.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Request a service to persistently crawl hosted repos.", + "description": "Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.", "input": { "encoding": "application/json", "schema": { @@ -13,7 +13,7 @@ "properties": { "hostname": { "type": "string", - "description": "Hostname of the service that is requesting to be crawled." + "description": "Hostname of the current service (eg, PDS) that is requesting to be crawled." } } } diff --git a/lexicons/com.atproto.sync.subscribeRepos.json b/lexicons/com.atproto.sync.subscribeRepos.json index 9a5c0f61..73a34a3b 100644 --- a/lexicons/com.atproto.sync.subscribeRepos.json +++ b/lexicons/com.atproto.sync.subscribeRepos.json @@ -4,13 +4,13 @@ "defs": { "main": { "type": "subscription", - "description": "Subscribe to repo updates.", + "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.", "parameters": { "type": "params", "properties": { "cursor": { "type": "integer", - "description": "The last known event to backfill from." + "description": "The last known event seq number to backfill from." } } }, @@ -20,10 +20,17 @@ "refs": ["#commit", "#handle", "#migrate", "#tombstone", "#info"] } }, - "errors": [{ "name": "FutureCursor" }, { "name": "ConsumerTooSlow" }] + "errors": [ + { "name": "FutureCursor" }, + { + "name": "ConsumerTooSlow", + "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." + } + ] }, "commit": { "type": "object", + "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.", "required": [ "seq", "rebase", @@ -39,39 +46,67 @@ ], "nullable": ["prev", "since"], "properties": { - "seq": { "type": "integer" }, - "rebase": { "type": "boolean" }, - "tooBig": { "type": "boolean" }, - "repo": { "type": "string", "format": "did" }, - "commit": { "type": "cid-link" }, - "prev": { "type": "cid-link" }, + "seq": { + "type": "integer", + "description": "The stream sequence number of this message." + }, + "rebase": { "type": "boolean", "description": "DEPRECATED -- unused" }, + "tooBig": { + "type": "boolean", + "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." + }, + "repo": { + "type": "string", + "format": "did", + "description": "The repo this event comes from." + }, + "commit": { + "type": "cid-link", + "description": "Repo commit object CID." + }, + "prev": { + "type": "cid-link", + "description": "DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability." + }, "rev": { "type": "string", - "description": "The rev of the emitted commit." + "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." }, "since": { "type": "string", - "description": "The rev of the last emitted commit from this repo." + "description": "The rev of the last emitted commit from this repo (if any)." }, "blocks": { "type": "bytes", - "description": "CAR file containing relevant blocks.", + "description": "CAR file containing relevant blocks, as a diff since the previous repo state.", "maxLength": 1000000 }, "ops": { "type": "array", - "items": { "type": "ref", "ref": "#repoOp" }, + "items": { + "type": "ref", + "ref": "#repoOp", + "description": "List of repo mutation operations in this commit (eg, records created, updated, or deleted)." + }, "maxLength": 200 }, "blobs": { "type": "array", - "items": { "type": "cid-link" } + "items": { + "type": "cid-link", + "description": "List of new blobs (by CID) referenced by records in this commit." + } }, - "time": { "type": "string", "format": "datetime" } + "time": { + "type": "string", + "format": "datetime", + "description": "Timestamp of when this message was originally broadcast." + } } }, "handle": { "type": "object", + "description": "Represents an update of the account's handle, or transition to/from invalid state.", "required": ["seq", "did", "handle", "time"], "properties": { "seq": { "type": "integer" }, @@ -82,6 +117,7 @@ }, "migrate": { "type": "object", + "description": "Represents an account moving from one PDS instance to another. NOTE: not implemented; full account migration may introduce a new message instead.", "required": ["seq", "did", "migrateTo", "time"], "nullable": ["migrateTo"], "properties": { @@ -93,6 +129,7 @@ }, "tombstone": { "type": "object", + "description": "Indicates that an account has been deleted.", "required": ["seq", "did", "time"], "properties": { "seq": { "type": "integer" }, @@ -115,7 +152,7 @@ }, "repoOp": { "type": "object", - "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.", + "description": "A repo operation, ie a mutation of a single record.", "required": ["action", "path", "cid"], "nullable": ["cid"], "properties": { @@ -124,7 +161,10 @@ "knownValues": ["create", "update", "delete"] }, "path": { "type": "string" }, - "cid": { "type": "cid-link" } + "cid": { + "type": "cid-link", + "description": "For creates and updates, the new record CID. For deletions, null." + } } } } diff --git a/lexicons/com.atproto.temp.fetchLabels.json b/lexicons/com.atproto.temp.fetchLabels.json index 14e392fd..d76041ac 100644 --- a/lexicons/com.atproto.temp.fetchLabels.json +++ b/lexicons/com.atproto.temp.fetchLabels.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Fetch all labels from a labeler created after a certain date.", + "description": "Fetch all labels from a labeler created after a certain date. DEPRECATED: use queryLabels or subscribeLabels instead", "parameters": { "type": "params", "properties": { diff --git a/lexicons/com.atproto.temp.transferAccount.json b/lexicons/com.atproto.temp.transferAccount.json index 3cb2035a..d4687d9b 100644 --- a/lexicons/com.atproto.temp.transferAccount.json +++ b/lexicons/com.atproto.temp.transferAccount.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Transfer an account.", + "description": "Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented.", "input": { "encoding": "application/json", "schema": { diff --git a/packages/atproto_client/models/app/bsky/actor/defs.py b/packages/atproto_client/models/app/bsky/actor/defs.py index ccc86e2f..2992853b 100644 --- a/packages/atproto_client/models/app/bsky/actor/defs.py +++ b/packages/atproto_client/models/app/bsky/actor/defs.py @@ -69,7 +69,7 @@ class ProfileViewDetailed(base.ModelBase): class ViewerState(base.ModelBase): - """Definition model for :obj:`app.bsky.actor.defs`.""" + """Definition model for :obj:`app.bsky.actor.defs`. Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.""" blocked_by: t.Optional[bool] = None #: Blocked by. blocking: t.Optional[str] = None #: Blocking. @@ -126,6 +126,7 @@ class SavedFeedsPref(base.ModelBase): pinned: t.List[str] #: Pinned. saved: t.List[str] #: Saved. + timeline_index: t.Optional[int] = None #: Timeline index. py_type: te.Literal['app.bsky.actor.defs#savedFeedsPref'] = Field( default='app.bsky.actor.defs#savedFeedsPref', alias='$type', frozen=True diff --git a/packages/atproto_client/models/app/bsky/actor/get_profile.py b/packages/atproto_client/models/app/bsky/actor/get_profile.py index f4e8fb3d..7c6efaed 100644 --- a/packages/atproto_client/models/app/bsky/actor/get_profile.py +++ b/packages/atproto_client/models/app/bsky/actor/get_profile.py @@ -13,8 +13,8 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.actor.getProfile`.""" - actor: str #: Actor. + actor: str #: Handle or DID of account to fetch profile of. class ParamsDict(te.TypedDict): - actor: str #: Actor. + actor: str #: Handle or DID of account to fetch profile of. diff --git a/packages/atproto_client/models/app/bsky/actor/profile.py b/packages/atproto_client/models/app/bsky/actor/profile.py index 8018845f..1edf519e 100644 --- a/packages/atproto_client/models/app/bsky/actor/profile.py +++ b/packages/atproto_client/models/app/bsky/actor/profile.py @@ -19,13 +19,15 @@ class Record(base.RecordModelBase): """Record model for :obj:`app.bsky.actor.profile`.""" - avatar: t.Optional['BlobRef'] = None #: Avatar. - banner: t.Optional['BlobRef'] = None #: Banner. - description: t.Optional[str] = Field(default=None, max_length=2560) #: Description. + avatar: t.Optional[ + 'BlobRef' + ] = None #: Small image to be displayed next to posts from account. AKA, 'profile picture'. + banner: t.Optional['BlobRef'] = None #: Larger horizontal image to display behind profile view. + description: t.Optional[str] = Field(default=None, max_length=2560) #: Free-form profile description text. display_name: t.Optional[str] = Field(default=None, max_length=640) #: Display name. labels: t.Optional[ te.Annotated[t.Union['models.ComAtprotoLabelDefs.SelfLabels'], Field(default=None, discriminator='py_type')] - ] = None #: Labels. + ] = None #: Self-label values, specific to the Bluesky application, on the overall account. py_type: te.Literal['app.bsky.actor.profile'] = Field(default='app.bsky.actor.profile', alias='$type', frozen=True) diff --git a/packages/atproto_client/models/app/bsky/embed/external.py b/packages/atproto_client/models/app/bsky/embed/external.py index f0c9226d..5bea2c4c 100644 --- a/packages/atproto_client/models/app/bsky/embed/external.py +++ b/packages/atproto_client/models/app/bsky/embed/external.py @@ -17,7 +17,7 @@ class Main(base.ModelBase): - """Definition model for :obj:`app.bsky.embed.external`.""" + """Definition model for :obj:`app.bsky.embed.external`. A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).""" external: 'models.AppBskyEmbedExternal.External' #: External. diff --git a/packages/atproto_client/models/app/bsky/embed/images.py b/packages/atproto_client/models/app/bsky/embed/images.py index 6de64d11..3080b116 100644 --- a/packages/atproto_client/models/app/bsky/embed/images.py +++ b/packages/atproto_client/models/app/bsky/embed/images.py @@ -27,7 +27,7 @@ class Main(base.ModelBase): class Image(base.ModelBase): """Definition model for :obj:`app.bsky.embed.images`.""" - alt: str #: Alt. + alt: str #: Alt text description of the image, for accessibility. image: 'BlobRef' #: Image. aspect_ratio: t.Optional['models.AppBskyEmbedImages.AspectRatio'] = None #: Aspect ratio. @@ -60,9 +60,9 @@ class View(base.ModelBase): class ViewImage(base.ModelBase): """Definition model for :obj:`app.bsky.embed.images`.""" - alt: str #: Alt. - fullsize: str #: Fullsize. - thumb: str #: Thumb. + alt: str #: Alt text description of the image, for accessibility. + fullsize: str #: 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. + thumb: str #: Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View. aspect_ratio: t.Optional['models.AppBskyEmbedImages.AspectRatio'] = None #: Aspect ratio. py_type: te.Literal['app.bsky.embed.images#viewImage'] = Field( diff --git a/packages/atproto_client/models/app/bsky/embed/record.py b/packages/atproto_client/models/app/bsky/embed/record.py index 8045d095..67e79b5c 100644 --- a/packages/atproto_client/models/app/bsky/embed/record.py +++ b/packages/atproto_client/models/app/bsky/embed/record.py @@ -50,7 +50,7 @@ class ViewRecord(base.ModelBase): cid: str #: Cid. indexed_at: str #: Indexed at. uri: str #: Uri. - value: 'UnknownType' #: Value. + value: 'UnknownType' #: The record data itself. embeds: t.Optional[ t.List[ te.Annotated[ diff --git a/packages/atproto_client/models/app/bsky/feed/defs.py b/packages/atproto_client/models/app/bsky/feed/defs.py index 6a9eb356..1cfac86f 100644 --- a/packages/atproto_client/models/app/bsky/feed/defs.py +++ b/packages/atproto_client/models/app/bsky/feed/defs.py @@ -48,7 +48,7 @@ class PostView(base.ModelBase): class ViewerState(base.ModelBase): - """Definition model for :obj:`app.bsky.feed.defs`.""" + """Definition model for :obj:`app.bsky.feed.defs`. Metadata about the requesting account's relationship with the subject content. Only has meaningful content for authed requests.""" like: t.Optional[str] = None #: Like. reply_disabled: t.Optional[bool] = None #: Reply disabled. diff --git a/packages/atproto_client/models/app/bsky/feed/generator.py b/packages/atproto_client/models/app/bsky/feed/generator.py index 663787fa..c6305e8b 100644 --- a/packages/atproto_client/models/app/bsky/feed/generator.py +++ b/packages/atproto_client/models/app/bsky/feed/generator.py @@ -27,7 +27,7 @@ class Record(base.RecordModelBase): description_facets: t.Optional[t.List['models.AppBskyRichtextFacet.Main']] = None #: Description facets. labels: t.Optional[ te.Annotated[t.Union['models.ComAtprotoLabelDefs.SelfLabels'], Field(default=None, discriminator='py_type')] - ] = None #: Labels. + ] = None #: Self-label values. py_type: te.Literal['app.bsky.feed.generator'] = Field( default='app.bsky.feed.generator', alias='$type', frozen=True diff --git a/packages/atproto_client/models/app/bsky/feed/get_author_feed.py b/packages/atproto_client/models/app/bsky/feed/get_author_feed.py index c1622824..a4a7a62f 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_author_feed.py +++ b/packages/atproto_client/models/app/bsky/feed/get_author_feed.py @@ -20,14 +20,14 @@ class Params(base.ParamsModelBase): actor: str #: Actor. cursor: t.Optional[str] = None #: Cursor. - filter: t.Optional[str] = None #: Filter. + filter: t.Optional[str] = None #: Combinations of post/repost types to include in response. limit: t.Optional[int] = Field(default=50, ge=1, le=100) #: Limit. class ParamsDict(te.TypedDict): actor: str #: Actor. cursor: te.NotRequired[t.Optional[str]] #: Cursor. - filter: te.NotRequired[t.Optional[str]] #: Filter. + filter: te.NotRequired[t.Optional[str]] #: Combinations of post/repost types to include in response. limit: te.NotRequired[t.Optional[int]] #: Limit. diff --git a/packages/atproto_client/models/app/bsky/feed/get_feed_generator.py b/packages/atproto_client/models/app/bsky/feed/get_feed_generator.py index 71f595e3..53114909 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_feed_generator.py +++ b/packages/atproto_client/models/app/bsky/feed/get_feed_generator.py @@ -17,16 +17,18 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.feed.getFeedGenerator`.""" - feed: str #: Feed. + feed: str #: AT-URI of the feed generator record. class ParamsDict(te.TypedDict): - feed: str #: Feed. + feed: str #: AT-URI of the feed generator record. class Response(base.ResponseModelBase): """Output data model for :obj:`app.bsky.feed.getFeedGenerator`.""" - is_online: bool #: Is online. - is_valid: bool #: Is valid. + is_online: ( + bool + ) #: Indicates whether the feed generator service has been online recently, or else seems to be inactive. + is_valid: bool #: Indicates whether the feed generator service is compatible with the record declaration. view: 'models.AppBskyFeedDefs.GeneratorView' #: View. diff --git a/packages/atproto_client/models/app/bsky/feed/get_feed_skeleton.py b/packages/atproto_client/models/app/bsky/feed/get_feed_skeleton.py index 8a5f1c99..da6ead6c 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_feed_skeleton.py +++ b/packages/atproto_client/models/app/bsky/feed/get_feed_skeleton.py @@ -18,13 +18,13 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.feed.getFeedSkeleton`.""" - feed: str #: Feed. + feed: str #: Reference to feed generator record describing the specific feed being requested. cursor: t.Optional[str] = None #: Cursor. limit: t.Optional[int] = Field(default=50, ge=1, le=100) #: Limit. class ParamsDict(te.TypedDict): - feed: str #: Feed. + feed: str #: Reference to feed generator record describing the specific feed being requested. cursor: te.NotRequired[t.Optional[str]] #: Cursor. limit: te.NotRequired[t.Optional[int]] #: Limit. diff --git a/packages/atproto_client/models/app/bsky/feed/get_likes.py b/packages/atproto_client/models/app/bsky/feed/get_likes.py index 751da596..42a480f1 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_likes.py +++ b/packages/atproto_client/models/app/bsky/feed/get_likes.py @@ -18,15 +18,17 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.feed.getLikes`.""" - uri: str #: Uri. - cid: t.Optional[str] = None #: Cid. + uri: str #: AT-URI of the subject (eg, a post record). + cid: t.Optional[str] = None #: CID of the subject record (aka, specific version of record), to filter likes. cursor: t.Optional[str] = None #: Cursor. limit: t.Optional[int] = Field(default=50, ge=1, le=100) #: Limit. class ParamsDict(te.TypedDict): - uri: str #: Uri. - cid: te.NotRequired[t.Optional[str]] #: Cid. + uri: str #: AT-URI of the subject (eg, a post record). + cid: te.NotRequired[ + t.Optional[str] + ] #: CID of the subject record (aka, specific version of record), to filter likes. cursor: te.NotRequired[t.Optional[str]] #: Cursor. limit: te.NotRequired[t.Optional[int]] #: Limit. diff --git a/packages/atproto_client/models/app/bsky/feed/get_list_feed.py b/packages/atproto_client/models/app/bsky/feed/get_list_feed.py index 31ffeab5..f0e0af4b 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_list_feed.py +++ b/packages/atproto_client/models/app/bsky/feed/get_list_feed.py @@ -18,13 +18,13 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.feed.getListFeed`.""" - list: str #: List. + list: str #: Reference (AT-URI) to the list record. cursor: t.Optional[str] = None #: Cursor. limit: t.Optional[int] = Field(default=50, ge=1, le=100) #: Limit. class ParamsDict(te.TypedDict): - list: str #: List. + list: str #: Reference (AT-URI) to the list record. cursor: te.NotRequired[t.Optional[str]] #: Cursor. limit: te.NotRequired[t.Optional[int]] #: Limit. diff --git a/packages/atproto_client/models/app/bsky/feed/get_post_thread.py b/packages/atproto_client/models/app/bsky/feed/get_post_thread.py index 1670f0d2..8a98be4d 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_post_thread.py +++ b/packages/atproto_client/models/app/bsky/feed/get_post_thread.py @@ -18,15 +18,19 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.feed.getPostThread`.""" - uri: str #: Uri. - depth: t.Optional[int] = Field(default=6, ge=0, le=1000) #: Depth. - parent_height: t.Optional[int] = Field(default=80, ge=0, le=1000) #: Parent height. + uri: str #: Reference (AT-URI) to post record. + depth: t.Optional[int] = Field( + default=6, ge=0, le=1000 + ) #: How many levels of reply depth should be included in response. + parent_height: t.Optional[int] = Field( + default=80, ge=0, le=1000 + ) #: How many levels of parent (and grandparent, etc) post to include. class ParamsDict(te.TypedDict): - uri: str #: Uri. - depth: te.NotRequired[t.Optional[int]] #: Depth. - parent_height: te.NotRequired[t.Optional[int]] #: Parent height. + uri: str #: Reference (AT-URI) to post record. + depth: te.NotRequired[t.Optional[int]] #: How many levels of reply depth should be included in response. + parent_height: te.NotRequired[t.Optional[int]] #: How many levels of parent (and grandparent, etc) post to include. class Response(base.ResponseModelBase): diff --git a/packages/atproto_client/models/app/bsky/feed/get_posts.py b/packages/atproto_client/models/app/bsky/feed/get_posts.py index 0f27f7bc..46032662 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_posts.py +++ b/packages/atproto_client/models/app/bsky/feed/get_posts.py @@ -18,11 +18,11 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.feed.getPosts`.""" - uris: t.List[str] = Field(max_length=25) #: Uris. + uris: t.List[str] = Field(max_length=25) #: List of post AT-URIs to return hydrated views for. class ParamsDict(te.TypedDict): - uris: t.List[str] #: Uris. + uris: t.List[str] #: List of post AT-URIs to return hydrated views for. class Response(base.ResponseModelBase): diff --git a/packages/atproto_client/models/app/bsky/feed/get_reposted_by.py b/packages/atproto_client/models/app/bsky/feed/get_reposted_by.py index 040b2153..304b1d0e 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_reposted_by.py +++ b/packages/atproto_client/models/app/bsky/feed/get_reposted_by.py @@ -18,15 +18,17 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.feed.getRepostedBy`.""" - uri: str #: Uri. - cid: t.Optional[str] = None #: Cid. + uri: str #: Reference (AT-URI) of post record. + cid: t.Optional[str] = None #: If supplied, filters to reposts of specific version (by CID) of the post record. cursor: t.Optional[str] = None #: Cursor. limit: t.Optional[int] = Field(default=50, ge=1, le=100) #: Limit. class ParamsDict(te.TypedDict): - uri: str #: Uri. - cid: te.NotRequired[t.Optional[str]] #: Cid. + uri: str #: Reference (AT-URI) of post record. + cid: te.NotRequired[ + t.Optional[str] + ] #: If supplied, filters to reposts of specific version (by CID) of the post record. cursor: te.NotRequired[t.Optional[str]] #: Cursor. limit: te.NotRequired[t.Optional[int]] #: Limit. diff --git a/packages/atproto_client/models/app/bsky/feed/get_timeline.py b/packages/atproto_client/models/app/bsky/feed/get_timeline.py index 9528d317..5a9a57fb 100644 --- a/packages/atproto_client/models/app/bsky/feed/get_timeline.py +++ b/packages/atproto_client/models/app/bsky/feed/get_timeline.py @@ -18,13 +18,17 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.feed.getTimeline`.""" - algorithm: t.Optional[str] = None #: Algorithm. + algorithm: t.Optional[ + str + ] = None #: Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism. cursor: t.Optional[str] = None #: Cursor. limit: t.Optional[int] = Field(default=50, ge=1, le=100) #: Limit. class ParamsDict(te.TypedDict): - algorithm: te.NotRequired[t.Optional[str]] #: Algorithm. + algorithm: te.NotRequired[ + t.Optional[str] + ] #: Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism. cursor: te.NotRequired[t.Optional[str]] #: Cursor. limit: te.NotRequired[t.Optional[int]] #: Limit. diff --git a/packages/atproto_client/models/app/bsky/feed/post.py b/packages/atproto_client/models/app/bsky/feed/post.py index 5365acd2..f895f35f 100644 --- a/packages/atproto_client/models/app/bsky/feed/post.py +++ b/packages/atproto_client/models/app/bsky/feed/post.py @@ -52,8 +52,8 @@ class TextSlice(base.ModelBase): class Record(base.RecordModelBase): """Record model for :obj:`app.bsky.feed.post`.""" - created_at: str #: Created at. - text: str = Field(max_length=3000) #: Text. + created_at: str #: Client-declared timestamp when this post was originally created. + text: str = Field(max_length=3000) #: The primary post content. May be an empty string, if there are embeds. embed: t.Optional[ te.Annotated[ t.Union[ @@ -67,16 +67,20 @@ class Record(base.RecordModelBase): ] = None #: Embed. entities: t.Optional[ t.List['models.AppBskyFeedPost.Entity'] - ] = None #: Deprecated: replaced by app.bsky.richtext.facet. - facets: t.Optional[t.List['models.AppBskyRichtextFacet.Main']] = None #: Facets. + ] = None #: DEPRECATED: replaced by app.bsky.richtext.facet. + facets: t.Optional[ + t.List['models.AppBskyRichtextFacet.Main'] + ] = None #: Annotations of text (mentions, URLs, hashtags, etc). labels: t.Optional[ te.Annotated[t.Union['models.ComAtprotoLabelDefs.SelfLabels'], Field(default=None, discriminator='py_type')] - ] = None #: Labels. - langs: t.Optional[t.List[str]] = Field(default=None, max_length=3) #: Langs. + ] = None #: Self-label values for this post. Effectively content warnings. + langs: t.Optional[t.List[str]] = Field( + default=None, max_length=3 + ) #: Indicates human language of post primary text content. reply: t.Optional['models.AppBskyFeedPost.ReplyRef'] = None #: Reply. tags: t.Optional[t.List[str]] = Field( default=None, max_length=8 - ) #: Additional non-inline tags describing this post. + ) #: Additional hashtags, in addition to any included in post text and facets. py_type: te.Literal['app.bsky.feed.post'] = Field(default='app.bsky.feed.post', alias='$type', frozen=True) diff --git a/packages/atproto_client/models/app/bsky/feed/threadgate.py b/packages/atproto_client/models/app/bsky/feed/threadgate.py index 6453b8a4..2d60ce5f 100644 --- a/packages/atproto_client/models/app/bsky/feed/threadgate.py +++ b/packages/atproto_client/models/app/bsky/feed/threadgate.py @@ -45,7 +45,7 @@ class Record(base.RecordModelBase): """Record model for :obj:`app.bsky.feed.threadgate`.""" created_at: str #: Created at. - post: str #: Post. + post: str #: Reference (AT-URI) to the post record. allow: t.Optional[ t.List[ te.Annotated[ diff --git a/packages/atproto_client/models/app/bsky/graph/block.py b/packages/atproto_client/models/app/bsky/graph/block.py index 1c689c68..26b78e5c 100644 --- a/packages/atproto_client/models/app/bsky/graph/block.py +++ b/packages/atproto_client/models/app/bsky/graph/block.py @@ -19,7 +19,7 @@ class Record(base.RecordModelBase): """Record model for :obj:`app.bsky.graph.block`.""" created_at: str #: Created at. - subject: str #: Subject. + subject: str #: DID of the account to be blocked. py_type: te.Literal['app.bsky.graph.block'] = Field(default='app.bsky.graph.block', alias='$type', frozen=True) diff --git a/packages/atproto_client/models/app/bsky/graph/get_list.py b/packages/atproto_client/models/app/bsky/graph/get_list.py index bdbc2500..28452202 100644 --- a/packages/atproto_client/models/app/bsky/graph/get_list.py +++ b/packages/atproto_client/models/app/bsky/graph/get_list.py @@ -18,13 +18,13 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.graph.getList`.""" - list: str #: List. + list: str #: Reference (AT-URI) of the list record to hydrate. cursor: t.Optional[str] = None #: Cursor. limit: t.Optional[int] = Field(default=50, ge=1, le=100) #: Limit. class ParamsDict(te.TypedDict): - list: str #: List. + list: str #: Reference (AT-URI) of the list record to hydrate. cursor: te.NotRequired[t.Optional[str]] #: Cursor. limit: te.NotRequired[t.Optional[int]] #: Limit. diff --git a/packages/atproto_client/models/app/bsky/graph/get_lists.py b/packages/atproto_client/models/app/bsky/graph/get_lists.py index 05fafd01..7ae540dc 100644 --- a/packages/atproto_client/models/app/bsky/graph/get_lists.py +++ b/packages/atproto_client/models/app/bsky/graph/get_lists.py @@ -18,13 +18,13 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.graph.getLists`.""" - actor: str #: Actor. + actor: str #: The account (actor) to enumerate lists from. cursor: t.Optional[str] = None #: Cursor. limit: t.Optional[int] = Field(default=50, ge=1, le=100) #: Limit. class ParamsDict(te.TypedDict): - actor: str #: Actor. + actor: str #: The account (actor) to enumerate lists from. cursor: te.NotRequired[t.Optional[str]] #: Cursor. limit: te.NotRequired[t.Optional[int]] #: Limit. diff --git a/packages/atproto_client/models/app/bsky/graph/get_relationships.py b/packages/atproto_client/models/app/bsky/graph/get_relationships.py index 54646035..0c2baae4 100644 --- a/packages/atproto_client/models/app/bsky/graph/get_relationships.py +++ b/packages/atproto_client/models/app/bsky/graph/get_relationships.py @@ -18,13 +18,15 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`app.bsky.graph.getRelationships`.""" - actor: str #: Actor. - others: t.Optional[t.List[str]] = Field(default=None, max_length=30) #: Others. + actor: str #: Primary account requesting relationships for. + others: t.Optional[t.List[str]] = Field( + default=None, max_length=30 + ) #: List of 'other' accounts to be related back to the primary. class ParamsDict(te.TypedDict): - actor: str #: Actor. - others: te.NotRequired[t.Optional[t.List[str]]] #: Others. + actor: str #: Primary account requesting relationships for. + others: te.NotRequired[t.Optional[t.List[str]]] #: List of 'other' accounts to be related back to the primary. class Response(base.ResponseModelBase): diff --git a/packages/atproto_client/models/app/bsky/graph/list.py b/packages/atproto_client/models/app/bsky/graph/list.py index d8d09e69..2eabffa0 100644 --- a/packages/atproto_client/models/app/bsky/graph/list.py +++ b/packages/atproto_client/models/app/bsky/graph/list.py @@ -20,8 +20,10 @@ class Record(base.RecordModelBase): """Record model for :obj:`app.bsky.graph.list`.""" created_at: str #: Created at. - name: str = Field(min_length=1, max_length=64) #: Name. - purpose: 'models.AppBskyGraphDefs.ListPurpose' #: Purpose. + name: str = Field(min_length=1, max_length=64) #: Display name for list; can not be empty. + purpose: ( + 'models.AppBskyGraphDefs.ListPurpose' + ) #: Defines the purpose of the list (aka, moderation-oriented or curration-oriented). avatar: t.Optional['BlobRef'] = None #: Avatar. description: t.Optional[str] = Field(default=None, max_length=3000) #: Description. description_facets: t.Optional[t.List['models.AppBskyRichtextFacet.Main']] = None #: Description facets. diff --git a/packages/atproto_client/models/app/bsky/graph/listblock.py b/packages/atproto_client/models/app/bsky/graph/listblock.py index 3e259e76..67e1b562 100644 --- a/packages/atproto_client/models/app/bsky/graph/listblock.py +++ b/packages/atproto_client/models/app/bsky/graph/listblock.py @@ -19,7 +19,7 @@ class Record(base.RecordModelBase): """Record model for :obj:`app.bsky.graph.listblock`.""" created_at: str #: Created at. - subject: str #: Subject. + subject: str #: Reference (AT-URI) to the mod list record. py_type: te.Literal['app.bsky.graph.listblock'] = Field( default='app.bsky.graph.listblock', alias='$type', frozen=True diff --git a/packages/atproto_client/models/app/bsky/graph/listitem.py b/packages/atproto_client/models/app/bsky/graph/listitem.py index 9398884d..c74715fe 100644 --- a/packages/atproto_client/models/app/bsky/graph/listitem.py +++ b/packages/atproto_client/models/app/bsky/graph/listitem.py @@ -19,8 +19,8 @@ class Record(base.RecordModelBase): """Record model for :obj:`app.bsky.graph.listitem`.""" created_at: str #: Created at. - list: str #: List. - subject: str #: Subject. + list: str #: Reference (AT-URI) to the list record (app.bsky.graph.list). + subject: str #: The account which is included on the list. py_type: te.Literal['app.bsky.graph.listitem'] = Field( default='app.bsky.graph.listitem', alias='$type', frozen=True diff --git a/packages/atproto_client/models/app/bsky/richtext/facet.py b/packages/atproto_client/models/app/bsky/richtext/facet.py index 8fae6e6b..815b6956 100644 --- a/packages/atproto_client/models/app/bsky/richtext/facet.py +++ b/packages/atproto_client/models/app/bsky/richtext/facet.py @@ -16,7 +16,7 @@ class Main(base.ModelBase): - """Definition model for :obj:`app.bsky.richtext.facet`.""" + """Definition model for :obj:`app.bsky.richtext.facet`. Annotation of a sub-string within rich text.""" features: t.List[ te.Annotated[ @@ -36,7 +36,7 @@ class Main(base.ModelBase): class Mention(base.ModelBase): - """Definition model for :obj:`app.bsky.richtext.facet`. A facet feature for actor mentions.""" + """Definition model for :obj:`app.bsky.richtext.facet`. Facet feature for mention of another account. The text is usually a handle, including a '@' prefix, but the facet reference is a DID.""" did: str #: Did. @@ -46,7 +46,7 @@ class Mention(base.ModelBase): class Link(base.ModelBase): - """Definition model for :obj:`app.bsky.richtext.facet`. A facet feature for links.""" + """Definition model for :obj:`app.bsky.richtext.facet`. Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.""" uri: str #: Uri. @@ -56,7 +56,7 @@ class Link(base.ModelBase): class Tag(base.ModelBase): - """Definition model for :obj:`app.bsky.richtext.facet`. A hashtag.""" + """Definition model for :obj:`app.bsky.richtext.facet`. 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').""" tag: str = Field(max_length=640) #: Tag. @@ -66,7 +66,7 @@ class Tag(base.ModelBase): class ByteSlice(base.ModelBase): - """Definition model for :obj:`app.bsky.richtext.facet`. A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.""" + """Definition model for :obj:`app.bsky.richtext.facet`. 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.""" byte_end: int = Field(ge=0) #: Byte end. byte_start: int = Field(ge=0) #: Byte start. diff --git a/packages/atproto_client/models/com/atproto/identity/update_handle.py b/packages/atproto_client/models/com/atproto/identity/update_handle.py index 848ef5e5..aa1847e6 100644 --- a/packages/atproto_client/models/com/atproto/identity/update_handle.py +++ b/packages/atproto_client/models/com/atproto/identity/update_handle.py @@ -13,8 +13,8 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.identity.updateHandle`.""" - handle: str #: Handle. + handle: str #: The new handle. class DataDict(te.TypedDict): - handle: str #: Handle. + handle: str #: The new handle. diff --git a/packages/atproto_client/models/com/atproto/label/subscribe_labels.py b/packages/atproto_client/models/com/atproto/label/subscribe_labels.py index 1d577955..a4d0898e 100644 --- a/packages/atproto_client/models/com/atproto/label/subscribe_labels.py +++ b/packages/atproto_client/models/com/atproto/label/subscribe_labels.py @@ -18,11 +18,11 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`com.atproto.label.subscribeLabels`.""" - cursor: t.Optional[int] = None #: The last known event to backfill from. + cursor: t.Optional[int] = None #: The last known event seq number to backfill from. class ParamsDict(te.TypedDict): - cursor: te.NotRequired[t.Optional[int]] #: The last known event to backfill from. + cursor: te.NotRequired[t.Optional[int]] #: The last known event seq number to backfill from. class Labels(base.ModelBase): diff --git a/packages/atproto_client/models/com/atproto/moderation/create_report.py b/packages/atproto_client/models/com/atproto/moderation/create_report.py index 59c59288..01458089 100644 --- a/packages/atproto_client/models/com/atproto/moderation/create_report.py +++ b/packages/atproto_client/models/com/atproto/moderation/create_report.py @@ -18,21 +18,25 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.moderation.createReport`.""" - reason_type: 'models.ComAtprotoModerationDefs.ReasonType' #: Reason type. + reason_type: ( + 'models.ComAtprotoModerationDefs.ReasonType' + ) #: Indicates the broad category of violation the report is for. subject: te.Annotated[ t.Union['models.ComAtprotoAdminDefs.RepoRef', 'models.ComAtprotoRepoStrongRef.Main'], Field(discriminator='py_type'), ] #: Subject. - reason: t.Optional[str] = None #: Reason. + reason: t.Optional[str] = None #: Additional context about the content and violation. class DataDict(te.TypedDict): - reason_type: 'models.ComAtprotoModerationDefs.ReasonType' #: Reason type. + reason_type: ( + 'models.ComAtprotoModerationDefs.ReasonType' + ) #: Indicates the broad category of violation the report is for. subject: te.Annotated[ t.Union['models.ComAtprotoAdminDefs.RepoRef', 'models.ComAtprotoRepoStrongRef.Main'], Field(discriminator='py_type'), ] #: Subject. - reason: te.NotRequired[t.Optional[str]] #: Reason. + reason: te.NotRequired[t.Optional[str]] #: Additional context about the content and violation. class Response(base.ResponseModelBase): diff --git a/packages/atproto_client/models/com/atproto/repo/apply_writes.py b/packages/atproto_client/models/com/atproto/repo/apply_writes.py index d7d15063..26959180 100644 --- a/packages/atproto_client/models/com/atproto/repo/apply_writes.py +++ b/packages/atproto_client/models/com/atproto/repo/apply_writes.py @@ -19,7 +19,7 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.repo.applyWrites`.""" - repo: str #: The handle or DID of the repo. + repo: str #: The handle or DID of the repo (aka, current account). writes: t.List[ te.Annotated[ t.Union[ @@ -30,12 +30,16 @@ class Data(base.DataModelBase): Field(discriminator='py_type'), ] ] #: Writes. - swap_commit: t.Optional[str] = None #: Swap commit. - validate_: t.Optional[bool] = None #: Flag for validating the records. + swap_commit: t.Optional[ + str + ] = None #: If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations. + validate_: t.Optional[ + bool + ] = None #: Can be set to 'false' to skip Lexicon schema validation of record data, for all operations. class DataDict(te.TypedDict): - repo: str #: The handle or DID of the repo. + repo: str #: The handle or DID of the repo (aka, current account). writes: t.List[ te.Annotated[ t.Union[ @@ -46,12 +50,16 @@ class DataDict(te.TypedDict): Field(discriminator='py_type'), ] ] #: Writes. - swap_commit: te.NotRequired[t.Optional[str]] #: Swap commit. - validate: te.NotRequired[t.Optional[bool]] #: Flag for validating the records. + swap_commit: te.NotRequired[ + t.Optional[str] + ] #: If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations. + validate: te.NotRequired[ + t.Optional[bool] + ] #: Can be set to 'false' to skip Lexicon schema validation of record data, for all operations. class Create(base.ModelBase): - """Definition model for :obj:`com.atproto.repo.applyWrites`. Create a new record.""" + """Definition model for :obj:`com.atproto.repo.applyWrites`. Operation which creates a new record.""" collection: str #: Collection. value: 'UnknownType' #: Value. @@ -63,7 +71,7 @@ class Create(base.ModelBase): class Update(base.ModelBase): - """Definition model for :obj:`com.atproto.repo.applyWrites`. Update an existing record.""" + """Definition model for :obj:`com.atproto.repo.applyWrites`. Operation which updates an existing record.""" collection: str #: Collection. rkey: str #: Rkey. @@ -75,7 +83,7 @@ class Update(base.ModelBase): class Delete(base.ModelBase): - """Definition model for :obj:`com.atproto.repo.applyWrites`. Delete an existing record.""" + """Definition model for :obj:`com.atproto.repo.applyWrites`. Operation which deletes an existing record.""" collection: str #: Collection. rkey: str #: Rkey. diff --git a/packages/atproto_client/models/com/atproto/repo/create_record.py b/packages/atproto_client/models/com/atproto/repo/create_record.py index 4445f504..82ecf036 100644 --- a/packages/atproto_client/models/com/atproto/repo/create_record.py +++ b/packages/atproto_client/models/com/atproto/repo/create_record.py @@ -19,20 +19,22 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.repo.createRecord`.""" collection: str #: The NSID of the record collection. - record: 'UnknownInputType' #: The record to create. - repo: str #: The handle or DID of the repo. - rkey: t.Optional[str] = Field(default=None, max_length=15) #: The key of the record. + record: 'UnknownInputType' #: The record itself. Must contain a $type field. + repo: str #: The handle or DID of the repo (aka, current account). + rkey: t.Optional[str] = Field(default=None, max_length=15) #: The Record Key. swap_commit: t.Optional[str] = None #: Compare and swap with the previous commit by CID. - validate_: t.Optional[bool] = None #: Flag for validating the record. + validate_: t.Optional[bool] = None #: Can be set to 'false' to skip Lexicon schema validation of record data. class DataDict(te.TypedDict): collection: str #: The NSID of the record collection. - record: 'UnknownInputType' #: The record to create. - repo: str #: The handle or DID of the repo. - rkey: te.NotRequired[t.Optional[str]] #: The key of the record. + record: 'UnknownInputType' #: The record itself. Must contain a $type field. + repo: str #: The handle or DID of the repo (aka, current account). + rkey: te.NotRequired[t.Optional[str]] #: The Record Key. swap_commit: te.NotRequired[t.Optional[str]] #: Compare and swap with the previous commit by CID. - validate: te.NotRequired[t.Optional[bool]] #: Flag for validating the record. + validate: te.NotRequired[ + t.Optional[bool] + ] #: Can be set to 'false' to skip Lexicon schema validation of record data. class Response(base.ResponseModelBase): diff --git a/packages/atproto_client/models/com/atproto/repo/delete_record.py b/packages/atproto_client/models/com/atproto/repo/delete_record.py index e784c839..aea7002a 100644 --- a/packages/atproto_client/models/com/atproto/repo/delete_record.py +++ b/packages/atproto_client/models/com/atproto/repo/delete_record.py @@ -16,15 +16,15 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.repo.deleteRecord`.""" collection: str #: The NSID of the record collection. - repo: str #: The handle or DID of the repo. - rkey: str #: The key of the record. + repo: str #: The handle or DID of the repo (aka, current account). + rkey: str #: The Record Key. swap_commit: t.Optional[str] = None #: Compare and swap with the previous commit by CID. swap_record: t.Optional[str] = None #: Compare and swap with the previous record by CID. class DataDict(te.TypedDict): collection: str #: The NSID of the record collection. - repo: str #: The handle or DID of the repo. - rkey: str #: The key of the record. + repo: str #: The handle or DID of the repo (aka, current account). + rkey: str #: The Record Key. swap_commit: te.NotRequired[t.Optional[str]] #: Compare and swap with the previous commit by CID. swap_record: te.NotRequired[t.Optional[str]] #: Compare and swap with the previous record by CID. diff --git a/packages/atproto_client/models/com/atproto/repo/describe_repo.py b/packages/atproto_client/models/com/atproto/repo/describe_repo.py index aed6d966..c79c2587 100644 --- a/packages/atproto_client/models/com/atproto/repo/describe_repo.py +++ b/packages/atproto_client/models/com/atproto/repo/describe_repo.py @@ -27,8 +27,8 @@ class ParamsDict(te.TypedDict): class Response(base.ResponseModelBase): """Output data model for :obj:`com.atproto.repo.describeRepo`.""" - collections: t.List[str] #: Collections. + collections: t.List[str] #: List of all the collections (NSIDs) for which this repo contains at least one record. did: str #: Did. - did_doc: 'UnknownType' #: Did doc. + did_doc: 'UnknownType' #: The complete DID document for this account. handle: str #: Handle. - handle_is_correct: bool #: Handle is correct. + handle_is_correct: bool #: Indicates if handle is currently valid (resolves bi-directionally). diff --git a/packages/atproto_client/models/com/atproto/repo/get_record.py b/packages/atproto_client/models/com/atproto/repo/get_record.py index 59f350ae..39161e26 100644 --- a/packages/atproto_client/models/com/atproto/repo/get_record.py +++ b/packages/atproto_client/models/com/atproto/repo/get_record.py @@ -19,7 +19,7 @@ class Params(base.ParamsModelBase): collection: str #: The NSID of the record collection. repo: str #: The handle or DID of the repo. - rkey: str #: The key of the record. + rkey: str #: The Record Key. cid: t.Optional[ str ] = None #: The CID of the version of the record. If not specified, then return the most recent version. @@ -28,7 +28,7 @@ class Params(base.ParamsModelBase): class ParamsDict(te.TypedDict): collection: str #: The NSID of the record collection. repo: str #: The handle or DID of the repo. - rkey: str #: The key of the record. + rkey: str #: The Record Key. cid: te.NotRequired[ t.Optional[str] ] #: The CID of the version of the record. If not specified, then return the most recent version. diff --git a/packages/atproto_client/models/com/atproto/repo/put_record.py b/packages/atproto_client/models/com/atproto/repo/put_record.py index bb6d0aa3..428d79db 100644 --- a/packages/atproto_client/models/com/atproto/repo/put_record.py +++ b/packages/atproto_client/models/com/atproto/repo/put_record.py @@ -20,21 +20,27 @@ class Data(base.DataModelBase): collection: str #: The NSID of the record collection. record: 'UnknownInputType' #: The record to write. - repo: str #: The handle or DID of the repo. - rkey: str = Field(max_length=15) #: The key of the record. + repo: str #: The handle or DID of the repo (aka, current account). + rkey: str = Field(max_length=15) #: The Record Key. swap_commit: t.Optional[str] = None #: Compare and swap with the previous commit by CID. - swap_record: t.Optional[str] = None #: Compare and swap with the previous record by CID. - validate_: t.Optional[bool] = None #: Flag for validating the record. + swap_record: t.Optional[ + str + ] = None #: Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation. + validate_: t.Optional[bool] = None #: Can be set to 'false' to skip Lexicon schema validation of record data. class DataDict(te.TypedDict): collection: str #: The NSID of the record collection. record: 'UnknownInputType' #: The record to write. - repo: str #: The handle or DID of the repo. - rkey: str #: The key of the record. + repo: str #: The handle or DID of the repo (aka, current account). + rkey: str #: The Record Key. swap_commit: te.NotRequired[t.Optional[str]] #: Compare and swap with the previous commit by CID. - swap_record: te.NotRequired[t.Optional[str]] #: Compare and swap with the previous record by CID. - validate: te.NotRequired[t.Optional[bool]] #: Flag for validating the record. + swap_record: te.NotRequired[ + t.Optional[str] + ] #: Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation. + validate: te.NotRequired[ + t.Optional[bool] + ] #: Can be set to 'false' to skip Lexicon schema validation of record data. class Response(base.ResponseModelBase): diff --git a/packages/atproto_client/models/com/atproto/server/create_account.py b/packages/atproto_client/models/com/atproto/server/create_account.py index adf1db6d..27a5a607 100644 --- a/packages/atproto_client/models/com/atproto/server/create_account.py +++ b/packages/atproto_client/models/com/atproto/server/create_account.py @@ -17,34 +17,46 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.server.createAccount`.""" - handle: str #: Handle. - did: t.Optional[str] = None #: Did. + handle: str #: Requested handle for the account. + did: t.Optional[str] = None #: Pre-existing atproto DID, being imported to a new account. email: t.Optional[str] = None #: Email. invite_code: t.Optional[str] = None #: Invite code. - password: t.Optional[str] = None #: Password. - plc_op: t.Optional['UnknownInputType'] = None #: Plc op. - recovery_key: t.Optional[str] = None #: Recovery key. + password: t.Optional[ + str + ] = None #: Initial account password. May need to meet instance-specific password strength requirements. + plc_op: t.Optional[ + 'UnknownInputType' + ] = None #: 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. + recovery_key: t.Optional[ + str + ] = None #: DID PLC rotation key (aka, recovery key) to be included in PLC creation operation. verification_code: t.Optional[str] = None #: Verification code. verification_phone: t.Optional[str] = None #: Verification phone. class DataDict(te.TypedDict): - handle: str #: Handle. - did: te.NotRequired[t.Optional[str]] #: Did. + handle: str #: Requested handle for the account. + did: te.NotRequired[t.Optional[str]] #: Pre-existing atproto DID, being imported to a new account. email: te.NotRequired[t.Optional[str]] #: Email. invite_code: te.NotRequired[t.Optional[str]] #: Invite code. - password: te.NotRequired[t.Optional[str]] #: Password. - plc_op: te.NotRequired[t.Optional['UnknownInputType']] #: Plc op. - recovery_key: te.NotRequired[t.Optional[str]] #: Recovery key. + password: te.NotRequired[ + t.Optional[str] + ] #: Initial account password. May need to meet instance-specific password strength requirements. + plc_op: te.NotRequired[ + t.Optional['UnknownInputType'] + ] #: 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. + recovery_key: te.NotRequired[ + t.Optional[str] + ] #: DID PLC rotation key (aka, recovery key) to be included in PLC creation operation. verification_code: te.NotRequired[t.Optional[str]] #: Verification code. verification_phone: te.NotRequired[t.Optional[str]] #: Verification phone. class Response(base.ResponseModelBase): - """Output data model for :obj:`com.atproto.server.createAccount`.""" + """Output data model for :obj:`com.atproto.server.createAccount`. Account login session returned on successful account creation.""" access_jwt: str #: Access jwt. - did: str #: Did. + did: str #: The DID of the new account. handle: str #: Handle. refresh_jwt: str #: Refresh jwt. - did_doc: t.Optional['UnknownType'] = None #: Did doc. + did_doc: t.Optional['UnknownType'] = None #: Complete DID document. diff --git a/packages/atproto_client/models/com/atproto/server/create_app_password.py b/packages/atproto_client/models/com/atproto/server/create_app_password.py index 6cf03b63..67931a61 100644 --- a/packages/atproto_client/models/com/atproto/server/create_app_password.py +++ b/packages/atproto_client/models/com/atproto/server/create_app_password.py @@ -14,11 +14,11 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.server.createAppPassword`.""" - name: str #: Name. + name: str #: A short name for the App Password, to help distinguish them. class DataDict(te.TypedDict): - name: str #: Name. + name: str #: A short name for the App Password, to help distinguish them. class AppPassword(base.ModelBase): diff --git a/packages/atproto_client/models/com/atproto/server/describe_server.py b/packages/atproto_client/models/com/atproto/server/describe_server.py index 93c9ebad..867adcc9 100644 --- a/packages/atproto_client/models/com/atproto/server/describe_server.py +++ b/packages/atproto_client/models/com/atproto/server/describe_server.py @@ -18,10 +18,14 @@ class Response(base.ResponseModelBase): """Output data model for :obj:`com.atproto.server.describeServer`.""" - available_user_domains: t.List[str] #: Available user domains. - invite_code_required: t.Optional[bool] = None #: Invite code required. - links: t.Optional['models.ComAtprotoServerDescribeServer.Links'] = None #: Links. - phone_verification_required: t.Optional[bool] = None #: Phone verification required. + available_user_domains: t.List[str] #: List of domain suffixes that can be used in account handles. + invite_code_required: t.Optional[ + bool + ] = None #: If true, an invite code must be supplied to create an account on this instance. + links: t.Optional['models.ComAtprotoServerDescribeServer.Links'] = None #: URLs of service policy documents. + phone_verification_required: t.Optional[ + bool + ] = None #: If true, a phone verification token must be supplied to create an account on this instance. class Links(base.ModelBase): diff --git a/packages/atproto_client/models/com/atproto/server/get_account_invite_codes.py b/packages/atproto_client/models/com/atproto/server/get_account_invite_codes.py index 325d1a55..0cec96c5 100644 --- a/packages/atproto_client/models/com/atproto/server/get_account_invite_codes.py +++ b/packages/atproto_client/models/com/atproto/server/get_account_invite_codes.py @@ -17,12 +17,16 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`com.atproto.server.getAccountInviteCodes`.""" - create_available: t.Optional[bool] = None #: Create available. + create_available: t.Optional[ + bool + ] = None #: Controls whether any new 'earned' but not 'created' invites should be created. include_used: t.Optional[bool] = None #: Include used. class ParamsDict(te.TypedDict): - create_available: te.NotRequired[t.Optional[bool]] #: Create available. + create_available: te.NotRequired[ + t.Optional[bool] + ] #: Controls whether any new 'earned' but not 'created' invites should be created. include_used: te.NotRequired[t.Optional[bool]] #: Include used. diff --git a/packages/atproto_client/models/com/atproto/server/reserve_signing_key.py b/packages/atproto_client/models/com/atproto/server/reserve_signing_key.py index 3b39cb09..62e0aeda 100644 --- a/packages/atproto_client/models/com/atproto/server/reserve_signing_key.py +++ b/packages/atproto_client/models/com/atproto/server/reserve_signing_key.py @@ -15,14 +15,14 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.server.reserveSigningKey`.""" - did: t.Optional[str] = None #: The did to reserve a new did:key for. + did: t.Optional[str] = None #: The DID to reserve a key for. class DataDict(te.TypedDict): - did: te.NotRequired[t.Optional[str]] #: The did to reserve a new did:key for. + did: te.NotRequired[t.Optional[str]] #: The DID to reserve a key for. class Response(base.ResponseModelBase): """Output data model for :obj:`com.atproto.server.reserveSigningKey`.""" - signing_key: str #: Public signing key in the form of a did:key. + signing_key: str #: The public key for the reserved signing key, in did:key serialization. diff --git a/packages/atproto_client/models/com/atproto/sync/get_blob.py b/packages/atproto_client/models/com/atproto/sync/get_blob.py index 5018ca24..8fcf0d26 100644 --- a/packages/atproto_client/models/com/atproto/sync/get_blob.py +++ b/packages/atproto_client/models/com/atproto/sync/get_blob.py @@ -14,12 +14,12 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`com.atproto.sync.getBlob`.""" cid: str #: The CID of the blob to fetch. - did: str #: The DID of the repo. + did: str #: The DID of the account. class ParamsDict(te.TypedDict): cid: str #: The CID of the blob to fetch. - did: str #: The DID of the repo. + did: str #: The DID of the account. #: Response raw data type. diff --git a/packages/atproto_client/models/com/atproto/sync/get_record.py b/packages/atproto_client/models/com/atproto/sync/get_record.py index f75b3123..199aff27 100644 --- a/packages/atproto_client/models/com/atproto/sync/get_record.py +++ b/packages/atproto_client/models/com/atproto/sync/get_record.py @@ -17,14 +17,14 @@ class Params(base.ParamsModelBase): collection: str #: Collection. did: str #: The DID of the repo. - rkey: str #: Rkey. + rkey: str #: Record Key. commit: t.Optional[str] = None #: An optional past commit CID. class ParamsDict(te.TypedDict): collection: str #: Collection. did: str #: The DID of the repo. - rkey: str #: Rkey. + rkey: str #: Record Key. commit: te.NotRequired[t.Optional[str]] #: An optional past commit CID. diff --git a/packages/atproto_client/models/com/atproto/sync/get_repo.py b/packages/atproto_client/models/com/atproto/sync/get_repo.py index 7095f15d..9acf2d93 100644 --- a/packages/atproto_client/models/com/atproto/sync/get_repo.py +++ b/packages/atproto_client/models/com/atproto/sync/get_repo.py @@ -16,12 +16,12 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`com.atproto.sync.getRepo`.""" did: str #: The DID of the repo. - since: t.Optional[str] = None #: The revision of the repo to catch up from. + since: t.Optional[str] = None #: The revision ('rev') of the repo to create a diff from. class ParamsDict(te.TypedDict): did: str #: The DID of the repo. - since: te.NotRequired[t.Optional[str]] #: The revision of the repo to catch up from. + since: te.NotRequired[t.Optional[str]] #: The revision ('rev') of the repo to create a diff from. #: Response raw data type. diff --git a/packages/atproto_client/models/com/atproto/sync/list_repos.py b/packages/atproto_client/models/com/atproto/sync/list_repos.py index 1d4a8a73..6a79d5e7 100644 --- a/packages/atproto_client/models/com/atproto/sync/list_repos.py +++ b/packages/atproto_client/models/com/atproto/sync/list_repos.py @@ -38,7 +38,7 @@ class Repo(base.ModelBase): """Definition model for :obj:`com.atproto.sync.listRepos`.""" did: str #: Did. - head: str #: Head. + head: str #: Current repo commit CID. rev: str #: Rev. py_type: te.Literal['com.atproto.sync.listRepos#repo'] = Field( diff --git a/packages/atproto_client/models/com/atproto/sync/notify_of_update.py b/packages/atproto_client/models/com/atproto/sync/notify_of_update.py index 32c7c03d..20184b17 100644 --- a/packages/atproto_client/models/com/atproto/sync/notify_of_update.py +++ b/packages/atproto_client/models/com/atproto/sync/notify_of_update.py @@ -13,8 +13,8 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.sync.notifyOfUpdate`.""" - hostname: str #: Hostname of the service that is notifying of update. + hostname: str #: Hostname of the current service (usually a PDS) that is notifying of update. class DataDict(te.TypedDict): - hostname: str #: Hostname of the service that is notifying of update. + hostname: str #: Hostname of the current service (usually a PDS) that is notifying of update. diff --git a/packages/atproto_client/models/com/atproto/sync/request_crawl.py b/packages/atproto_client/models/com/atproto/sync/request_crawl.py index d9bf29ba..8ac5a900 100644 --- a/packages/atproto_client/models/com/atproto/sync/request_crawl.py +++ b/packages/atproto_client/models/com/atproto/sync/request_crawl.py @@ -13,8 +13,8 @@ class Data(base.DataModelBase): """Input data model for :obj:`com.atproto.sync.requestCrawl`.""" - hostname: str #: Hostname of the service that is requesting to be crawled. + hostname: str #: Hostname of the current service (eg, PDS) that is requesting to be crawled. class DataDict(te.TypedDict): - hostname: str #: Hostname of the service that is requesting to be crawled. + hostname: str #: Hostname of the current service (eg, PDS) that is requesting to be crawled. diff --git a/packages/atproto_client/models/com/atproto/sync/subscribe_repos.py b/packages/atproto_client/models/com/atproto/sync/subscribe_repos.py index 105d56a9..1346fd3f 100644 --- a/packages/atproto_client/models/com/atproto/sync/subscribe_repos.py +++ b/packages/atproto_client/models/com/atproto/sync/subscribe_repos.py @@ -20,28 +20,32 @@ class Params(base.ParamsModelBase): """Parameters model for :obj:`com.atproto.sync.subscribeRepos`.""" - cursor: t.Optional[int] = None #: The last known event to backfill from. + cursor: t.Optional[int] = None #: The last known event seq number to backfill from. class ParamsDict(te.TypedDict): - cursor: te.NotRequired[t.Optional[int]] #: The last known event to backfill from. + cursor: te.NotRequired[t.Optional[int]] #: The last known event seq number to backfill from. class Commit(base.ModelBase): - """Definition model for :obj:`com.atproto.sync.subscribeRepos`.""" + """Definition model for :obj:`com.atproto.sync.subscribeRepos`. 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.""" blobs: t.List['CIDType'] #: Blobs. - blocks: t.Union[str, bytes] #: CAR file containing relevant blocks. - commit: 'CIDType' #: Commit. + blocks: t.Union[str, bytes] #: CAR file containing relevant blocks, as a diff since the previous repo state. + commit: 'CIDType' #: Repo commit object CID. ops: t.List['models.ComAtprotoSyncSubscribeRepos.RepoOp'] = Field(max_length=200) #: Ops. - rebase: bool #: Rebase. - repo: str #: Repo. - rev: str #: The rev of the emitted commit. - seq: int #: Seq. - time: str #: Time. - too_big: bool #: Too big. - prev: t.Optional['CIDType'] = None #: Prev. - since: t.Optional[str] = None #: The rev of the last emitted commit from this repo. + rebase: bool #: DEPRECATED -- unused. + repo: str #: The repo this event comes from. + rev: str #: 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. + seq: int #: The stream sequence number of this message. + time: str #: Timestamp of when this message was originally broadcast. + too_big: bool #: 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. + prev: t.Optional[ + 'CIDType' + ] = ( + None + ) #: DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability. + since: t.Optional[str] = None #: The rev of the last emitted commit from this repo (if any). py_type: te.Literal['com.atproto.sync.subscribeRepos#commit'] = Field( default='com.atproto.sync.subscribeRepos#commit', alias='$type', frozen=True @@ -49,7 +53,7 @@ class Commit(base.ModelBase): class Handle(base.ModelBase): - """Definition model for :obj:`com.atproto.sync.subscribeRepos`.""" + """Definition model for :obj:`com.atproto.sync.subscribeRepos`. Represents an update of the account's handle, or transition to/from invalid state.""" did: str #: Did. handle: str #: Handle. @@ -62,7 +66,7 @@ class Handle(base.ModelBase): class Migrate(base.ModelBase): - """Definition model for :obj:`com.atproto.sync.subscribeRepos`.""" + """Definition model for :obj:`com.atproto.sync.subscribeRepos`. Represents an account moving from one PDS instance to another. NOTE: not implemented; full account migration may introduce a new message instead.""" did: str #: Did. seq: int #: Seq. @@ -75,7 +79,7 @@ class Migrate(base.ModelBase): class Tombstone(base.ModelBase): - """Definition model for :obj:`com.atproto.sync.subscribeRepos`.""" + """Definition model for :obj:`com.atproto.sync.subscribeRepos`. Indicates that an account has been deleted.""" did: str #: Did. seq: int #: Seq. @@ -98,11 +102,11 @@ class Info(base.ModelBase): class RepoOp(base.ModelBase): - """Definition model for :obj:`com.atproto.sync.subscribeRepos`. 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.""" + """Definition model for :obj:`com.atproto.sync.subscribeRepos`. A repo operation, ie a mutation of a single record.""" action: str #: Action. path: str #: Path. - cid: t.Optional['CIDType'] = None #: Cid. + cid: t.Optional['CIDType'] = None #: For creates and updates, the new record CID. For deletions, null. py_type: te.Literal['com.atproto.sync.subscribeRepos#repoOp'] = Field( default='com.atproto.sync.subscribeRepos#repoOp', alias='$type', frozen=True diff --git a/packages/atproto_client/namespaces/async_ns.py b/packages/atproto_client/namespaces/async_ns.py index ed35c93d..86ab1425 100644 --- a/packages/atproto_client/namespaces/async_ns.py +++ b/packages/atproto_client/namespaces/async_ns.py @@ -195,7 +195,7 @@ async def get_preferences( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyActorGetPreferences.Response': - """Get private preferences attached to the account. + """Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth. Args: params: Parameters. @@ -220,7 +220,7 @@ async def get_profile( params: t.Union[models.AppBskyActorGetProfile.Params, models.AppBskyActorGetProfile.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyActorDefs.ProfileViewDetailed': - """Get detailed profile view of an actor. + """Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth. Args: params: Parameters. @@ -272,7 +272,7 @@ async def get_suggestions( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyActorGetSuggestions.Response': - """Get a list of suggested actors, used for discovery. + """Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding. Args: params: Parameters. @@ -324,7 +324,7 @@ async def search_actors( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyActorSearchActors.Response': - """Find actors (profiles) matching search criteria. + """Find actors (profiles) matching search criteria. Does not require auth. Args: params: Parameters. @@ -353,7 +353,7 @@ async def search_actors_typeahead( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyActorSearchActorsTypeahead.Response': - """Find actor suggestions for a prefix search term. + """Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth. Args: params: Parameters. @@ -1142,7 +1142,7 @@ def __init__(self, client: 'AsyncClientRaw') -> None: self.threadgate = ThreadgateRecord(self._client) async def describe_feed_generator(self, **kwargs: t.Any) -> 'models.AppBskyFeedDescribeFeedGenerator.Response': - """Get information about a feed generator, including policies and offered feed URIs. + """Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View). Args: **kwargs: Arbitrary arguments to HTTP request. @@ -1163,7 +1163,7 @@ async def get_actor_feeds( params: t.Union[models.AppBskyFeedGetActorFeeds.Params, models.AppBskyFeedGetActorFeeds.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetActorFeeds.Response': - """Get a list of feeds created by the actor. + """Get a list of feeds (feed generator records) created by the actor (in the actor's repo). Args: params: Parameters. @@ -1188,7 +1188,7 @@ async def get_actor_likes( params: t.Union[models.AppBskyFeedGetActorLikes.Params, models.AppBskyFeedGetActorLikes.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetActorLikes.Response': - """Get a list of posts liked by an actor. + """Get a list of posts liked by an actor. Does not require auth. Args: params: Parameters. @@ -1213,7 +1213,7 @@ async def get_author_feed( params: t.Union[models.AppBskyFeedGetAuthorFeed.Params, models.AppBskyFeedGetAuthorFeed.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetAuthorFeed.Response': - """Get a view of an actor's feed. + """Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth. Args: params: Parameters. @@ -1236,7 +1236,7 @@ async def get_author_feed( async def get_feed( self, params: t.Union[models.AppBskyFeedGetFeed.Params, models.AppBskyFeedGetFeed.ParamsDict], **kwargs: t.Any ) -> 'models.AppBskyFeedGetFeed.Response': - """Get a hydrated feed from an actor's selected feed generator. + """Get a hydrated feed from an actor's selected feed generator. Implemented by App View. Args: params: Parameters. @@ -1261,7 +1261,7 @@ async def get_feed_generator( params: t.Union[models.AppBskyFeedGetFeedGenerator.Params, models.AppBskyFeedGetFeedGenerator.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetFeedGenerator.Response': - """Get information about a feed generator. + """Get information about a feed generator. Implemented by AppView. Args: params: Parameters. @@ -1313,7 +1313,7 @@ async def get_feed_skeleton( params: t.Union[models.AppBskyFeedGetFeedSkeleton.Params, models.AppBskyFeedGetFeedSkeleton.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetFeedSkeleton.Response': - """Get a skeleton of a feed provided by a feed generator. + """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. Args: params: Parameters. @@ -1336,7 +1336,7 @@ async def get_feed_skeleton( async def get_likes( self, params: t.Union[models.AppBskyFeedGetLikes.Params, models.AppBskyFeedGetLikes.ParamsDict], **kwargs: t.Any ) -> 'models.AppBskyFeedGetLikes.Response': - """Get the list of likes. + """Get like records which reference a subject (by AT-URI and CID). Args: params: Parameters. @@ -1361,7 +1361,7 @@ async def get_list_feed( params: t.Union[models.AppBskyFeedGetListFeed.Params, models.AppBskyFeedGetListFeed.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetListFeed.Response': - """Get a view of a recent posts from actors in a list. + """Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth. Args: params: Parameters. @@ -1386,7 +1386,7 @@ async def get_post_thread( params: t.Union[models.AppBskyFeedGetPostThread.Params, models.AppBskyFeedGetPostThread.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetPostThread.Response': - """Get posts in a thread. + """Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests. Args: params: Parameters. @@ -1409,7 +1409,7 @@ async def get_post_thread( async def get_posts( self, params: t.Union[models.AppBskyFeedGetPosts.Params, models.AppBskyFeedGetPosts.ParamsDict], **kwargs: t.Any ) -> 'models.AppBskyFeedGetPosts.Response': - """Get a view of an actor's feed. + """Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'. Args: params: Parameters. @@ -1434,7 +1434,7 @@ async def get_reposted_by( params: t.Union[models.AppBskyFeedGetRepostedBy.Params, models.AppBskyFeedGetRepostedBy.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetRepostedBy.Response': - """Get a list of reposts. + """Get a list of reposts for a given post. Args: params: Parameters. @@ -1461,7 +1461,7 @@ async def get_suggested_feeds( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyFeedGetSuggestedFeeds.Response': - """Get a list of suggested feeds for the viewer. + """Get a list of suggested feeds (feed generators) for the requesting account. Args: params: Parameters. @@ -1489,7 +1489,7 @@ async def get_timeline( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyFeedGetTimeline.Response': - """Get a view of the actor's home timeline. + """Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed. Args: params: Parameters. @@ -1514,7 +1514,7 @@ async def search_posts( params: t.Union[models.AppBskyFeedSearchPosts.Params, models.AppBskyFeedSearchPosts.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedSearchPosts.Response': - """Find posts matching search criteria. + """Find posts matching search criteria, returning views of those posts. Args: params: Parameters. @@ -2309,7 +2309,7 @@ async def get_blocks( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyGraphGetBlocks.Response': - """Get a list of who the actor is blocking. + """Enumerates which accounts the requesting account is currently blocking. Requires auth. Args: params: Parameters. @@ -2334,7 +2334,7 @@ async def get_followers( params: t.Union[models.AppBskyGraphGetFollowers.Params, models.AppBskyGraphGetFollowers.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetFollowers.Response': - """Get a list of an actor's followers. + """Enumerates accounts which follow a specified account (actor). Args: params: Parameters. @@ -2359,7 +2359,7 @@ async def get_follows( params: t.Union[models.AppBskyGraphGetFollows.Params, models.AppBskyGraphGetFollows.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetFollows.Response': - """Get a list of who the actor follows. + """Enumerates accounts which a specified account (actor) follows. Args: params: Parameters. @@ -2382,7 +2382,7 @@ async def get_follows( async def get_list( self, params: t.Union[models.AppBskyGraphGetList.Params, models.AppBskyGraphGetList.ParamsDict], **kwargs: t.Any ) -> 'models.AppBskyGraphGetList.Response': - """Get a list of actors. + """Gets a 'view' (with additional context) of a specified list. Args: params: Parameters. @@ -2409,7 +2409,7 @@ async def get_list_blocks( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyGraphGetListBlocks.Response': - """Get lists that the actor is blocking. + """Get mod lists that the requesting account (actor) is blocking. Requires auth. Args: params: Parameters. @@ -2436,7 +2436,7 @@ async def get_list_mutes( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyGraphGetListMutes.Response': - """Get lists that the actor is muting. + """Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth. Args: params: Parameters. @@ -2461,7 +2461,7 @@ async def get_lists( params: t.Union[models.AppBskyGraphGetLists.Params, models.AppBskyGraphGetLists.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetLists.Response': - """Get a list of lists that belong to an actor. + """Enumerates the lists created by a specified account (actor). Args: params: Parameters. @@ -2486,7 +2486,7 @@ async def get_mutes( params: t.Optional[t.Union[models.AppBskyGraphGetMutes.Params, models.AppBskyGraphGetMutes.ParamsDict]] = None, **kwargs: t.Any, ) -> 'models.AppBskyGraphGetMutes.Response': - """Get a list of who the actor mutes. + """Enumerates accounts that the requesting account (actor) currently has muted. Requires auth. Args: params: Parameters. @@ -2511,7 +2511,7 @@ async def get_relationships( params: t.Union[models.AppBskyGraphGetRelationships.Params, models.AppBskyGraphGetRelationships.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetRelationships.Response': - """Enumerates public relationships between one account, and a list of other accounts. + """Enumerates public relationships between one account, and a list of other accounts. Does not require auth. Args: params: Parameters. @@ -2540,7 +2540,7 @@ async def get_suggested_follows_by_actor( ], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetSuggestedFollowsByActor.Response': - """Get suggested follows related to a given actor. + """Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account. Args: params: Parameters. @@ -2567,7 +2567,7 @@ async def get_suggested_follows_by_actor( async def mute_actor( self, data: t.Union[models.AppBskyGraphMuteActor.Data, models.AppBskyGraphMuteActor.DataDict], **kwargs: t.Any ) -> bool: - """Mute an actor by DID or handle. + """Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth. Args: data: Input data. @@ -2590,7 +2590,7 @@ async def mute_actor_list( data: t.Union[models.AppBskyGraphMuteActorList.Data, models.AppBskyGraphMuteActorList.DataDict], **kwargs: t.Any, ) -> bool: - """Mute a list of actors. + """Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth. Args: data: Input data. @@ -2615,7 +2615,7 @@ async def unmute_actor( data: t.Union[models.AppBskyGraphUnmuteActor.Data, models.AppBskyGraphUnmuteActor.DataDict], **kwargs: t.Any, ) -> bool: - """Unmute an actor by DID or handle. + """Unmutes the specified account. Requires auth. Args: data: Input data. @@ -2640,7 +2640,7 @@ async def unmute_actor_list( data: t.Union[models.AppBskyGraphUnmuteActorList.Data, models.AppBskyGraphUnmuteActorList.DataDict], **kwargs: t.Any, ) -> bool: - """Unmute a list of actors. + """Unmutes the specified list of accounts. Requires auth. Args: data: Input data. @@ -2671,7 +2671,7 @@ async def get_unread_count( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyNotificationGetUnreadCount.Response': - """Get the count of unread notifications. + """Count the number of unread notifications for the requesting account. Requires auth. Args: params: Parameters. @@ -2702,7 +2702,7 @@ async def list_notifications( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyNotificationListNotifications.Response': - """Get a list of notifications. + """Enumerate notifications for the requesting account. Requires auth. Args: params: Parameters. @@ -2728,7 +2728,7 @@ async def register_push( data: t.Union[models.AppBskyNotificationRegisterPush.Data, models.AppBskyNotificationRegisterPush.DataDict], **kwargs: t.Any, ) -> bool: - """Register for push notifications with a service. + """Register to receive push notifications, via a specified service, for the requesting account. Requires auth. Args: data: Input data. @@ -2754,7 +2754,7 @@ async def update_seen( data: t.Union[models.AppBskyNotificationUpdateSeen.Data, models.AppBskyNotificationUpdateSeen.DataDict], **kwargs: t.Any, ) -> bool: - """Notify server that the user has seen notifications. + """Notify server that the requesting account has seen notifications. Requires auth. Args: data: Input data. @@ -3578,7 +3578,7 @@ async def resolve_handle( ], **kwargs: t.Any, ) -> 'models.ComAtprotoIdentityResolveHandle.Response': - """Provides the DID of a repo. + """Resolves a handle (domain name) to a DID. Args: params: Parameters. @@ -3604,7 +3604,7 @@ async def update_handle( data: t.Union[models.ComAtprotoIdentityUpdateHandle.Data, models.ComAtprotoIdentityUpdateHandle.DataDict], **kwargs: t.Any, ) -> bool: - """Updates the handle of the account. + """Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth. Args: data: Input data. @@ -3632,7 +3632,7 @@ async def query_labels( params: t.Union[models.ComAtprotoLabelQueryLabels.Params, models.ComAtprotoLabelQueryLabels.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoLabelQueryLabels.Response': - """Find labels relevant to the provided URI patterns. + """Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth. Args: params: Parameters. @@ -3659,7 +3659,7 @@ async def create_report( data: t.Union[models.ComAtprotoModerationCreateReport.Data, models.ComAtprotoModerationCreateReport.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoModerationCreateReport.Response': - """Report a repo or a record. + """Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth. Args: data: Input data. @@ -3691,7 +3691,7 @@ async def apply_writes( data: t.Union[models.ComAtprotoRepoApplyWrites.Data, models.ComAtprotoRepoApplyWrites.DataDict], **kwargs: t.Any, ) -> bool: - """Apply a batch transaction of creates, updates, and deletes. + """Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS. Args: data: Input data. @@ -3716,7 +3716,7 @@ async def create_record( data: t.Union[models.ComAtprotoRepoCreateRecord.Data, models.ComAtprotoRepoCreateRecord.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoCreateRecord.Response': - """Create a new record. + """Create a single new repository record. Requires auth, implemented by PDS. Args: data: Input data. @@ -3745,7 +3745,7 @@ async def delete_record( data: t.Union[models.ComAtprotoRepoDeleteRecord.Data, models.ComAtprotoRepoDeleteRecord.DataDict], **kwargs: t.Any, ) -> bool: - """Delete a record, or ensure it doesn't exist. + """Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS. Args: data: Input data. @@ -3770,7 +3770,7 @@ async def describe_repo( params: t.Union[models.ComAtprotoRepoDescribeRepo.Params, models.ComAtprotoRepoDescribeRepo.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoDescribeRepo.Response': - """Get information about the repo, including the list of collections. + """Get information about an account and repository, including the list of collections. Does not require auth. Args: params: Parameters. @@ -3795,7 +3795,7 @@ async def get_record( params: t.Union[models.ComAtprotoRepoGetRecord.Params, models.ComAtprotoRepoGetRecord.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoGetRecord.Response': - """Get a record. + """Get a single record from a repository. Does not require auth. Args: params: Parameters. @@ -3820,7 +3820,7 @@ async def list_records( params: t.Union[models.ComAtprotoRepoListRecords.Params, models.ComAtprotoRepoListRecords.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoListRecords.Response': - """List a range of records in a collection. + """List a range of records in a repository, matching a specific collection. Does not require auth. Args: params: Parameters. @@ -3845,7 +3845,7 @@ async def put_record( data: t.Union[models.ComAtprotoRepoPutRecord.Data, models.ComAtprotoRepoPutRecord.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoPutRecord.Response': - """Write a record, creating or updating it as needed. + """Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS. Args: data: Input data. @@ -3872,7 +3872,7 @@ async def put_record( async def upload_blob( self, data: 'models.ComAtprotoRepoUploadBlob.Data', **kwargs: t.Any ) -> 'models.ComAtprotoRepoUploadBlob.Response': - """Upload a new blob to be added to repo in a later request. + """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. Args: data: Input data alias. @@ -3921,7 +3921,7 @@ async def create_account( data: t.Union[models.ComAtprotoServerCreateAccount.Data, models.ComAtprotoServerCreateAccount.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoServerCreateAccount.Response': - """Create an account. + """Create an account. Implemented by PDS. Args: data: Input data. @@ -4069,7 +4069,7 @@ async def delete_account( data: t.Union[models.ComAtprotoServerDeleteAccount.Data, models.ComAtprotoServerDeleteAccount.DataDict], **kwargs: t.Any, ) -> bool: - """Delete an actor's account with a token and password. + """Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth. Args: data: Input data. @@ -4090,7 +4090,7 @@ async def delete_account( return get_response_model(response, bool) async def delete_session(self, **kwargs: t.Any) -> bool: - """Delete the current session. + """Delete the current session. Requires auth. Args: **kwargs: Arbitrary arguments to HTTP request. @@ -4105,7 +4105,7 @@ async def delete_session(self, **kwargs: t.Any) -> bool: return get_response_model(response, bool) async def describe_server(self, **kwargs: t.Any) -> 'models.ComAtprotoServerDescribeServer.Response': - """Get a document describing the service's accounts configuration. + """Describes the server's account creation requirements and capabilities. Implemented by PDS. Args: **kwargs: Arbitrary arguments to HTTP request. @@ -4131,7 +4131,7 @@ async def get_account_invite_codes( ] = None, **kwargs: t.Any, ) -> 'models.ComAtprotoServerGetAccountInviteCodes.Response': - """Get all invite codes for a given account. + """Get all invite codes for the current account. Requires auth. Args: params: Parameters. @@ -4156,7 +4156,7 @@ async def get_account_invite_codes( return get_response_model(response, models.ComAtprotoServerGetAccountInviteCodes.Response) async def get_session(self, **kwargs: t.Any) -> 'models.ComAtprotoServerGetSession.Response': - """Get information about the current session. + """Get information about the current auth session. Requires auth. Args: **kwargs: Arbitrary arguments to HTTP request. @@ -4190,7 +4190,7 @@ async def list_app_passwords(self, **kwargs: t.Any) -> 'models.ComAtprotoServerL return get_response_model(response, models.ComAtprotoServerListAppPasswords.Response) async def refresh_session(self, **kwargs: t.Any) -> 'models.ComAtprotoServerRefreshSession.Response': - """Refresh an authentication session. + """Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt'). Args: **kwargs: Arbitrary arguments to HTTP request. @@ -4288,7 +4288,7 @@ async def reserve_signing_key( ] = None, **kwargs: t.Any, ) -> 'models.ComAtprotoServerReserveSigningKey.Response': - """Reserve a repo signing key for account creation. + """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. Args: data: Input data. @@ -4396,7 +4396,7 @@ async def get_blob( params: t.Union[models.ComAtprotoSyncGetBlob.Params, models.ComAtprotoSyncGetBlob.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetBlob.Response': - """Get a blob associated with a given repo. + """Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS. Args: params: Parameters. @@ -4421,7 +4421,7 @@ async def get_blocks( params: t.Union[models.ComAtprotoSyncGetBlocks.Params, models.ComAtprotoSyncGetBlocks.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetBlocks.Response': - """Get blocks from a given repo. + """Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS. Args: params: Parameters. @@ -4496,7 +4496,7 @@ async def get_latest_commit( params: t.Union[models.ComAtprotoSyncGetLatestCommit.Params, models.ComAtprotoSyncGetLatestCommit.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetLatestCommit.Response': - """Get the current commit CID & revision of the repo. + """Get the current commit CID & revision of the specified repo. Does not require auth. Args: params: Parameters. @@ -4522,7 +4522,7 @@ async def get_record( params: t.Union[models.ComAtprotoSyncGetRecord.Params, models.ComAtprotoSyncGetRecord.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetRecord.Response': - """Get blocks needed for existence or non-existence of record. + """Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth. Args: params: Parameters. @@ -4547,7 +4547,7 @@ async def get_repo( params: t.Union[models.ComAtprotoSyncGetRepo.Params, models.ComAtprotoSyncGetRepo.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetRepo.Response': - """Gets the DID's repo, optionally catching up from a specific revision. + """Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS. Args: params: Parameters. @@ -4572,7 +4572,7 @@ async def list_blobs( params: t.Union[models.ComAtprotoSyncListBlobs.Params, models.ComAtprotoSyncListBlobs.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncListBlobs.Response': - """List blob CIDs since some revision. + """List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS. Args: params: Parameters. @@ -4599,7 +4599,7 @@ async def list_repos( ] = None, **kwargs: t.Any, ) -> 'models.ComAtprotoSyncListRepos.Response': - """List DIDs and root CIDs of hosted repos. + """Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay. Args: params: Parameters. @@ -4624,7 +4624,7 @@ async def notify_of_update( data: t.Union[models.ComAtprotoSyncNotifyOfUpdate.Data, models.ComAtprotoSyncNotifyOfUpdate.DataDict], **kwargs: t.Any, ) -> bool: - """Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break. + """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. Args: data: Input data. @@ -4649,7 +4649,7 @@ async def request_crawl( data: t.Union[models.ComAtprotoSyncRequestCrawl.Data, models.ComAtprotoSyncRequestCrawl.DataDict], **kwargs: t.Any, ) -> bool: - """Request a service to persistently crawl hosted repos. + """Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth. Args: data: Input data. @@ -4695,7 +4695,7 @@ async def fetch_labels( ] = None, **kwargs: t.Any, ) -> 'models.ComAtprotoTempFetchLabels.Response': - """Fetch all labels from a labeler created after a certain date. + """Fetch all labels from a labeler created after a certain date. DEPRECATED: use queryLabels or subscribeLabels instead. Args: params: Parameters. @@ -4807,7 +4807,7 @@ async def transfer_account( data: t.Union[models.ComAtprotoTempTransferAccount.Data, models.ComAtprotoTempTransferAccount.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoTempTransferAccount.Response': - """Transfer an account. + """Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented. Args: data: Input data. diff --git a/packages/atproto_client/namespaces/sync_ns.py b/packages/atproto_client/namespaces/sync_ns.py index 61f485ae..f8b1de35 100644 --- a/packages/atproto_client/namespaces/sync_ns.py +++ b/packages/atproto_client/namespaces/sync_ns.py @@ -195,7 +195,7 @@ def get_preferences( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyActorGetPreferences.Response': - """Get private preferences attached to the account. + """Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth. Args: params: Parameters. @@ -220,7 +220,7 @@ def get_profile( params: t.Union[models.AppBskyActorGetProfile.Params, models.AppBskyActorGetProfile.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyActorDefs.ProfileViewDetailed': - """Get detailed profile view of an actor. + """Get detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth. Args: params: Parameters. @@ -272,7 +272,7 @@ def get_suggestions( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyActorGetSuggestions.Response': - """Get a list of suggested actors, used for discovery. + """Get a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding. Args: params: Parameters. @@ -324,7 +324,7 @@ def search_actors( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyActorSearchActors.Response': - """Find actors (profiles) matching search criteria. + """Find actors (profiles) matching search criteria. Does not require auth. Args: params: Parameters. @@ -353,7 +353,7 @@ def search_actors_typeahead( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyActorSearchActorsTypeahead.Response': - """Find actor suggestions for a prefix search term. + """Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth. Args: params: Parameters. @@ -1142,7 +1142,7 @@ def __init__(self, client: 'ClientRaw') -> None: self.threadgate = ThreadgateRecord(self._client) def describe_feed_generator(self, **kwargs: t.Any) -> 'models.AppBskyFeedDescribeFeedGenerator.Response': - """Get information about a feed generator, including policies and offered feed URIs. + """Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View). Args: **kwargs: Arbitrary arguments to HTTP request. @@ -1163,7 +1163,7 @@ def get_actor_feeds( params: t.Union[models.AppBskyFeedGetActorFeeds.Params, models.AppBskyFeedGetActorFeeds.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetActorFeeds.Response': - """Get a list of feeds created by the actor. + """Get a list of feeds (feed generator records) created by the actor (in the actor's repo). Args: params: Parameters. @@ -1188,7 +1188,7 @@ def get_actor_likes( params: t.Union[models.AppBskyFeedGetActorLikes.Params, models.AppBskyFeedGetActorLikes.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetActorLikes.Response': - """Get a list of posts liked by an actor. + """Get a list of posts liked by an actor. Does not require auth. Args: params: Parameters. @@ -1213,7 +1213,7 @@ def get_author_feed( params: t.Union[models.AppBskyFeedGetAuthorFeed.Params, models.AppBskyFeedGetAuthorFeed.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetAuthorFeed.Response': - """Get a view of an actor's feed. + """Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth. Args: params: Parameters. @@ -1236,7 +1236,7 @@ def get_author_feed( def get_feed( self, params: t.Union[models.AppBskyFeedGetFeed.Params, models.AppBskyFeedGetFeed.ParamsDict], **kwargs: t.Any ) -> 'models.AppBskyFeedGetFeed.Response': - """Get a hydrated feed from an actor's selected feed generator. + """Get a hydrated feed from an actor's selected feed generator. Implemented by App View. Args: params: Parameters. @@ -1261,7 +1261,7 @@ def get_feed_generator( params: t.Union[models.AppBskyFeedGetFeedGenerator.Params, models.AppBskyFeedGetFeedGenerator.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetFeedGenerator.Response': - """Get information about a feed generator. + """Get information about a feed generator. Implemented by AppView. Args: params: Parameters. @@ -1313,7 +1313,7 @@ def get_feed_skeleton( params: t.Union[models.AppBskyFeedGetFeedSkeleton.Params, models.AppBskyFeedGetFeedSkeleton.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetFeedSkeleton.Response': - """Get a skeleton of a feed provided by a feed generator. + """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. Args: params: Parameters. @@ -1336,7 +1336,7 @@ def get_feed_skeleton( def get_likes( self, params: t.Union[models.AppBskyFeedGetLikes.Params, models.AppBskyFeedGetLikes.ParamsDict], **kwargs: t.Any ) -> 'models.AppBskyFeedGetLikes.Response': - """Get the list of likes. + """Get like records which reference a subject (by AT-URI and CID). Args: params: Parameters. @@ -1361,7 +1361,7 @@ def get_list_feed( params: t.Union[models.AppBskyFeedGetListFeed.Params, models.AppBskyFeedGetListFeed.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetListFeed.Response': - """Get a view of a recent posts from actors in a list. + """Get a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth. Args: params: Parameters. @@ -1386,7 +1386,7 @@ def get_post_thread( params: t.Union[models.AppBskyFeedGetPostThread.Params, models.AppBskyFeedGetPostThread.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetPostThread.Response': - """Get posts in a thread. + """Get posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests. Args: params: Parameters. @@ -1409,7 +1409,7 @@ def get_post_thread( def get_posts( self, params: t.Union[models.AppBskyFeedGetPosts.Params, models.AppBskyFeedGetPosts.ParamsDict], **kwargs: t.Any ) -> 'models.AppBskyFeedGetPosts.Response': - """Get a view of an actor's feed. + """Gets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'. Args: params: Parameters. @@ -1434,7 +1434,7 @@ def get_reposted_by( params: t.Union[models.AppBskyFeedGetRepostedBy.Params, models.AppBskyFeedGetRepostedBy.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedGetRepostedBy.Response': - """Get a list of reposts. + """Get a list of reposts for a given post. Args: params: Parameters. @@ -1461,7 +1461,7 @@ def get_suggested_feeds( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyFeedGetSuggestedFeeds.Response': - """Get a list of suggested feeds for the viewer. + """Get a list of suggested feeds (feed generators) for the requesting account. Args: params: Parameters. @@ -1489,7 +1489,7 @@ def get_timeline( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyFeedGetTimeline.Response': - """Get a view of the actor's home timeline. + """Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed. Args: params: Parameters. @@ -1514,7 +1514,7 @@ def search_posts( params: t.Union[models.AppBskyFeedSearchPosts.Params, models.AppBskyFeedSearchPosts.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyFeedSearchPosts.Response': - """Find posts matching search criteria. + """Find posts matching search criteria, returning views of those posts. Args: params: Parameters. @@ -2309,7 +2309,7 @@ def get_blocks( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyGraphGetBlocks.Response': - """Get a list of who the actor is blocking. + """Enumerates which accounts the requesting account is currently blocking. Requires auth. Args: params: Parameters. @@ -2334,7 +2334,7 @@ def get_followers( params: t.Union[models.AppBskyGraphGetFollowers.Params, models.AppBskyGraphGetFollowers.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetFollowers.Response': - """Get a list of an actor's followers. + """Enumerates accounts which follow a specified account (actor). Args: params: Parameters. @@ -2359,7 +2359,7 @@ def get_follows( params: t.Union[models.AppBskyGraphGetFollows.Params, models.AppBskyGraphGetFollows.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetFollows.Response': - """Get a list of who the actor follows. + """Enumerates accounts which a specified account (actor) follows. Args: params: Parameters. @@ -2382,7 +2382,7 @@ def get_follows( def get_list( self, params: t.Union[models.AppBskyGraphGetList.Params, models.AppBskyGraphGetList.ParamsDict], **kwargs: t.Any ) -> 'models.AppBskyGraphGetList.Response': - """Get a list of actors. + """Gets a 'view' (with additional context) of a specified list. Args: params: Parameters. @@ -2409,7 +2409,7 @@ def get_list_blocks( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyGraphGetListBlocks.Response': - """Get lists that the actor is blocking. + """Get mod lists that the requesting account (actor) is blocking. Requires auth. Args: params: Parameters. @@ -2436,7 +2436,7 @@ def get_list_mutes( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyGraphGetListMutes.Response': - """Get lists that the actor is muting. + """Enumerates mod lists that the requesting account (actor) currently has muted. Requires auth. Args: params: Parameters. @@ -2461,7 +2461,7 @@ def get_lists( params: t.Union[models.AppBskyGraphGetLists.Params, models.AppBskyGraphGetLists.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetLists.Response': - """Get a list of lists that belong to an actor. + """Enumerates the lists created by a specified account (actor). Args: params: Parameters. @@ -2486,7 +2486,7 @@ def get_mutes( params: t.Optional[t.Union[models.AppBskyGraphGetMutes.Params, models.AppBskyGraphGetMutes.ParamsDict]] = None, **kwargs: t.Any, ) -> 'models.AppBskyGraphGetMutes.Response': - """Get a list of who the actor mutes. + """Enumerates accounts that the requesting account (actor) currently has muted. Requires auth. Args: params: Parameters. @@ -2511,7 +2511,7 @@ def get_relationships( params: t.Union[models.AppBskyGraphGetRelationships.Params, models.AppBskyGraphGetRelationships.ParamsDict], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetRelationships.Response': - """Enumerates public relationships between one account, and a list of other accounts. + """Enumerates public relationships between one account, and a list of other accounts. Does not require auth. Args: params: Parameters. @@ -2540,7 +2540,7 @@ def get_suggested_follows_by_actor( ], **kwargs: t.Any, ) -> 'models.AppBskyGraphGetSuggestedFollowsByActor.Response': - """Get suggested follows related to a given actor. + """Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account. Args: params: Parameters. @@ -2567,7 +2567,7 @@ def get_suggested_follows_by_actor( def mute_actor( self, data: t.Union[models.AppBskyGraphMuteActor.Data, models.AppBskyGraphMuteActor.DataDict], **kwargs: t.Any ) -> bool: - """Mute an actor by DID or handle. + """Creates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth. Args: data: Input data. @@ -2590,7 +2590,7 @@ def mute_actor_list( data: t.Union[models.AppBskyGraphMuteActorList.Data, models.AppBskyGraphMuteActorList.DataDict], **kwargs: t.Any, ) -> bool: - """Mute a list of actors. + """Creates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth. Args: data: Input data. @@ -2615,7 +2615,7 @@ def unmute_actor( data: t.Union[models.AppBskyGraphUnmuteActor.Data, models.AppBskyGraphUnmuteActor.DataDict], **kwargs: t.Any, ) -> bool: - """Unmute an actor by DID or handle. + """Unmutes the specified account. Requires auth. Args: data: Input data. @@ -2640,7 +2640,7 @@ def unmute_actor_list( data: t.Union[models.AppBskyGraphUnmuteActorList.Data, models.AppBskyGraphUnmuteActorList.DataDict], **kwargs: t.Any, ) -> bool: - """Unmute a list of actors. + """Unmutes the specified list of accounts. Requires auth. Args: data: Input data. @@ -2671,7 +2671,7 @@ def get_unread_count( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyNotificationGetUnreadCount.Response': - """Get the count of unread notifications. + """Count the number of unread notifications for the requesting account. Requires auth. Args: params: Parameters. @@ -2702,7 +2702,7 @@ def list_notifications( ] = None, **kwargs: t.Any, ) -> 'models.AppBskyNotificationListNotifications.Response': - """Get a list of notifications. + """Enumerate notifications for the requesting account. Requires auth. Args: params: Parameters. @@ -2728,7 +2728,7 @@ def register_push( data: t.Union[models.AppBskyNotificationRegisterPush.Data, models.AppBskyNotificationRegisterPush.DataDict], **kwargs: t.Any, ) -> bool: - """Register for push notifications with a service. + """Register to receive push notifications, via a specified service, for the requesting account. Requires auth. Args: data: Input data. @@ -2754,7 +2754,7 @@ def update_seen( data: t.Union[models.AppBskyNotificationUpdateSeen.Data, models.AppBskyNotificationUpdateSeen.DataDict], **kwargs: t.Any, ) -> bool: - """Notify server that the user has seen notifications. + """Notify server that the requesting account has seen notifications. Requires auth. Args: data: Input data. @@ -3578,7 +3578,7 @@ def resolve_handle( ], **kwargs: t.Any, ) -> 'models.ComAtprotoIdentityResolveHandle.Response': - """Provides the DID of a repo. + """Resolves a handle (domain name) to a DID. Args: params: Parameters. @@ -3604,7 +3604,7 @@ def update_handle( data: t.Union[models.ComAtprotoIdentityUpdateHandle.Data, models.ComAtprotoIdentityUpdateHandle.DataDict], **kwargs: t.Any, ) -> bool: - """Updates the handle of the account. + """Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth. Args: data: Input data. @@ -3632,7 +3632,7 @@ def query_labels( params: t.Union[models.ComAtprotoLabelQueryLabels.Params, models.ComAtprotoLabelQueryLabels.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoLabelQueryLabels.Response': - """Find labels relevant to the provided URI patterns. + """Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth. Args: params: Parameters. @@ -3659,7 +3659,7 @@ def create_report( data: t.Union[models.ComAtprotoModerationCreateReport.Data, models.ComAtprotoModerationCreateReport.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoModerationCreateReport.Response': - """Report a repo or a record. + """Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth. Args: data: Input data. @@ -3691,7 +3691,7 @@ def apply_writes( data: t.Union[models.ComAtprotoRepoApplyWrites.Data, models.ComAtprotoRepoApplyWrites.DataDict], **kwargs: t.Any, ) -> bool: - """Apply a batch transaction of creates, updates, and deletes. + """Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS. Args: data: Input data. @@ -3716,7 +3716,7 @@ def create_record( data: t.Union[models.ComAtprotoRepoCreateRecord.Data, models.ComAtprotoRepoCreateRecord.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoCreateRecord.Response': - """Create a new record. + """Create a single new repository record. Requires auth, implemented by PDS. Args: data: Input data. @@ -3745,7 +3745,7 @@ def delete_record( data: t.Union[models.ComAtprotoRepoDeleteRecord.Data, models.ComAtprotoRepoDeleteRecord.DataDict], **kwargs: t.Any, ) -> bool: - """Delete a record, or ensure it doesn't exist. + """Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS. Args: data: Input data. @@ -3770,7 +3770,7 @@ def describe_repo( params: t.Union[models.ComAtprotoRepoDescribeRepo.Params, models.ComAtprotoRepoDescribeRepo.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoDescribeRepo.Response': - """Get information about the repo, including the list of collections. + """Get information about an account and repository, including the list of collections. Does not require auth. Args: params: Parameters. @@ -3795,7 +3795,7 @@ def get_record( params: t.Union[models.ComAtprotoRepoGetRecord.Params, models.ComAtprotoRepoGetRecord.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoGetRecord.Response': - """Get a record. + """Get a single record from a repository. Does not require auth. Args: params: Parameters. @@ -3820,7 +3820,7 @@ def list_records( params: t.Union[models.ComAtprotoRepoListRecords.Params, models.ComAtprotoRepoListRecords.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoListRecords.Response': - """List a range of records in a collection. + """List a range of records in a repository, matching a specific collection. Does not require auth. Args: params: Parameters. @@ -3845,7 +3845,7 @@ def put_record( data: t.Union[models.ComAtprotoRepoPutRecord.Data, models.ComAtprotoRepoPutRecord.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoRepoPutRecord.Response': - """Write a record, creating or updating it as needed. + """Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS. Args: data: Input data. @@ -3872,7 +3872,7 @@ def put_record( def upload_blob( self, data: 'models.ComAtprotoRepoUploadBlob.Data', **kwargs: t.Any ) -> 'models.ComAtprotoRepoUploadBlob.Response': - """Upload a new blob to be added to repo in a later request. + """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. Args: data: Input data alias. @@ -3921,7 +3921,7 @@ def create_account( data: t.Union[models.ComAtprotoServerCreateAccount.Data, models.ComAtprotoServerCreateAccount.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoServerCreateAccount.Response': - """Create an account. + """Create an account. Implemented by PDS. Args: data: Input data. @@ -4069,7 +4069,7 @@ def delete_account( data: t.Union[models.ComAtprotoServerDeleteAccount.Data, models.ComAtprotoServerDeleteAccount.DataDict], **kwargs: t.Any, ) -> bool: - """Delete an actor's account with a token and password. + """Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth. Args: data: Input data. @@ -4090,7 +4090,7 @@ def delete_account( return get_response_model(response, bool) def delete_session(self, **kwargs: t.Any) -> bool: - """Delete the current session. + """Delete the current session. Requires auth. Args: **kwargs: Arbitrary arguments to HTTP request. @@ -4105,7 +4105,7 @@ def delete_session(self, **kwargs: t.Any) -> bool: return get_response_model(response, bool) def describe_server(self, **kwargs: t.Any) -> 'models.ComAtprotoServerDescribeServer.Response': - """Get a document describing the service's accounts configuration. + """Describes the server's account creation requirements and capabilities. Implemented by PDS. Args: **kwargs: Arbitrary arguments to HTTP request. @@ -4131,7 +4131,7 @@ def get_account_invite_codes( ] = None, **kwargs: t.Any, ) -> 'models.ComAtprotoServerGetAccountInviteCodes.Response': - """Get all invite codes for a given account. + """Get all invite codes for the current account. Requires auth. Args: params: Parameters. @@ -4156,7 +4156,7 @@ def get_account_invite_codes( return get_response_model(response, models.ComAtprotoServerGetAccountInviteCodes.Response) def get_session(self, **kwargs: t.Any) -> 'models.ComAtprotoServerGetSession.Response': - """Get information about the current session. + """Get information about the current auth session. Requires auth. Args: **kwargs: Arbitrary arguments to HTTP request. @@ -4190,7 +4190,7 @@ def list_app_passwords(self, **kwargs: t.Any) -> 'models.ComAtprotoServerListApp return get_response_model(response, models.ComAtprotoServerListAppPasswords.Response) def refresh_session(self, **kwargs: t.Any) -> 'models.ComAtprotoServerRefreshSession.Response': - """Refresh an authentication session. + """Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt'). Args: **kwargs: Arbitrary arguments to HTTP request. @@ -4288,7 +4288,7 @@ def reserve_signing_key( ] = None, **kwargs: t.Any, ) -> 'models.ComAtprotoServerReserveSigningKey.Response': - """Reserve a repo signing key for account creation. + """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. Args: data: Input data. @@ -4396,7 +4396,7 @@ def get_blob( params: t.Union[models.ComAtprotoSyncGetBlob.Params, models.ComAtprotoSyncGetBlob.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetBlob.Response': - """Get a blob associated with a given repo. + """Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS. Args: params: Parameters. @@ -4421,7 +4421,7 @@ def get_blocks( params: t.Union[models.ComAtprotoSyncGetBlocks.Params, models.ComAtprotoSyncGetBlocks.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetBlocks.Response': - """Get blocks from a given repo. + """Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS. Args: params: Parameters. @@ -4496,7 +4496,7 @@ def get_latest_commit( params: t.Union[models.ComAtprotoSyncGetLatestCommit.Params, models.ComAtprotoSyncGetLatestCommit.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetLatestCommit.Response': - """Get the current commit CID & revision of the repo. + """Get the current commit CID & revision of the specified repo. Does not require auth. Args: params: Parameters. @@ -4522,7 +4522,7 @@ def get_record( params: t.Union[models.ComAtprotoSyncGetRecord.Params, models.ComAtprotoSyncGetRecord.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetRecord.Response': - """Get blocks needed for existence or non-existence of record. + """Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth. Args: params: Parameters. @@ -4547,7 +4547,7 @@ def get_repo( params: t.Union[models.ComAtprotoSyncGetRepo.Params, models.ComAtprotoSyncGetRepo.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncGetRepo.Response': - """Gets the DID's repo, optionally catching up from a specific revision. + """Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS. Args: params: Parameters. @@ -4572,7 +4572,7 @@ def list_blobs( params: t.Union[models.ComAtprotoSyncListBlobs.Params, models.ComAtprotoSyncListBlobs.ParamsDict], **kwargs: t.Any, ) -> 'models.ComAtprotoSyncListBlobs.Response': - """List blob CIDs since some revision. + """List blob CIDso for an account, since some repo revision. Does not require auth; implemented by PDS. Args: params: Parameters. @@ -4599,7 +4599,7 @@ def list_repos( ] = None, **kwargs: t.Any, ) -> 'models.ComAtprotoSyncListRepos.Response': - """List DIDs and root CIDs of hosted repos. + """Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay. Args: params: Parameters. @@ -4624,7 +4624,7 @@ def notify_of_update( data: t.Union[models.ComAtprotoSyncNotifyOfUpdate.Data, models.ComAtprotoSyncNotifyOfUpdate.DataDict], **kwargs: t.Any, ) -> bool: - """Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break. + """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. Args: data: Input data. @@ -4649,7 +4649,7 @@ def request_crawl( data: t.Union[models.ComAtprotoSyncRequestCrawl.Data, models.ComAtprotoSyncRequestCrawl.DataDict], **kwargs: t.Any, ) -> bool: - """Request a service to persistently crawl hosted repos. + """Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth. Args: data: Input data. @@ -4695,7 +4695,7 @@ def fetch_labels( ] = None, **kwargs: t.Any, ) -> 'models.ComAtprotoTempFetchLabels.Response': - """Fetch all labels from a labeler created after a certain date. + """Fetch all labels from a labeler created after a certain date. DEPRECATED: use queryLabels or subscribeLabels instead. Args: params: Parameters. @@ -4807,7 +4807,7 @@ def transfer_account( data: t.Union[models.ComAtprotoTempTransferAccount.Data, models.ComAtprotoTempTransferAccount.DataDict], **kwargs: t.Any, ) -> 'models.ComAtprotoTempTransferAccount.Response': - """Transfer an account. + """Transfer an account. NOTE: temporary method, necessarily how account migration will be implemented. Args: data: Input data.