diff --git a/lexicons/app/bsky/actor/defs.json b/lexicons/app/bsky/actor/defs.json index 063072ba181..913957f1291 100644 --- a/lexicons/app/bsky/actor/defs.json +++ b/lexicons/app/bsky/actor/defs.json @@ -152,7 +152,7 @@ "birthDate": { "type": "string", "format": "datetime", - "description": "The birth date of the owner of the account." + "description": "The birth date of account owner." } } }, @@ -191,7 +191,7 @@ "properties": { "sort": { "type": "string", - "description": "Sorting mode.", + "description": "Sorting mode for threads.", "knownValues": ["oldest", "newest", "most-likes", "random"] }, "prioritizeFollowedUsers": { diff --git a/lexicons/app/bsky/actor/getProfile.json b/lexicons/app/bsky/actor/getProfile.json index d04ed0e159b..1bb2ad2fea1 100644 --- a/lexicons/app/bsky/actor/getProfile.json +++ b/lexicons/app/bsky/actor/getProfile.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "query", + "description": "Get detailed profile view of an actor.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app/bsky/actor/getProfiles.json b/lexicons/app/bsky/actor/getProfiles.json index ded213b6671..c89622cb18c 100644 --- a/lexicons/app/bsky/actor/getProfiles.json +++ b/lexicons/app/bsky/actor/getProfiles.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "query", + "description": "Get detailed profile views of multiple actors.", "parameters": { "type": "params", "required": ["actors"], diff --git a/lexicons/app/bsky/actor/getSuggestions.json b/lexicons/app/bsky/actor/getSuggestions.json index 38c30c2c9a6..74465dfdf2e 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 actors suggested for following. Used in discovery UIs.", + "description": "Get a list of suggested actors, used for discovery.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/actor/profile.json b/lexicons/app/bsky/actor/profile.json index e0f476deb73..e1b7c6a2b96 100644 --- a/lexicons/app/bsky/actor/profile.json +++ b/lexicons/app/bsky/actor/profile.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "record", + "description": "A declaration of a profile.", "key": "literal:self", "record": { "type": "object", diff --git a/lexicons/app/bsky/actor/putPreferences.json b/lexicons/app/bsky/actor/putPreferences.json index fff2cdbe495..425ea28c48b 100644 --- a/lexicons/app/bsky/actor/putPreferences.json +++ b/lexicons/app/bsky/actor/putPreferences.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Sets the private preferences attached to the account.", + "description": "Set the private preferences attached to the account.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app/bsky/actor/searchActors.json b/lexicons/app/bsky/actor/searchActors.json index f65e2fc953b..48fbacf4fcc 100644 --- a/lexicons/app/bsky/actor/searchActors.json +++ b/lexicons/app/bsky/actor/searchActors.json @@ -10,11 +10,11 @@ "properties": { "term": { "type": "string", - "description": "DEPRECATED: use 'q' instead" + "description": "DEPRECATED: use 'q' instead." }, "q": { "type": "string", - "description": "search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended" + "description": "Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended." }, "limit": { "type": "integer", diff --git a/lexicons/app/bsky/actor/searchActorsTypeahead.json b/lexicons/app/bsky/actor/searchActorsTypeahead.json index f94dd6c3f69..495b7081c38 100644 --- a/lexicons/app/bsky/actor/searchActorsTypeahead.json +++ b/lexicons/app/bsky/actor/searchActorsTypeahead.json @@ -4,17 +4,17 @@ "defs": { "main": { "type": "query", - "description": "Find actor suggestions for a search term.", + "description": "Find actor suggestions for a prefix search term.", "parameters": { "type": "params", "properties": { "term": { "type": "string", - "description": "DEPRECATED: use 'q' instead" + "description": "DEPRECATED: use 'q' instead." }, "q": { "type": "string", - "description": "search query prefix; not a full query string" + "description": "Search query prefix; not a full query string." }, "limit": { "type": "integer", diff --git a/lexicons/app/bsky/embed/external.json b/lexicons/app/bsky/embed/external.json index 694787eb507..8946382835f 100644 --- a/lexicons/app/bsky/embed/external.json +++ b/lexicons/app/bsky/embed/external.json @@ -1,7 +1,7 @@ { "lexicon": 1, "id": "app.bsky.embed.external", - "description": "A representation of some externally linked content, embedded in another form of content", + "description": "A representation of some externally linked content, embedded in another form of content.", "defs": { "main": { "type": "object", diff --git a/lexicons/app/bsky/embed/images.json b/lexicons/app/bsky/embed/images.json index 48975a60ae2..5baa7ab3f74 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 some other form of content.", "defs": { "main": { "type": "object", diff --git a/lexicons/app/bsky/embed/record.json b/lexicons/app/bsky/embed/record.json index 0d7cb830ba8..4b3d4f814a5 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 another form of content.", "defs": { "main": { "type": "object", diff --git a/lexicons/app/bsky/embed/recordWithMedia.json b/lexicons/app/bsky/embed/recordWithMedia.json index 296494d9ebc..9bc5fe09048 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 another form of content, alongside other compatible embeds.", "defs": { "main": { "type": "object", diff --git a/lexicons/app/bsky/feed/describeFeedGenerator.json b/lexicons/app/bsky/feed/describeFeedGenerator.json index 69c143e6016..f95027183a1 100644 --- a/lexicons/app/bsky/feed/describeFeedGenerator.json +++ b/lexicons/app/bsky/feed/describeFeedGenerator.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Returns information about a given feed generator including TOS & offered feed URIs", + "description": "Get information about a feed generator, including policies and offered feed URIs.", "output": { "encoding": "application/json", "schema": { diff --git a/lexicons/app/bsky/feed/generator.json b/lexicons/app/bsky/feed/generator.json index e31bb4484e1..8c00884ad28 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": "A declaration of the existence of a feed generator.", "key": "any", "record": { "type": "object", diff --git a/lexicons/app/bsky/feed/getActorFeeds.json b/lexicons/app/bsky/feed/getActorFeeds.json index f34aece1609..a0620477bc3 100644 --- a/lexicons/app/bsky/feed/getActorFeeds.json +++ b/lexicons/app/bsky/feed/getActorFeeds.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Retrieve a list of feeds created by a given actor", + "description": "Get a list of feeds created by the actor.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app/bsky/feed/getActorLikes.json b/lexicons/app/bsky/feed/getActorLikes.json index df5e45a4295..b3baa58a457 100644 --- a/lexicons/app/bsky/feed/getActorLikes.json +++ b/lexicons/app/bsky/feed/getActorLikes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "A view of the posts liked by an actor.", + "description": "Get a list of posts liked by an actor.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app/bsky/feed/getAuthorFeed.json b/lexicons/app/bsky/feed/getAuthorFeed.json index c1edfb21330..27dccf63e20 100644 --- a/lexicons/app/bsky/feed/getAuthorFeed.json +++ b/lexicons/app/bsky/feed/getAuthorFeed.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "A view of an actor's feed.", + "description": "Get a view of an actor's feed.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app/bsky/feed/getFeed.json b/lexicons/app/bsky/feed/getFeed.json index 9aaeb24c7db..84407bde155 100644 --- a/lexicons/app/bsky/feed/getFeed.json +++ b/lexicons/app/bsky/feed/getFeed.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Compose and hydrate a feed from a user's selected feed generator", + "description": "Get a hydrated feed from an actor's selected feed generator.", "parameters": { "type": "params", "required": ["feed"], diff --git a/lexicons/app/bsky/feed/getFeedGenerator.json b/lexicons/app/bsky/feed/getFeedGenerator.json index 5af09254f93..8b3d4d0551a 100644 --- a/lexicons/app/bsky/feed/getFeedGenerator.json +++ b/lexicons/app/bsky/feed/getFeedGenerator.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get information about a specific feed offered by a feed generator, such as its online status", + "description": "Get information about a feed generator.", "parameters": { "type": "params", "required": ["feed"], diff --git a/lexicons/app/bsky/feed/getFeedGenerators.json b/lexicons/app/bsky/feed/getFeedGenerators.json index d0cae3b39d2..b8e926db00d 100644 --- a/lexicons/app/bsky/feed/getFeedGenerators.json +++ b/lexicons/app/bsky/feed/getFeedGenerators.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get information about a list of feed generators", + "description": "Get information about a list of feed generators.", "parameters": { "type": "params", "required": ["feeds"], diff --git a/lexicons/app/bsky/feed/getFeedSkeleton.json b/lexicons/app/bsky/feed/getFeedSkeleton.json index d12b4bdc2b8..03f3ba04c0f 100644 --- a/lexicons/app/bsky/feed/getFeedSkeleton.json +++ b/lexicons/app/bsky/feed/getFeedSkeleton.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "A skeleton of a feed provided by a feed generator", + "description": "Get a skeleton of a feed provided by a feed generator.", "parameters": { "type": "params", "required": ["feed"], diff --git a/lexicons/app/bsky/feed/getLikes.json b/lexicons/app/bsky/feed/getLikes.json index e9b632684a8..ffcbc01ac53 100644 --- a/lexicons/app/bsky/feed/getLikes.json +++ b/lexicons/app/bsky/feed/getLikes.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "query", + "description": "Get the list of likes.", "parameters": { "type": "params", "required": ["uri"], diff --git a/lexicons/app/bsky/feed/getListFeed.json b/lexicons/app/bsky/feed/getListFeed.json index f7b778bda28..4c5358fcfd7 100644 --- a/lexicons/app/bsky/feed/getListFeed.json +++ b/lexicons/app/bsky/feed/getListFeed.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "A view of a recent posts from actors in a list", + "description": "Get a view of a recent posts from actors in a list.", "parameters": { "type": "params", "required": ["list"], diff --git a/lexicons/app/bsky/feed/getPostThread.json b/lexicons/app/bsky/feed/getPostThread.json index 2d5c2e29a11..b983617041f 100644 --- a/lexicons/app/bsky/feed/getPostThread.json +++ b/lexicons/app/bsky/feed/getPostThread.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "query", + "description": "Get posts in a thread.", "parameters": { "type": "params", "required": ["uri"], diff --git a/lexicons/app/bsky/feed/getPosts.json b/lexicons/app/bsky/feed/getPosts.json index 37056417a27..c985a5cf033 100644 --- a/lexicons/app/bsky/feed/getPosts.json +++ b/lexicons/app/bsky/feed/getPosts.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "A view of an actor's feed.", + "description": "Get a view of an actor's feed.", "parameters": { "type": "params", "required": ["uris"], diff --git a/lexicons/app/bsky/feed/getRepostedBy.json b/lexicons/app/bsky/feed/getRepostedBy.json index 247ca305e67..99abc6d5cde 100644 --- a/lexicons/app/bsky/feed/getRepostedBy.json +++ b/lexicons/app/bsky/feed/getRepostedBy.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "query", + "description": "Get a list of reposts.", "parameters": { "type": "params", "required": ["uri"], diff --git a/lexicons/app/bsky/feed/getTimeline.json b/lexicons/app/bsky/feed/getTimeline.json index 49e1ae84b37..c3b116381c6 100644 --- a/lexicons/app/bsky/feed/getTimeline.json +++ b/lexicons/app/bsky/feed/getTimeline.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "A view of the user's home timeline.", + "description": "Get a view of the actor's home timeline.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/feed/like.json b/lexicons/app/bsky/feed/like.json index 01d9a08a76c..d82f93bbb1b 100644 --- a/lexicons/app/bsky/feed/like.json +++ b/lexicons/app/bsky/feed/like.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "record", + "description": "A declaration of a like.", "key": "tid", "record": { "type": "object", diff --git a/lexicons/app/bsky/feed/post.json b/lexicons/app/bsky/feed/post.json index b21f01b6050..d5f92969253 100644 --- a/lexicons/app/bsky/feed/post.json +++ b/lexicons/app/bsky/feed/post.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "record", + "description": "A declaration of a post.", "key": "tid", "record": { "type": "object", diff --git a/lexicons/app/bsky/feed/repost.json b/lexicons/app/bsky/feed/repost.json index 3b809a53a7e..4dbef10b319 100644 --- a/lexicons/app/bsky/feed/repost.json +++ b/lexicons/app/bsky/feed/repost.json @@ -3,6 +3,7 @@ "id": "app.bsky.feed.repost", "defs": { "main": { + "description": "A declaration of a repost.", "type": "record", "key": "tid", "record": { diff --git a/lexicons/app/bsky/feed/searchPosts.json b/lexicons/app/bsky/feed/searchPosts.json index 34eb38f686e..a3e0bc47f03 100644 --- a/lexicons/app/bsky/feed/searchPosts.json +++ b/lexicons/app/bsky/feed/searchPosts.json @@ -4,14 +4,14 @@ "defs": { "main": { "type": "query", - "description": "Find posts matching search criteria", + "description": "Find posts matching search criteria.", "parameters": { "type": "params", "required": ["q"], "properties": { "q": { "type": "string", - "description": "search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended" + "description": "Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended." }, "limit": { "type": "integer", @@ -21,7 +21,7 @@ }, "cursor": { "type": "string", - "description": "optional pagination mechanism; may not necessarily allow scrolling through entire result set" + "description": "Optional pagination mechanism; may not necessarily allow scrolling through entire result set." } } }, @@ -34,7 +34,7 @@ "cursor": { "type": "string" }, "hitsTotal": { "type": "integer", - "description": "count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits" + "description": "Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits." }, "posts": { "type": "array", diff --git a/lexicons/app/bsky/graph/block.json b/lexicons/app/bsky/graph/block.json index 67821908d6a..6231eb04e10 100644 --- a/lexicons/app/bsky/graph/block.json +++ b/lexicons/app/bsky/graph/block.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "record", - "description": "A block.", + "description": "A declaration of a block.", "key": "tid", "record": { "type": "object", diff --git a/lexicons/app/bsky/graph/defs.json b/lexicons/app/bsky/graph/defs.json index 894cfadc0ef..c957f211670 100644 --- a/lexicons/app/bsky/graph/defs.json +++ b/lexicons/app/bsky/graph/defs.json @@ -54,11 +54,11 @@ }, "modlist": { "type": "token", - "description": "A list of actors to apply an aggregate moderation action (mute/block) on" + "description": "A list of actors to apply an aggregate moderation action (mute/block) on." }, "curatelist": { "type": "token", - "description": "A list of actors used for curation purposes such as list feeds or interaction gating" + "description": "A list of actors used for curation purposes such as list feeds or interaction gating." }, "listViewerState": { "type": "object", diff --git a/lexicons/app/bsky/graph/follow.json b/lexicons/app/bsky/graph/follow.json index 64783ae1d1b..df4f4319d92 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 social follow.", + "description": "A declaration of a social follow.", "key": "tid", "record": { "type": "object", diff --git a/lexicons/app/bsky/graph/getBlocks.json b/lexicons/app/bsky/graph/getBlocks.json index 1573e57faa3..bbfe956fbe0 100644 --- a/lexicons/app/bsky/graph/getBlocks.json +++ b/lexicons/app/bsky/graph/getBlocks.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Who is the requester's account blocking?", + "description": "Get a list of who the actor is blocking.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/graph/getFollowers.json b/lexicons/app/bsky/graph/getFollowers.json index f3824bbd699..378c7a7a339 100644 --- a/lexicons/app/bsky/graph/getFollowers.json +++ b/lexicons/app/bsky/graph/getFollowers.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Who is following an actor?", + "description": "Get a list of an actor's followers.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app/bsky/graph/getFollows.json b/lexicons/app/bsky/graph/getFollows.json index 04ce9fef8bf..b90f7613889 100644 --- a/lexicons/app/bsky/graph/getFollows.json +++ b/lexicons/app/bsky/graph/getFollows.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Who is an actor following?", + "description": "Get a list of who the actor follows.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app/bsky/graph/getList.json b/lexicons/app/bsky/graph/getList.json index 0241ee1e7f1..fd24668e5bd 100644 --- a/lexicons/app/bsky/graph/getList.json +++ b/lexicons/app/bsky/graph/getList.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Fetch a list of actors", + "description": "Get a list of actors.", "parameters": { "type": "params", "required": ["list"], diff --git a/lexicons/app/bsky/graph/getListBlocks.json b/lexicons/app/bsky/graph/getListBlocks.json index 709d77aa68b..9f9f59821f2 100644 --- a/lexicons/app/bsky/graph/getListBlocks.json +++ b/lexicons/app/bsky/graph/getListBlocks.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Which lists is the requester's account blocking?", + "description": "Get lists that the actor is blocking.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/graph/getListMutes.json b/lexicons/app/bsky/graph/getListMutes.json index 44b3b652fde..8d42ac40f9c 100644 --- a/lexicons/app/bsky/graph/getListMutes.json +++ b/lexicons/app/bsky/graph/getListMutes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Which lists is the requester's account muting?", + "description": "Get lists that the actor is muting.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/graph/getLists.json b/lexicons/app/bsky/graph/getLists.json index de83a50d3eb..602dd15307d 100644 --- a/lexicons/app/bsky/graph/getLists.json +++ b/lexicons/app/bsky/graph/getLists.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Fetch a list of lists that belong to an actor", + "description": "Get a list of lists that belong to an actor.", "parameters": { "type": "params", "required": ["actor"], diff --git a/lexicons/app/bsky/graph/getMutes.json b/lexicons/app/bsky/graph/getMutes.json index aba63ea3043..8ceae00f607 100644 --- a/lexicons/app/bsky/graph/getMutes.json +++ b/lexicons/app/bsky/graph/getMutes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Who does the viewer mute?", + "description": "Get a list of who the actor mutes.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/graph/listitem.json b/lexicons/app/bsky/graph/listitem.json index f05a1641e6f..2eafb1340be 100644 --- a/lexicons/app/bsky/graph/listitem.json +++ b/lexicons/app/bsky/graph/listitem.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "record", - "description": "An item under a declared list of actors", + "description": "An item under a declared list of actors.", "key": "tid", "record": { "type": "object", diff --git a/lexicons/app/bsky/graph/muteActor.json b/lexicons/app/bsky/graph/muteActor.json index 33dc75a7d29..f1c3dd18f64 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": "Mute an actor by DID or handle.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app/bsky/graph/unmuteActor.json b/lexicons/app/bsky/graph/unmuteActor.json index a71585a95c8..114af204890 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": "Unmute an actor by DID or handle.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app/bsky/notification/getUnreadCount.json b/lexicons/app/bsky/notification/getUnreadCount.json index 8b0cdc3af46..ab716b2a436 100644 --- a/lexicons/app/bsky/notification/getUnreadCount.json +++ b/lexicons/app/bsky/notification/getUnreadCount.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "query", + "description": "Get the count of unread notifications.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/notification/listNotifications.json b/lexicons/app/bsky/notification/listNotifications.json index c5a9aee0fd4..41f92cad4bc 100644 --- a/lexicons/app/bsky/notification/listNotifications.json +++ b/lexicons/app/bsky/notification/listNotifications.json @@ -4,6 +4,7 @@ "defs": { "main": { "type": "query", + "description": "Get a list of notifications.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/notification/registerPush.json b/lexicons/app/bsky/notification/registerPush.json index 159dd370049..80819ece46f 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 for push notifications with a service.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/app/bsky/unspecced/getPopular.json b/lexicons/app/bsky/unspecced/getPopular.json index 2aac00fed14..61fe26e889f 100644 --- a/lexicons/app/bsky/unspecced/getPopular.json +++ b/lexicons/app/bsky/unspecced/getPopular.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "DEPRECATED: will be removed soon, please find a feed generator alternative", + "description": "DEPRECATED: will be removed soon. Use a feed generator alternative.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/unspecced/getPopularFeedGenerators.json b/lexicons/app/bsky/unspecced/getPopularFeedGenerators.json index ddeb7e7fab2..ee05c16a1c1 100644 --- a/lexicons/app/bsky/unspecced/getPopularFeedGenerators.json +++ b/lexicons/app/bsky/unspecced/getPopularFeedGenerators.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "An unspecced view of globally popular feed generators", + "description": "An unspecced view of globally popular feed generators.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/unspecced/getTimelineSkeleton.json b/lexicons/app/bsky/unspecced/getTimelineSkeleton.json index c720b81832d..391c3718dc1 100644 --- a/lexicons/app/bsky/unspecced/getTimelineSkeleton.json +++ b/lexicons/app/bsky/unspecced/getTimelineSkeleton.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "A skeleton of a timeline - UNSPECCED & WILL GO AWAY SOON", + "description": "DEPRECATED: a skeleton of a timeline. Unspecced and will be unavailable soon.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/app/bsky/unspecced/searchActorsSkeleton.json b/lexicons/app/bsky/unspecced/searchActorsSkeleton.json index 108dacf9b14..ea73577d57d 100644 --- a/lexicons/app/bsky/unspecced/searchActorsSkeleton.json +++ b/lexicons/app/bsky/unspecced/searchActorsSkeleton.json @@ -4,18 +4,18 @@ "defs": { "main": { "type": "query", - "description": "Backend Actors (profile) search, returning only skeleton", + "description": "Backend Actors (profile) search, returns only skeleton.", "parameters": { "type": "params", "required": ["q"], "properties": { "q": { "type": "string", - "description": "search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax" + "description": "Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax." }, "typeahead": { "type": "boolean", - "description": "if true, acts as fast/simple 'typeahead' query" + "description": "If true, acts as fast/simple 'typeahead' query." }, "limit": { "type": "integer", @@ -25,7 +25,7 @@ }, "cursor": { "type": "string", - "description": "optional pagination mechanism; may not necessarily allow scrolling through entire result set" + "description": "Optional pagination mechanism; may not necessarily allow scrolling through entire result set." } } }, @@ -38,7 +38,7 @@ "cursor": { "type": "string" }, "hitsTotal": { "type": "integer", - "description": "count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits" + "description": "Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits." }, "actors": { "type": "array", diff --git a/lexicons/app/bsky/unspecced/searchPostsSkeleton.json b/lexicons/app/bsky/unspecced/searchPostsSkeleton.json index 532bfea79f9..3305dd98734 100644 --- a/lexicons/app/bsky/unspecced/searchPostsSkeleton.json +++ b/lexicons/app/bsky/unspecced/searchPostsSkeleton.json @@ -4,14 +4,14 @@ "defs": { "main": { "type": "query", - "description": "Backend Posts search, returning only skeleton", + "description": "Backend Posts search, returns only skeleton", "parameters": { "type": "params", "required": ["q"], "properties": { "q": { "type": "string", - "description": "search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended" + "description": "Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended." }, "limit": { "type": "integer", @@ -21,7 +21,7 @@ }, "cursor": { "type": "string", - "description": "optional pagination mechanism; may not necessarily allow scrolling through entire result set" + "description": "Optional pagination mechanism; may not necessarily allow scrolling through entire result set." } } }, @@ -34,7 +34,7 @@ "cursor": { "type": "string" }, "hitsTotal": { "type": "integer", - "description": "count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits" + "description": "Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits." }, "posts": { "type": "array", diff --git a/lexicons/com/atproto/admin/defs.json b/lexicons/com/atproto/admin/defs.json index 0d57da18ae8..42dc7165423 100644 --- a/lexicons/com/atproto/admin/defs.json +++ b/lexicons/com/atproto/admin/defs.json @@ -27,7 +27,7 @@ "action": { "type": "ref", "ref": "#actionType" }, "durationInHours": { "type": "integer", - "description": "Indicates how long this action was meant to be in effect before automatically expiring." + "description": "Indicates how long this action is meant to be in effect before automatically expiring." }, "subject": { "type": "union", @@ -60,7 +60,7 @@ "action": { "type": "ref", "ref": "#actionType" }, "durationInHours": { "type": "integer", - "description": "Indicates how long this action was meant to be in effect before automatically expiring." + "description": "Indicates how long this action is meant to be in effect before automatically expiring." }, "subject": { "type": "union", @@ -95,7 +95,7 @@ "action": { "type": "ref", "ref": "#actionType" }, "durationInHours": { "type": "integer", - "description": "Indicates how long this action was meant to be in effect before automatically expiring." + "description": "Indicates how long this action is meant to be in effect before automatically expiring." } } }, diff --git a/lexicons/com/atproto/admin/disableAccountInvites.json b/lexicons/com/atproto/admin/disableAccountInvites.json index 2006271d089..8bd6cabbc92 100644 --- a/lexicons/com/atproto/admin/disableAccountInvites.json +++ b/lexicons/com/atproto/admin/disableAccountInvites.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Disable an account from receiving new invite codes, but does not invalidate existing codes", + "description": "Disable an account from receiving new invite codes, but does not invalidate existing codes.", "input": { "encoding": "application/json", "schema": { @@ -14,7 +14,7 @@ "account": { "type": "string", "format": "did" }, "note": { "type": "string", - "description": "Additionally add a note describing why the invites were disabled" + "description": "Optional reason for disabled invites." } } } diff --git a/lexicons/com/atproto/admin/disableInviteCodes.json b/lexicons/com/atproto/admin/disableInviteCodes.json index f84bc05f203..914c8cb29e6 100644 --- a/lexicons/com/atproto/admin/disableInviteCodes.json +++ b/lexicons/com/atproto/admin/disableInviteCodes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Disable some set of codes and/or all codes associated with a set of users", + "description": "Disable some set of codes and/or all codes associated with a set of users.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/admin/enableAccountInvites.json b/lexicons/com/atproto/admin/enableAccountInvites.json index ac42d727879..97443cd9895 100644 --- a/lexicons/com/atproto/admin/enableAccountInvites.json +++ b/lexicons/com/atproto/admin/enableAccountInvites.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Re-enable an accounts ability to receive invite codes", + "description": "Re-enable an account's ability to receive invite codes.", "input": { "encoding": "application/json", "schema": { @@ -14,7 +14,7 @@ "account": { "type": "string", "format": "did" }, "note": { "type": "string", - "description": "Additionally add a note describing why the invites were enabled" + "description": "Optional reason for enabled invites." } } } diff --git a/lexicons/com/atproto/admin/getAccountInfo.json b/lexicons/com/atproto/admin/getAccountInfo.json index da8e839fdfa..e5d33fdcf10 100644 --- a/lexicons/com/atproto/admin/getAccountInfo.json +++ b/lexicons/com/atproto/admin/getAccountInfo.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "View details about an account.", + "description": "Get details about an account.", "parameters": { "type": "params", "required": ["did"], diff --git a/lexicons/com/atproto/admin/getInviteCodes.json b/lexicons/com/atproto/admin/getInviteCodes.json index 895f1259d7c..883604dc7e1 100644 --- a/lexicons/com/atproto/admin/getInviteCodes.json +++ b/lexicons/com/atproto/admin/getInviteCodes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Admin view of invite codes", + "description": "Get an admin view of invite codes.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/com/atproto/admin/getModerationAction.json b/lexicons/com/atproto/admin/getModerationAction.json index b25ccc227e1..eae0736bb3d 100644 --- a/lexicons/com/atproto/admin/getModerationAction.json +++ b/lexicons/com/atproto/admin/getModerationAction.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "View details about a moderation action.", + "description": "Get details about a moderation action.", "parameters": { "type": "params", "required": ["id"], diff --git a/lexicons/com/atproto/admin/getModerationActions.json b/lexicons/com/atproto/admin/getModerationActions.json index 89e16fd6919..370ba7d2f72 100644 --- a/lexicons/com/atproto/admin/getModerationActions.json +++ b/lexicons/com/atproto/admin/getModerationActions.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "List moderation actions related to a subject.", + "description": "Get a list of moderation actions related to a subject.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/com/atproto/admin/getModerationReport.json b/lexicons/com/atproto/admin/getModerationReport.json index 3e84e13e676..0e7efc16fde 100644 --- a/lexicons/com/atproto/admin/getModerationReport.json +++ b/lexicons/com/atproto/admin/getModerationReport.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "View details about a moderation report.", + "description": "Get details about a moderation report.", "parameters": { "type": "params", "required": ["id"], diff --git a/lexicons/com/atproto/admin/getModerationReports.json b/lexicons/com/atproto/admin/getModerationReports.json index ad930389147..0caeac1a8d6 100644 --- a/lexicons/com/atproto/admin/getModerationReports.json +++ b/lexicons/com/atproto/admin/getModerationReports.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "List moderation reports related to a subject.", + "description": "Get moderation reports related to a subject.", "parameters": { "type": "params", "properties": { @@ -13,12 +13,12 @@ "actionedBy": { "type": "string", "format": "did", - "description": "Get all reports that were actioned by a specific moderator" + "description": "Get all reports that were actioned by a specific moderator." }, "reporters": { "type": "array", "items": { "type": "string" }, - "description": "Filter reports made by one or more DIDs" + "description": "Filter reports made by one or more DIDs." }, "resolved": { "type": "boolean" }, "actionType": { @@ -39,7 +39,7 @@ "cursor": { "type": "string" }, "reverse": { "type": "boolean", - "description": "Reverse the order of the returned records? when true, returns reports in chronological order" + "description": "Reverse the order of the returned records. When true, returns reports in chronological order." } } }, diff --git a/lexicons/com/atproto/admin/getRecord.json b/lexicons/com/atproto/admin/getRecord.json index a16fe484feb..7c513bec72c 100644 --- a/lexicons/com/atproto/admin/getRecord.json +++ b/lexicons/com/atproto/admin/getRecord.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "View details about a record.", + "description": "Get details about a record.", "parameters": { "type": "params", "required": ["uri"], diff --git a/lexicons/com/atproto/admin/getRepo.json b/lexicons/com/atproto/admin/getRepo.json index d8cfd883f72..c7966158f11 100644 --- a/lexicons/com/atproto/admin/getRepo.json +++ b/lexicons/com/atproto/admin/getRepo.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "View details about a repository.", + "description": "Get details about a repository.", "parameters": { "type": "params", "required": ["did"], diff --git a/lexicons/com/atproto/admin/getSubjectStatus.json b/lexicons/com/atproto/admin/getSubjectStatus.json index a6ce340c009..0668aad611f 100644 --- a/lexicons/com/atproto/admin/getSubjectStatus.json +++ b/lexicons/com/atproto/admin/getSubjectStatus.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Fetch the service-specific the admin status of a subject (account, record, or blob)", + "description": "Get the service-specific admin status of a subject (account, record, or blob).", "parameters": { "type": "params", "properties": { diff --git a/lexicons/com/atproto/admin/sendEmail.json b/lexicons/com/atproto/admin/sendEmail.json index 8df082258dd..c6af697edd2 100644 --- a/lexicons/com/atproto/admin/sendEmail.json +++ b/lexicons/com/atproto/admin/sendEmail.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Send email to a user's primary email address", + "description": "Send email to a user's account email address.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/admin/takeModerationAction.json b/lexicons/com/atproto/admin/takeModerationAction.json index 76600735251..70b650aa4b1 100644 --- a/lexicons/com/atproto/admin/takeModerationAction.json +++ b/lexicons/com/atproto/admin/takeModerationAction.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Take a moderation action on a repo.", + "description": "Take a moderation action on an actor.", "input": { "encoding": "application/json", "schema": { @@ -41,7 +41,7 @@ "reason": { "type": "string" }, "durationInHours": { "type": "integer", - "description": "Indicates how long this action was meant to be in effect before automatically expiring." + "description": "Indicates how long this action is meant to be in effect before automatically expiring." }, "createdBy": { "type": "string", "format": "did" } } diff --git a/lexicons/com/atproto/admin/updateAccountEmail.json b/lexicons/com/atproto/admin/updateAccountEmail.json index a4cf711dee9..f0c3eeb7991 100644 --- a/lexicons/com/atproto/admin/updateAccountEmail.json +++ b/lexicons/com/atproto/admin/updateAccountEmail.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Administrative action to update an account's email", + "description": "Administrative action to update an account's email.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/admin/updateAccountHandle.json b/lexicons/com/atproto/admin/updateAccountHandle.json index 15442e98beb..23b8656627b 100644 --- a/lexicons/com/atproto/admin/updateAccountHandle.json +++ b/lexicons/com/atproto/admin/updateAccountHandle.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Administrative action to update an account's handle", + "description": "Administrative action to update an account's handle.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/admin/updateSubjectStatus.json b/lexicons/com/atproto/admin/updateSubjectStatus.json index 5273aea4da6..9483532e0a8 100644 --- a/lexicons/com/atproto/admin/updateSubjectStatus.json +++ b/lexicons/com/atproto/admin/updateSubjectStatus.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Update the service-specific admin status of a subject (account, record, or blob)", + "description": "Update the service-specific admin status of a subject (account, record, or blob).", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/identity/updateHandle.json b/lexicons/com/atproto/identity/updateHandle.json index 2b595d189f5..5fe392bb838 100644 --- a/lexicons/com/atproto/identity/updateHandle.json +++ b/lexicons/com/atproto/identity/updateHandle.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Updates the handle of the account", + "description": "Updates the handle of the account.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/label/defs.json b/lexicons/com/atproto/label/defs.json index 88a262b11c8..06e4e8f9cd2 100644 --- a/lexicons/com/atproto/label/defs.json +++ b/lexicons/com/atproto/label/defs.json @@ -4,37 +4,37 @@ "defs": { "label": { "type": "object", - "description": "Metadata tag on an atproto resource (eg, repo or record)", + "description": "Metadata tag on an atproto resource (eg, repo or record).", "required": ["src", "uri", "val", "cts"], "properties": { "src": { "type": "string", "format": "did", - "description": "DID of the actor who created this label" + "description": "DID of the actor who created this label." }, "uri": { "type": "string", "format": "uri", - "description": "AT URI of the record, repository (account), or other resource which this label applies to" + "description": "AT URI of the record, repository (account), or other resource that this label applies to." }, "cid": { "type": "string", "format": "cid", - "description": "optionally, CID specifying the specific version of 'uri' resource this label applies to" + "description": "Optionally, CID specifying the specific version of 'uri' resource this label applies to." }, "val": { "type": "string", "maxLength": 128, - "description": "the short string name of the value or type of this label" + "description": "The short string name of the value or type of this label." }, "neg": { "type": "boolean", - "description": "if true, this is a negation label, overwriting a previous label" + "description": "If true, this is a negation label, overwriting a previous label." }, "cts": { "type": "string", "format": "datetime", - "description": "timestamp when this label was created" + "description": "Timestamp when this label was created." } } }, @@ -52,13 +52,13 @@ }, "selfLabel": { "type": "object", - "description": "Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel.", + "description": "Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.", "required": ["val"], "properties": { "val": { "type": "string", "maxLength": 128, - "description": "the short string name of the value or type of this label" + "description": "The short string name of the value or type of this label." } } } diff --git a/lexicons/com/atproto/label/queryLabels.json b/lexicons/com/atproto/label/queryLabels.json index f4773f255e3..7b6fbe23d54 100644 --- a/lexicons/com/atproto/label/queryLabels.json +++ b/lexicons/com/atproto/label/queryLabels.json @@ -12,12 +12,12 @@ "uriPatterns": { "type": "array", "items": { "type": "string" }, - "description": "List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI" + "description": "List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI." }, "sources": { "type": "array", "items": { "type": "string", "format": "did" }, - "description": "Optional list of label sources (DIDs) to filter on" + "description": "Optional list of label sources (DIDs) to filter on." }, "limit": { "type": "integer", diff --git a/lexicons/com/atproto/label/subscribeLabels.json b/lexicons/com/atproto/label/subscribeLabels.json index 044036cfad4..9813ffc192e 100644 --- a/lexicons/com/atproto/label/subscribeLabels.json +++ b/lexicons/com/atproto/label/subscribeLabels.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "subscription", - "description": "Subscribe to label updates", + "description": "Subscribe to label updates.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/com/atproto/repo/applyWrites.json b/lexicons/com/atproto/repo/applyWrites.json index 5c37340cf3f..050b6efbfab 100644 --- a/lexicons/com/atproto/repo/applyWrites.json +++ b/lexicons/com/atproto/repo/applyWrites.json @@ -19,7 +19,7 @@ "validate": { "type": "boolean", "default": true, - "description": "Validate the records?" + "description": "Flag for validating the records." }, "writes": { "type": "array", diff --git a/lexicons/com/atproto/repo/createRecord.json b/lexicons/com/atproto/repo/createRecord.json index e594db58d51..baef20c88f0 100644 --- a/lexicons/com/atproto/repo/createRecord.json +++ b/lexicons/com/atproto/repo/createRecord.json @@ -29,7 +29,7 @@ "validate": { "type": "boolean", "default": true, - "description": "Validate the record?" + "description": "Flag for validating the record." }, "record": { "type": "unknown", @@ -38,7 +38,7 @@ "swapCommit": { "type": "string", "format": "cid", - "description": "Compare and swap with the previous commit by cid." + "description": "Compare and swap with the previous commit by CID." } } } diff --git a/lexicons/com/atproto/repo/deleteRecord.json b/lexicons/com/atproto/repo/deleteRecord.json index 53ef72b190e..d8d7955b6a9 100644 --- a/lexicons/com/atproto/repo/deleteRecord.json +++ b/lexicons/com/atproto/repo/deleteRecord.json @@ -28,12 +28,12 @@ "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." }, "swapCommit": { "type": "string", "format": "cid", - "description": "Compare and swap with the previous commit by cid." + "description": "Compare and swap with the previous commit by CID." } } } diff --git a/lexicons/com/atproto/repo/listRecords.json b/lexicons/com/atproto/repo/listRecords.json index 8bcee4fcb58..ac04e3e8782 100644 --- a/lexicons/com/atproto/repo/listRecords.json +++ b/lexicons/com/atproto/repo/listRecords.json @@ -37,7 +37,7 @@ }, "reverse": { "type": "boolean", - "description": "Reverse the order of the returned records?" + "description": "Flag to reverse the order of the returned records." } } }, diff --git a/lexicons/com/atproto/repo/putRecord.json b/lexicons/com/atproto/repo/putRecord.json index 118b41dc49c..ae39bd95ead 100644 --- a/lexicons/com/atproto/repo/putRecord.json +++ b/lexicons/com/atproto/repo/putRecord.json @@ -30,7 +30,7 @@ "validate": { "type": "boolean", "default": true, - "description": "Validate the record?" + "description": "Flag for validating the record." }, "record": { "type": "unknown", @@ -39,12 +39,12 @@ "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." }, "swapCommit": { "type": "string", "format": "cid", - "description": "Compare and swap with the previous commit by cid." + "description": "Compare and swap with the previous commit by CID." } } } diff --git a/lexicons/com/atproto/server/createAppPassword.json b/lexicons/com/atproto/server/createAppPassword.json index 4dfdcca1f6b..f12e8e2557e 100644 --- a/lexicons/com/atproto/server/createAppPassword.json +++ b/lexicons/com/atproto/server/createAppPassword.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Create an app-specific password.", + "description": "Create an App Password.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/server/createInviteCodes.json b/lexicons/com/atproto/server/createInviteCodes.json index 827d798a088..1965fe995f6 100644 --- a/lexicons/com/atproto/server/createInviteCodes.json +++ b/lexicons/com/atproto/server/createInviteCodes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Create an invite code.", + "description": "Create invite codes.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/server/deleteAccount.json b/lexicons/com/atproto/server/deleteAccount.json index 2cef799aefe..3747189dca3 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 a user account with a token and password.", + "description": "Delete an actor's account with a token and password.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/server/getAccountInviteCodes.json b/lexicons/com/atproto/server/getAccountInviteCodes.json index a99f78e0d7b..ac23b11f23f 100644 --- a/lexicons/com/atproto/server/getAccountInviteCodes.json +++ b/lexicons/com/atproto/server/getAccountInviteCodes.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Get all invite codes for a given account", + "description": "Get all invite codes for a given account.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/com/atproto/server/listAppPasswords.json b/lexicons/com/atproto/server/listAppPasswords.json index f50a13d6b82..13188897e00 100644 --- a/lexicons/com/atproto/server/listAppPasswords.json +++ b/lexicons/com/atproto/server/listAppPasswords.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "List all app-specific passwords.", + "description": "List all App Passwords.", "output": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/server/requestEmailConfirmation.json b/lexicons/com/atproto/server/requestEmailConfirmation.json index 4b2470bf59b..0020ed31607 100644 --- a/lexicons/com/atproto/server/requestEmailConfirmation.json +++ b/lexicons/com/atproto/server/requestEmailConfirmation.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Request an email with a code to confirm ownership of email" + "description": "Request an email with a code to confirm ownership of email." } } } diff --git a/lexicons/com/atproto/server/revokeAppPassword.json b/lexicons/com/atproto/server/revokeAppPassword.json index 52094c4459c..bcfd3d864e3 100644 --- a/lexicons/com/atproto/server/revokeAppPassword.json +++ b/lexicons/com/atproto/server/revokeAppPassword.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "procedure", - "description": "Revoke an app-specific password by name.", + "description": "Revoke an App Password by name.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/sync/getBlocks.json b/lexicons/com/atproto/sync/getBlocks.json index 0b6c25f8252..cf776a0c88f 100644 --- a/lexicons/com/atproto/sync/getBlocks.json +++ b/lexicons/com/atproto/sync/getBlocks.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Gets blocks from a given repo.", + "description": "Get blocks from a given repo.", "parameters": { "type": "params", "required": ["did", "cids"], diff --git a/lexicons/com/atproto/sync/getLatestCommit.json b/lexicons/com/atproto/sync/getLatestCommit.json index 602cc2dac59..d8754f09062 100644 --- a/lexicons/com/atproto/sync/getLatestCommit.json +++ b/lexicons/com/atproto/sync/getLatestCommit.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Gets the current commit CID & revision of the repo.", + "description": "Get the current commit CID & revision of the repo.", "parameters": { "type": "params", "required": ["did"], diff --git a/lexicons/com/atproto/sync/getRecord.json b/lexicons/com/atproto/sync/getRecord.json index ea14ba0f75e..cbd0ad3a5ac 100644 --- a/lexicons/com/atproto/sync/getRecord.json +++ b/lexicons/com/atproto/sync/getRecord.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "query", - "description": "Gets blocks needed for existence or non-existence of record.", + "description": "Get blocks needed for existence or non-existence of record.", "parameters": { "type": "params", "required": ["did", "collection", "rkey"], diff --git a/lexicons/com/atproto/sync/getRepo.json b/lexicons/com/atproto/sync/getRepo.json index 6bb6de2b1e4..fb68ab670ee 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": "Gets the DID's repo, optionally catching up from a specific revision.", "parameters": { "type": "params", "required": ["did"], diff --git a/lexicons/com/atproto/sync/listBlobs.json b/lexicons/com/atproto/sync/listBlobs.json index 9f25b1330a6..46815eeb49a 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 CIDs since some revision.", "parameters": { "type": "params", "required": ["did"], @@ -16,7 +16,7 @@ }, "since": { "type": "string", - "description": "Optional revision of the repo to list blobs since" + "description": "Optional revision of the repo to list blobs since." }, "limit": { "type": "integer", diff --git a/lexicons/com/atproto/sync/listRepos.json b/lexicons/com/atproto/sync/listRepos.json index ad4eabdabf1..440e8693d5e 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": "List DIDs and root CIDs of hosted repos.", "parameters": { "type": "params", "properties": { diff --git a/lexicons/com/atproto/sync/notifyOfUpdate.json b/lexicons/com/atproto/sync/notifyOfUpdate.json index caca6fe9f30..48cb4b24678 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; often when a long break between updates causes the connection with the crawling service to break.", "input": { "encoding": "application/json", "schema": { diff --git a/lexicons/com/atproto/sync/subscribeRepos.json b/lexicons/com/atproto/sync/subscribeRepos.json index b8feecad5b8..9a5c0f6153c 100644 --- a/lexicons/com/atproto/sync/subscribeRepos.json +++ b/lexicons/com/atproto/sync/subscribeRepos.json @@ -4,7 +4,7 @@ "defs": { "main": { "type": "subscription", - "description": "Subscribe to repo updates", + "description": "Subscribe to repo updates.", "parameters": { "type": "params", "properties": { @@ -47,15 +47,15 @@ "prev": { "type": "cid-link" }, "rev": { "type": "string", - "description": "The rev of the emitted commit" + "description": "The rev of the emitted commit." }, "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." }, "blocks": { "type": "bytes", - "description": "CAR file containing relevant blocks", + "description": "CAR file containing relevant blocks.", "maxLength": 1000000 }, "ops": { @@ -115,7 +115,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 write of a single record. For creates and updates, CID is the record's CID as of this operation. For deletes, it's null.", "required": ["action", "path", "cid"], "nullable": ["cid"], "properties": { diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts index 545d8e9d43d..14c1be9f477 100644 --- a/packages/api/src/client/lexicons.ts +++ b/packages/api/src/client/lexicons.ts @@ -43,7 +43,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, subject: { type: 'union', @@ -116,7 +116,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, subject: { type: 'union', @@ -184,7 +184,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, }, }, @@ -725,7 +725,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Disable an account from receiving new invite codes, but does not invalidate existing codes', + 'Disable an account from receiving new invite codes, but does not invalidate existing codes.', input: { encoding: 'application/json', schema: { @@ -738,8 +738,7 @@ export const schemaDict = { }, note: { type: 'string', - description: - 'Additionally add a note describing why the invites were disabled', + description: 'Optional reason for disabled invites.', }, }, }, @@ -754,7 +753,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Disable some set of codes and/or all codes associated with a set of users', + 'Disable some set of codes and/or all codes associated with a set of users.', input: { encoding: 'application/json', schema: { @@ -784,7 +783,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Re-enable an accounts ability to receive invite codes', + description: "Re-enable an account's ability to receive invite codes.", input: { encoding: 'application/json', schema: { @@ -797,8 +796,7 @@ export const schemaDict = { }, note: { type: 'string', - description: - 'Additionally add a note describing why the invites were enabled', + description: 'Optional reason for enabled invites.', }, }, }, @@ -812,7 +810,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about an account.', + description: 'Get details about an account.', parameters: { type: 'params', required: ['did'], @@ -839,7 +837,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Admin view of invite codes', + description: 'Get an admin view of invite codes.', parameters: { type: 'params', properties: { @@ -887,7 +885,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a moderation action.', + description: 'Get details about a moderation action.', parameters: { type: 'params', required: ['id'], @@ -913,7 +911,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List moderation actions related to a subject.', + description: 'Get a list of moderation actions related to a subject.', parameters: { type: 'params', properties: { @@ -959,7 +957,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a moderation report.', + description: 'Get details about a moderation report.', parameters: { type: 'params', required: ['id'], @@ -985,7 +983,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List moderation reports related to a subject.', + description: 'Get moderation reports related to a subject.', parameters: { type: 'params', properties: { @@ -1002,14 +1000,14 @@ export const schemaDict = { type: 'string', format: 'did', description: - 'Get all reports that were actioned by a specific moderator', + 'Get all reports that were actioned by a specific moderator.', }, reporters: { type: 'array', items: { type: 'string', }, - description: 'Filter reports made by one or more DIDs', + description: 'Filter reports made by one or more DIDs.', }, resolved: { type: 'boolean', @@ -1035,7 +1033,7 @@ export const schemaDict = { reverse: { type: 'boolean', description: - 'Reverse the order of the returned records? when true, returns reports in chronological order', + 'Reverse the order of the returned records. When true, returns reports in chronological order.', }, }, }, @@ -1067,7 +1065,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a record.', + description: 'Get details about a record.', parameters: { type: 'params', required: ['uri'], @@ -1103,7 +1101,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a repository.', + description: 'Get details about a repository.', parameters: { type: 'params', required: ['did'], @@ -1136,7 +1134,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Fetch the service-specific the admin status of a subject (account, record, or blob)', + 'Get the service-specific admin status of a subject (account, record, or blob).', parameters: { type: 'params', properties: { @@ -1309,7 +1307,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Send email to a user's primary email address", + description: "Send email to a user's account email address.", input: { encoding: 'application/json', schema: { @@ -1350,7 +1348,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Take a moderation action on a repo.', + description: 'Take a moderation action on an actor.', input: { encoding: 'application/json', schema: { @@ -1397,7 +1395,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, createdBy: { type: 'string', @@ -1427,7 +1425,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Administrative action to update an account's email", + description: "Administrative action to update an account's email.", input: { encoding: 'application/json', schema: { @@ -1454,7 +1452,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Administrative action to update an account's handle", + description: "Administrative action to update an account's handle.", input: { encoding: 'application/json', schema: { @@ -1482,7 +1480,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Update the service-specific admin status of a subject (account, record, or blob)', + 'Update the service-specific admin status of a subject (account, record, or blob).', input: { encoding: 'application/json', schema: { @@ -1568,7 +1566,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Updates the handle of the account', + description: 'Updates the handle of the account.', input: { encoding: 'application/json', schema: { @@ -1591,41 +1589,42 @@ export const schemaDict = { defs: { label: { type: 'object', - description: 'Metadata tag on an atproto resource (eg, repo or record)', + description: + 'Metadata tag on an atproto resource (eg, repo or record).', required: ['src', 'uri', 'val', 'cts'], properties: { src: { type: 'string', format: 'did', - description: 'DID of the actor who created this label', + description: 'DID of the actor who created this label.', }, uri: { type: 'string', format: 'uri', description: - 'AT URI of the record, repository (account), or other resource which this label applies to', + 'AT URI of the record, repository (account), or other resource that this label applies to.', }, cid: { type: 'string', format: 'cid', description: - "optionally, CID specifying the specific version of 'uri' resource this label applies to", + "Optionally, CID specifying the specific version of 'uri' resource this label applies to.", }, val: { type: 'string', maxLength: 128, description: - 'the short string name of the value or type of this label', + 'The short string name of the value or type of this label.', }, neg: { type: 'boolean', description: - 'if true, this is a negation label, overwriting a previous label', + 'If true, this is a negation label, overwriting a previous label.', }, cts: { type: 'string', format: 'datetime', - description: 'timestamp when this label was created', + description: 'Timestamp when this label was created.', }, }, }, @@ -1648,14 +1647,14 @@ export const schemaDict = { selfLabel: { type: 'object', description: - 'Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel.', + 'Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.', required: ['val'], properties: { val: { type: 'string', maxLength: 128, description: - 'the short string name of the value or type of this label', + 'The short string name of the value or type of this label.', }, }, }, @@ -1678,7 +1677,7 @@ export const schemaDict = { type: 'string', }, description: - "List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI", + "List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI.", }, sources: { type: 'array', @@ -1686,7 +1685,8 @@ export const schemaDict = { type: 'string', format: 'did', }, - description: 'Optional list of label sources (DIDs) to filter on', + description: + 'Optional list of label sources (DIDs) to filter on.', }, limit: { type: 'integer', @@ -1727,7 +1727,7 @@ export const schemaDict = { defs: { main: { type: 'subscription', - description: 'Subscribe to label updates', + description: 'Subscribe to label updates.', parameters: { type: 'params', properties: { @@ -1922,7 +1922,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the records?', + description: 'Flag for validating the records.', }, writes: { type: 'array', @@ -2031,7 +2031,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the record?', + description: 'Flag for validating the record.', }, record: { type: 'unknown', @@ -2041,7 +2041,7 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2102,13 +2102,13 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous record by cid.', + 'Compare and swap with the previous record by CID.', }, swapCommit: { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2278,7 +2278,7 @@ export const schemaDict = { }, reverse: { type: 'boolean', - description: 'Reverse the order of the returned records?', + description: 'Flag to reverse the order of the returned records.', }, }, }, @@ -2353,7 +2353,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the record?', + description: 'Flag for validating the record.', }, record: { type: 'unknown', @@ -2363,13 +2363,13 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous record by cid.', + 'Compare and swap with the previous record by CID.', }, swapCommit: { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2583,7 +2583,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Create an app-specific password.', + description: 'Create an App Password.', input: { encoding: 'application/json', schema: { @@ -2671,7 +2671,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Create an invite code.', + description: 'Create invite codes.', input: { encoding: 'application/json', schema: { @@ -2859,7 +2859,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Delete a user account with a token and password.', + description: "Delete an actor's account with a token and password.", input: { encoding: 'application/json', schema: { @@ -2950,7 +2950,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Get all invite codes for a given account', + description: 'Get all invite codes for a given account.', parameters: { type: 'params', properties: { @@ -3030,7 +3030,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List all app-specific passwords.', + description: 'List all App Passwords.', output: { encoding: 'application/json', schema: { @@ -3126,7 +3126,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Request an email with a code to confirm ownership of email', + 'Request an email with a code to confirm ownership of email.', }, }, }, @@ -3248,7 +3248,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Revoke an app-specific password by name.', + description: 'Revoke an App Password by name.', input: { encoding: 'application/json', schema: { @@ -3337,7 +3337,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Gets blocks from a given repo.', + description: 'Get blocks from a given repo.', parameters: { type: 'params', required: ['did', 'cids'], @@ -3432,7 +3432,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Gets the current commit CID & revision of the repo.', + description: 'Get the current commit CID & revision of the repo.', parameters: { type: 'params', required: ['did'], @@ -3475,7 +3475,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Gets blocks needed for existence or non-existence of record.', + 'Get blocks needed for existence or non-existence of record.', parameters: { type: 'params', required: ['did', 'collection', 'rkey'], @@ -3512,7 +3512,7 @@ export const schemaDict = { main: { type: 'query', description: - "Gets the did's repo, optionally catching up from a specific revision.", + "Gets the DID's repo, optionally catching up from a specific revision.", parameters: { type: 'params', required: ['did'], @@ -3540,7 +3540,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List blob cids since some revision', + description: 'List blob CIDs since some revision.', parameters: { type: 'params', required: ['did'], @@ -3552,7 +3552,7 @@ export const schemaDict = { }, since: { type: 'string', - description: 'Optional revision of the repo to list blobs since', + description: 'Optional revision of the repo to list blobs since.', }, limit: { type: 'integer', @@ -3593,7 +3593,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List dids and root cids of hosted repos', + description: 'List DIDs and root CIDs of hosted repos.', parameters: { type: 'params', properties: { @@ -3654,7 +3654,7 @@ export const schemaDict = { 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.', + 'Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break.', input: { encoding: 'application/json', schema: { @@ -3702,7 +3702,7 @@ export const schemaDict = { defs: { main: { type: 'subscription', - description: 'Subscribe to repo updates', + description: 'Subscribe to repo updates.', parameters: { type: 'params', properties: { @@ -3771,15 +3771,15 @@ export const schemaDict = { }, rev: { type: 'string', - description: 'The rev of the emitted commit', + description: 'The rev of the emitted commit.', }, 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.', }, blocks: { type: 'bytes', - description: 'CAR file containing relevant blocks', + description: 'CAR file containing relevant blocks.', maxLength: 1000000, }, ops: { @@ -3877,7 +3877,7 @@ export const schemaDict = { 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.", + "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.", required: ['action', 'path', 'cid'], nullable: ['cid'], properties: { @@ -4164,7 +4164,7 @@ export const schemaDict = { birthDate: { type: 'string', format: 'datetime', - description: 'The birth date of the owner of the account.', + description: 'The birth date of account owner.', }, }, }, @@ -4206,7 +4206,7 @@ export const schemaDict = { properties: { sort: { type: 'string', - description: 'Sorting mode.', + description: 'Sorting mode for threads.', knownValues: ['oldest', 'newest', 'most-likes', 'random'], }, prioritizeFollowedUsers: { @@ -4250,6 +4250,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get detailed profile view of an actor.', parameters: { type: 'params', required: ['actor'], @@ -4276,6 +4277,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get detailed profile views of multiple actors.', parameters: { type: 'params', required: ['actors'], @@ -4315,8 +4317,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: - 'Get a list of actors suggested for following. Used in discovery UIs.', + description: 'Get a list of suggested actors, used for discovery.', parameters: { type: 'params', properties: { @@ -4359,6 +4360,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a profile.', key: 'literal:self', record: { type: 'object', @@ -4398,7 +4400,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Sets the private preferences attached to the account.', + description: 'Set the private preferences attached to the account.', input: { encoding: 'application/json', schema: { @@ -4427,12 +4429,12 @@ export const schemaDict = { properties: { term: { type: 'string', - description: "DEPRECATED: use 'q' instead", + description: "DEPRECATED: use 'q' instead.", }, q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -4473,17 +4475,17 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Find actor suggestions for a search term.', + description: 'Find actor suggestions for a prefix search term.', parameters: { type: 'params', properties: { term: { type: 'string', - description: "DEPRECATED: use 'q' instead", + description: "DEPRECATED: use 'q' instead.", }, q: { type: 'string', - description: 'search query prefix; not a full query string', + description: 'Search query prefix; not a full query string.', }, limit: { type: 'integer', @@ -4516,7 +4518,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.external', description: - 'A representation of some externally linked content, embedded in another form of content', + 'A representation of some externally linked content, embedded in another form of content.', defs: { main: { type: 'object', @@ -4583,7 +4585,7 @@ export const schemaDict = { AppBskyEmbedImages: { 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 some other form of content.', defs: { main: { type: 'object', @@ -4672,7 +4674,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.record', description: - 'A representation of a record embedded in another form of content', + 'A representation of a record embedded in another form of content.', defs: { main: { type: 'object', @@ -4782,7 +4784,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.recordWithMedia', description: - 'A representation of a record embedded in another form of content, alongside other compatible embeds', + 'A representation of a record embedded in another form of content, alongside other compatible embeds.', defs: { main: { type: 'object', @@ -5150,7 +5152,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Returns information about a given feed generator including TOS & offered feed URIs', + 'Get information about a feed generator, including policies and offered feed URIs.', output: { encoding: 'application/json', schema: { @@ -5205,7 +5207,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A declaration of the existence of a feed generator', + description: 'A declaration of the existence of a feed generator.', key: 'any', record: { type: 'object', @@ -5256,7 +5258,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Retrieve a list of feeds created by a given actor', + description: 'Get a list of feeds created by the actor.', parameters: { type: 'params', required: ['actor'], @@ -5304,7 +5306,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A view of the posts liked by an actor.', + description: 'Get a list of posts liked by an actor.', parameters: { type: 'params', required: ['actor'], @@ -5360,7 +5362,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of an actor's feed.", + description: "Get a view of an actor's feed.", parameters: { type: 'params', required: ['actor'], @@ -5426,7 +5428,7 @@ export const schemaDict = { main: { type: 'query', description: - "Compose and hydrate a feed from a user's selected feed generator", + "Get a hydrated feed from an actor's selected feed generator.", parameters: { type: 'params', required: ['feed'], @@ -5479,8 +5481,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: - 'Get information about a specific feed offered by a feed generator, such as its online status', + description: 'Get information about a feed generator.', parameters: { type: 'params', required: ['feed'], @@ -5519,7 +5520,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Get information about a list of feed generators', + description: 'Get information about a list of feed generators.', parameters: { type: 'params', required: ['feeds'], @@ -5558,7 +5559,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A skeleton of a feed provided by a feed generator', + description: 'Get a skeleton of a feed provided by a feed generator.', parameters: { type: 'params', required: ['feed'], @@ -5611,6 +5612,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get the list of likes.', parameters: { type: 'params', required: ['uri'], @@ -5688,7 +5690,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A view of a recent posts from actors in a list', + description: 'Get a view of a recent posts from actors in a list.', parameters: { type: 'params', required: ['list'], @@ -5741,6 +5743,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get posts in a thread.', parameters: { type: 'params', required: ['uri'], @@ -5794,7 +5797,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of an actor's feed.", + description: "Get a view of an actor's feed.", parameters: { type: 'params', required: ['uris'], @@ -5834,6 +5837,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get a list of reposts.', parameters: { type: 'params', required: ['uri'], @@ -5936,7 +5940,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of the user's home timeline.", + description: "Get a view of the actor's home timeline.", parameters: { type: 'params', properties: { @@ -5982,6 +5986,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a like.', key: 'tid', record: { type: 'object', @@ -6006,6 +6011,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a post.', key: 'tid', record: { type: 'object', @@ -6128,6 +6134,7 @@ export const schemaDict = { id: 'app.bsky.feed.repost', defs: { main: { + description: 'A declaration of a repost.', type: 'record', key: 'tid', record: { @@ -6153,7 +6160,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Find posts matching search criteria', + description: 'Find posts matching search criteria.', parameters: { type: 'params', required: ['q'], @@ -6161,7 +6168,7 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -6172,7 +6179,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -6188,7 +6195,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, posts: { type: 'array', @@ -6273,7 +6280,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A block.', + description: 'A declaration of a block.', key: 'tid', record: { type: 'object', @@ -6400,12 +6407,12 @@ export const schemaDict = { modlist: { type: 'token', description: - 'A list of actors to apply an aggregate moderation action (mute/block) on', + 'A list of actors to apply an aggregate moderation action (mute/block) on.', }, curatelist: { type: 'token', description: - 'A list of actors used for curation purposes such as list feeds or interaction gating', + 'A list of actors used for curation purposes such as list feeds or interaction gating.', }, listViewerState: { type: 'object', @@ -6427,7 +6434,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A social follow.', + description: 'A declaration of a social follow.', key: 'tid', record: { type: 'object', @@ -6452,7 +6459,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Who is the requester's account blocking?", + description: 'Get a list of who the actor is blocking.', parameters: { type: 'params', properties: { @@ -6495,7 +6502,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who is following an actor?', + description: "Get a list of an actor's followers.", parameters: { type: 'params', required: ['actor'], @@ -6547,7 +6554,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who is an actor following?', + description: 'Get a list of who the actor follows.', parameters: { type: 'params', required: ['actor'], @@ -6599,7 +6606,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Fetch a list of actors', + description: 'Get a list of actors.', parameters: { type: 'params', required: ['list'], @@ -6651,7 +6658,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Which lists is the requester's account blocking?", + description: 'Get lists that the actor is blocking.', parameters: { type: 'params', properties: { @@ -6694,7 +6701,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Which lists is the requester's account muting?", + description: 'Get lists that the actor is muting.', parameters: { type: 'params', properties: { @@ -6737,7 +6744,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Fetch a list of lists that belong to an actor', + description: 'Get a list of lists that belong to an actor.', parameters: { type: 'params', required: ['actor'], @@ -6785,7 +6792,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who does the viewer mute?', + description: 'Get a list of who the actor mutes.', parameters: { type: 'params', properties: { @@ -6940,7 +6947,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'An item under a declared list of actors', + description: 'An item under a declared list of actors.', key: 'tid', record: { type: 'object', @@ -6969,7 +6976,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Mute an actor by did or handle.', + description: 'Mute an actor by DID or handle.', input: { encoding: 'application/json', schema: { @@ -7015,7 +7022,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Unmute an actor by did or handle.', + description: 'Unmute an actor by DID or handle.', input: { encoding: 'application/json', schema: { @@ -7061,6 +7068,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get the count of unread notifications.', parameters: { type: 'params', properties: { @@ -7091,6 +7099,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get a list of notifications.', parameters: { type: 'params', properties: { @@ -7197,7 +7206,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Register for push notifications with a service', + description: 'Register for push notifications with a service.', input: { encoding: 'application/json', schema: { @@ -7357,7 +7366,7 @@ export const schemaDict = { main: { type: 'query', description: - 'DEPRECATED: will be removed soon, please find a feed generator alternative', + 'DEPRECATED: will be removed soon. Use a feed generator alternative.', parameters: { type: 'params', properties: { @@ -7404,7 +7413,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'An unspecced view of globally popular feed generators', + description: 'An unspecced view of globally popular feed generators.', parameters: { type: 'params', properties: { @@ -7450,7 +7459,8 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A skeleton of a timeline - UNSPECCED & WILL GO AWAY SOON', + description: + 'DEPRECATED: a skeleton of a timeline. Unspecced and will be unavailable soon.', parameters: { type: 'params', properties: { @@ -7498,7 +7508,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Backend Actors (profile) search, returning only skeleton', + description: 'Backend Actors (profile) search, returns only skeleton.', parameters: { type: 'params', required: ['q'], @@ -7506,11 +7516,11 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.', }, typeahead: { type: 'boolean', - description: "if true, acts as fast/simple 'typeahead' query", + description: "If true, acts as fast/simple 'typeahead' query.", }, limit: { type: 'integer', @@ -7521,7 +7531,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -7537,7 +7547,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, actors: { type: 'array', @@ -7563,7 +7573,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Backend Posts search, returning only skeleton', + description: 'Backend Posts search, returns only skeleton', parameters: { type: 'params', required: ['q'], @@ -7571,7 +7581,7 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -7582,7 +7592,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -7598,7 +7608,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, posts: { type: 'array', diff --git a/packages/api/src/client/types/app/bsky/actor/defs.ts b/packages/api/src/client/types/app/bsky/actor/defs.ts index 5dd765a8373..0cb22ea5797 100644 --- a/packages/api/src/client/types/app/bsky/actor/defs.ts +++ b/packages/api/src/client/types/app/bsky/actor/defs.ts @@ -169,7 +169,7 @@ export function validateSavedFeedsPref(v: unknown): ValidationResult { } export interface PersonalDetailsPref { - /** The birth date of the owner of the account. */ + /** The birth date of account owner. */ birthDate?: string [k: string]: unknown } @@ -215,7 +215,7 @@ export function validateFeedViewPref(v: unknown): ValidationResult { } export interface ThreadViewPref { - /** Sorting mode. */ + /** Sorting mode for threads. */ sort?: 'oldest' | 'newest' | 'most-likes' | 'random' | (string & {}) /** Show followed users at the top of all replies. */ prioritizeFollowedUsers?: boolean diff --git a/packages/api/src/client/types/app/bsky/actor/searchActors.ts b/packages/api/src/client/types/app/bsky/actor/searchActors.ts index 5e6527606d8..63395418e11 100644 --- a/packages/api/src/client/types/app/bsky/actor/searchActors.ts +++ b/packages/api/src/client/types/app/bsky/actor/searchActors.ts @@ -9,9 +9,9 @@ import { CID } from 'multiformats/cid' import * as AppBskyActorDefs from './defs' export interface QueryParams { - /** DEPRECATED: use 'q' instead */ + /** DEPRECATED: use 'q' instead. */ term?: string - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q?: string limit?: number cursor?: string diff --git a/packages/api/src/client/types/app/bsky/actor/searchActorsTypeahead.ts b/packages/api/src/client/types/app/bsky/actor/searchActorsTypeahead.ts index 5818d6f64ad..a91e0ce7dcd 100644 --- a/packages/api/src/client/types/app/bsky/actor/searchActorsTypeahead.ts +++ b/packages/api/src/client/types/app/bsky/actor/searchActorsTypeahead.ts @@ -9,9 +9,9 @@ import { CID } from 'multiformats/cid' import * as AppBskyActorDefs from './defs' export interface QueryParams { - /** DEPRECATED: use 'q' instead */ + /** DEPRECATED: use 'q' instead. */ term?: string - /** search query prefix; not a full query string */ + /** Search query prefix; not a full query string. */ q?: string limit?: number } diff --git a/packages/api/src/client/types/app/bsky/feed/searchPosts.ts b/packages/api/src/client/types/app/bsky/feed/searchPosts.ts index 6b8613a2e1f..c94abf40221 100644 --- a/packages/api/src/client/types/app/bsky/feed/searchPosts.ts +++ b/packages/api/src/client/types/app/bsky/feed/searchPosts.ts @@ -9,10 +9,10 @@ import { CID } from 'multiformats/cid' import * as AppBskyFeedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q: string limit?: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -20,7 +20,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number posts: AppBskyFeedDefs.PostView[] [k: string]: unknown diff --git a/packages/api/src/client/types/app/bsky/graph/defs.ts b/packages/api/src/client/types/app/bsky/graph/defs.ts index fb40758534f..19c2cc81337 100644 --- a/packages/api/src/client/types/app/bsky/graph/defs.ts +++ b/packages/api/src/client/types/app/bsky/graph/defs.ts @@ -79,9 +79,9 @@ export type ListPurpose = | 'app.bsky.graph.defs#curatelist' | (string & {}) -/** A list of actors to apply an aggregate moderation action (mute/block) on */ +/** A list of actors to apply an aggregate moderation action (mute/block) on. */ export const MODLIST = 'app.bsky.graph.defs#modlist' -/** A list of actors used for curation purposes such as list feeds or interaction gating */ +/** A list of actors used for curation purposes such as list feeds or interaction gating. */ export const CURATELIST = 'app.bsky.graph.defs#curatelist' export interface ListViewerState { diff --git a/packages/api/src/client/types/app/bsky/unspecced/searchActorsSkeleton.ts b/packages/api/src/client/types/app/bsky/unspecced/searchActorsSkeleton.ts index 7cc2729620e..aa882a0e74d 100644 --- a/packages/api/src/client/types/app/bsky/unspecced/searchActorsSkeleton.ts +++ b/packages/api/src/client/types/app/bsky/unspecced/searchActorsSkeleton.ts @@ -9,12 +9,12 @@ import { CID } from 'multiformats/cid' import * as AppBskyUnspeccedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax. */ q: string - /** if true, acts as fast/simple 'typeahead' query */ + /** If true, acts as fast/simple 'typeahead' query. */ typeahead?: boolean limit?: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -22,7 +22,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number actors: AppBskyUnspeccedDefs.SkeletonSearchActor[] [k: string]: unknown diff --git a/packages/api/src/client/types/app/bsky/unspecced/searchPostsSkeleton.ts b/packages/api/src/client/types/app/bsky/unspecced/searchPostsSkeleton.ts index 07391886f8f..9d118d08518 100644 --- a/packages/api/src/client/types/app/bsky/unspecced/searchPostsSkeleton.ts +++ b/packages/api/src/client/types/app/bsky/unspecced/searchPostsSkeleton.ts @@ -9,10 +9,10 @@ import { CID } from 'multiformats/cid' import * as AppBskyUnspeccedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q: string limit?: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -20,7 +20,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number posts: AppBskyUnspeccedDefs.SkeletonSearchPost[] [k: string]: unknown diff --git a/packages/api/src/client/types/com/atproto/admin/defs.ts b/packages/api/src/client/types/com/atproto/admin/defs.ts index 5ab3e3482ec..8b8197a06d0 100644 --- a/packages/api/src/client/types/com/atproto/admin/defs.ts +++ b/packages/api/src/client/types/com/atproto/admin/defs.ts @@ -31,7 +31,7 @@ export function validateStatusAttr(v: unknown): ValidationResult { export interface ActionView { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number subject: | RepoRef @@ -63,7 +63,7 @@ export function validateActionView(v: unknown): ValidationResult { export interface ActionViewDetail { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number subject: | RepoView @@ -97,7 +97,7 @@ export function validateActionViewDetail(v: unknown): ValidationResult { export interface ActionViewCurrent { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number [k: string]: unknown } diff --git a/packages/api/src/client/types/com/atproto/admin/disableAccountInvites.ts b/packages/api/src/client/types/com/atproto/admin/disableAccountInvites.ts index cf61d3026d4..7d4a59e503f 100644 --- a/packages/api/src/client/types/com/atproto/admin/disableAccountInvites.ts +++ b/packages/api/src/client/types/com/atproto/admin/disableAccountInvites.ts @@ -11,7 +11,7 @@ export interface QueryParams {} export interface InputSchema { account: string - /** Additionally add a note describing why the invites were disabled */ + /** Optional reason for disabled invites. */ note?: string [k: string]: unknown } diff --git a/packages/api/src/client/types/com/atproto/admin/enableAccountInvites.ts b/packages/api/src/client/types/com/atproto/admin/enableAccountInvites.ts index e20c3f14d49..c39d1990b26 100644 --- a/packages/api/src/client/types/com/atproto/admin/enableAccountInvites.ts +++ b/packages/api/src/client/types/com/atproto/admin/enableAccountInvites.ts @@ -11,7 +11,7 @@ export interface QueryParams {} export interface InputSchema { account: string - /** Additionally add a note describing why the invites were enabled */ + /** Optional reason for enabled invites. */ note?: string [k: string]: unknown } diff --git a/packages/api/src/client/types/com/atproto/admin/getModerationReports.ts b/packages/api/src/client/types/com/atproto/admin/getModerationReports.ts index cc6c6f00f3c..3a3e52f59b3 100644 --- a/packages/api/src/client/types/com/atproto/admin/getModerationReports.ts +++ b/packages/api/src/client/types/com/atproto/admin/getModerationReports.ts @@ -11,9 +11,9 @@ import * as ComAtprotoAdminDefs from './defs' export interface QueryParams { subject?: string ignoreSubjects?: string[] - /** Get all reports that were actioned by a specific moderator */ + /** Get all reports that were actioned by a specific moderator. */ actionedBy?: string - /** Filter reports made by one or more DIDs */ + /** Filter reports made by one or more DIDs. */ reporters?: string[] resolved?: boolean actionType?: @@ -24,7 +24,7 @@ export interface QueryParams { | (string & {}) limit?: number cursor?: string - /** Reverse the order of the returned records? when true, returns reports in chronological order */ + /** Reverse the order of the returned records. When true, returns reports in chronological order. */ reverse?: boolean } diff --git a/packages/api/src/client/types/com/atproto/admin/takeModerationAction.ts b/packages/api/src/client/types/com/atproto/admin/takeModerationAction.ts index 6e253d6b0ef..49fba249af7 100644 --- a/packages/api/src/client/types/com/atproto/admin/takeModerationAction.ts +++ b/packages/api/src/client/types/com/atproto/admin/takeModerationAction.ts @@ -25,7 +25,7 @@ export interface InputSchema { createLabelVals?: string[] negateLabelVals?: string[] reason: string - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number createdBy: string [k: string]: unknown diff --git a/packages/api/src/client/types/com/atproto/label/defs.ts b/packages/api/src/client/types/com/atproto/label/defs.ts index 13f90cd80c5..54402204c61 100644 --- a/packages/api/src/client/types/com/atproto/label/defs.ts +++ b/packages/api/src/client/types/com/atproto/label/defs.ts @@ -6,19 +6,19 @@ import { isObj, hasProp } from '../../../../util' import { lexicons } from '../../../../lexicons' import { CID } from 'multiformats/cid' -/** Metadata tag on an atproto resource (eg, repo or record) */ +/** Metadata tag on an atproto resource (eg, repo or record). */ export interface Label { - /** DID of the actor who created this label */ + /** DID of the actor who created this label. */ src: string - /** AT URI of the record, repository (account), or other resource which this label applies to */ + /** AT URI of the record, repository (account), or other resource that this label applies to. */ uri: string - /** optionally, CID specifying the specific version of 'uri' resource this label applies to */ + /** Optionally, CID specifying the specific version of 'uri' resource this label applies to. */ cid?: string - /** the short string name of the value or type of this label */ + /** The short string name of the value or type of this label. */ val: string - /** if true, this is a negation label, overwriting a previous label */ + /** If true, this is a negation label, overwriting a previous label. */ neg?: boolean - /** timestamp when this label was created */ + /** Timestamp when this label was created. */ cts: string [k: string]: unknown } @@ -53,9 +53,9 @@ export function validateSelfLabels(v: unknown): ValidationResult { return lexicons.validate('com.atproto.label.defs#selfLabels', v) } -/** Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel. */ +/** Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel. */ export interface SelfLabel { - /** the short string name of the value or type of this label */ + /** The short string name of the value or type of this label. */ val: string [k: string]: unknown } diff --git a/packages/api/src/client/types/com/atproto/label/queryLabels.ts b/packages/api/src/client/types/com/atproto/label/queryLabels.ts index 9b0a283943d..3fd08d1b2b4 100644 --- a/packages/api/src/client/types/com/atproto/label/queryLabels.ts +++ b/packages/api/src/client/types/com/atproto/label/queryLabels.ts @@ -9,9 +9,9 @@ import { CID } from 'multiformats/cid' import * as ComAtprotoLabelDefs from './defs' export interface QueryParams { - /** List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI */ + /** List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI. */ uriPatterns: string[] - /** Optional list of label sources (DIDs) to filter on */ + /** Optional list of label sources (DIDs) to filter on. */ sources?: string[] limit?: number cursor?: string diff --git a/packages/api/src/client/types/com/atproto/repo/applyWrites.ts b/packages/api/src/client/types/com/atproto/repo/applyWrites.ts index b25c3716e1b..f4a8a269201 100644 --- a/packages/api/src/client/types/com/atproto/repo/applyWrites.ts +++ b/packages/api/src/client/types/com/atproto/repo/applyWrites.ts @@ -12,7 +12,7 @@ export interface QueryParams {} export interface InputSchema { /** The handle or DID of the repo. */ repo: string - /** Validate the records? */ + /** Flag for validating the records. */ validate?: boolean writes: (Create | Update | Delete)[] swapCommit?: string diff --git a/packages/api/src/client/types/com/atproto/repo/createRecord.ts b/packages/api/src/client/types/com/atproto/repo/createRecord.ts index 27662fc4929..2056778c71c 100644 --- a/packages/api/src/client/types/com/atproto/repo/createRecord.ts +++ b/packages/api/src/client/types/com/atproto/repo/createRecord.ts @@ -16,11 +16,11 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey?: string - /** Validate the record? */ + /** Flag for validating the record. */ validate?: boolean /** The record to create. */ record: {} - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/api/src/client/types/com/atproto/repo/deleteRecord.ts b/packages/api/src/client/types/com/atproto/repo/deleteRecord.ts index 4bbe1fd2341..5bf9237abbb 100644 --- a/packages/api/src/client/types/com/atproto/repo/deleteRecord.ts +++ b/packages/api/src/client/types/com/atproto/repo/deleteRecord.ts @@ -16,9 +16,9 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey: string - /** Compare and swap with the previous record by cid. */ + /** Compare and swap with the previous record by CID. */ swapRecord?: string - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/api/src/client/types/com/atproto/repo/listRecords.ts b/packages/api/src/client/types/com/atproto/repo/listRecords.ts index 57bcf55df2a..6322c782008 100644 --- a/packages/api/src/client/types/com/atproto/repo/listRecords.ts +++ b/packages/api/src/client/types/com/atproto/repo/listRecords.ts @@ -19,7 +19,7 @@ export interface QueryParams { rkeyStart?: string /** DEPRECATED: The highest sort-ordered rkey to stop at (exclusive) */ rkeyEnd?: string - /** Reverse the order of the returned records? */ + /** Flag to reverse the order of the returned records. */ reverse?: boolean } diff --git a/packages/api/src/client/types/com/atproto/repo/putRecord.ts b/packages/api/src/client/types/com/atproto/repo/putRecord.ts index 7fbf2630b81..269ef759401 100644 --- a/packages/api/src/client/types/com/atproto/repo/putRecord.ts +++ b/packages/api/src/client/types/com/atproto/repo/putRecord.ts @@ -16,13 +16,13 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey: string - /** Validate the record? */ + /** Flag for validating the record. */ validate?: boolean /** The record to write. */ record: {} - /** Compare and swap with the previous record by cid. */ + /** Compare and swap with the previous record by CID. */ swapRecord?: string | null - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/api/src/client/types/com/atproto/sync/listBlobs.ts b/packages/api/src/client/types/com/atproto/sync/listBlobs.ts index 72ddd99cb2d..d775ce35a6a 100644 --- a/packages/api/src/client/types/com/atproto/sync/listBlobs.ts +++ b/packages/api/src/client/types/com/atproto/sync/listBlobs.ts @@ -10,7 +10,7 @@ import { CID } from 'multiformats/cid' export interface QueryParams { /** The DID of the repo. */ did: string - /** Optional revision of the repo to list blobs since */ + /** Optional revision of the repo to list blobs since. */ since?: string limit?: number cursor?: string diff --git a/packages/api/src/client/types/com/atproto/sync/subscribeRepos.ts b/packages/api/src/client/types/com/atproto/sync/subscribeRepos.ts index f54c8d45631..a4fec035874 100644 --- a/packages/api/src/client/types/com/atproto/sync/subscribeRepos.ts +++ b/packages/api/src/client/types/com/atproto/sync/subscribeRepos.ts @@ -14,11 +14,11 @@ export interface Commit { repo: string commit: CID prev?: CID | null - /** The rev of the emitted commit */ + /** The rev of the emitted commit. */ rev: string - /** The rev of the last emitted commit from this repo */ + /** The rev of the last emitted commit from this repo. */ since: string | null - /** CAR file containing relevant blocks */ + /** CAR file containing relevant blocks. */ blocks: Uint8Array ops: RepoOp[] blobs: CID[] @@ -115,7 +115,7 @@ export function validateInfo(v: unknown): ValidationResult { return lexicons.validate('com.atproto.sync.subscribeRepos#info', v) } -/** 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. */ +/** 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. */ export interface RepoOp { action: 'create' | 'update' | 'delete' | (string & {}) path: string diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts index 545d8e9d43d..14c1be9f477 100644 --- a/packages/bsky/src/lexicon/lexicons.ts +++ b/packages/bsky/src/lexicon/lexicons.ts @@ -43,7 +43,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, subject: { type: 'union', @@ -116,7 +116,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, subject: { type: 'union', @@ -184,7 +184,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, }, }, @@ -725,7 +725,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Disable an account from receiving new invite codes, but does not invalidate existing codes', + 'Disable an account from receiving new invite codes, but does not invalidate existing codes.', input: { encoding: 'application/json', schema: { @@ -738,8 +738,7 @@ export const schemaDict = { }, note: { type: 'string', - description: - 'Additionally add a note describing why the invites were disabled', + description: 'Optional reason for disabled invites.', }, }, }, @@ -754,7 +753,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Disable some set of codes and/or all codes associated with a set of users', + 'Disable some set of codes and/or all codes associated with a set of users.', input: { encoding: 'application/json', schema: { @@ -784,7 +783,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Re-enable an accounts ability to receive invite codes', + description: "Re-enable an account's ability to receive invite codes.", input: { encoding: 'application/json', schema: { @@ -797,8 +796,7 @@ export const schemaDict = { }, note: { type: 'string', - description: - 'Additionally add a note describing why the invites were enabled', + description: 'Optional reason for enabled invites.', }, }, }, @@ -812,7 +810,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about an account.', + description: 'Get details about an account.', parameters: { type: 'params', required: ['did'], @@ -839,7 +837,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Admin view of invite codes', + description: 'Get an admin view of invite codes.', parameters: { type: 'params', properties: { @@ -887,7 +885,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a moderation action.', + description: 'Get details about a moderation action.', parameters: { type: 'params', required: ['id'], @@ -913,7 +911,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List moderation actions related to a subject.', + description: 'Get a list of moderation actions related to a subject.', parameters: { type: 'params', properties: { @@ -959,7 +957,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a moderation report.', + description: 'Get details about a moderation report.', parameters: { type: 'params', required: ['id'], @@ -985,7 +983,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List moderation reports related to a subject.', + description: 'Get moderation reports related to a subject.', parameters: { type: 'params', properties: { @@ -1002,14 +1000,14 @@ export const schemaDict = { type: 'string', format: 'did', description: - 'Get all reports that were actioned by a specific moderator', + 'Get all reports that were actioned by a specific moderator.', }, reporters: { type: 'array', items: { type: 'string', }, - description: 'Filter reports made by one or more DIDs', + description: 'Filter reports made by one or more DIDs.', }, resolved: { type: 'boolean', @@ -1035,7 +1033,7 @@ export const schemaDict = { reverse: { type: 'boolean', description: - 'Reverse the order of the returned records? when true, returns reports in chronological order', + 'Reverse the order of the returned records. When true, returns reports in chronological order.', }, }, }, @@ -1067,7 +1065,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a record.', + description: 'Get details about a record.', parameters: { type: 'params', required: ['uri'], @@ -1103,7 +1101,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a repository.', + description: 'Get details about a repository.', parameters: { type: 'params', required: ['did'], @@ -1136,7 +1134,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Fetch the service-specific the admin status of a subject (account, record, or blob)', + 'Get the service-specific admin status of a subject (account, record, or blob).', parameters: { type: 'params', properties: { @@ -1309,7 +1307,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Send email to a user's primary email address", + description: "Send email to a user's account email address.", input: { encoding: 'application/json', schema: { @@ -1350,7 +1348,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Take a moderation action on a repo.', + description: 'Take a moderation action on an actor.', input: { encoding: 'application/json', schema: { @@ -1397,7 +1395,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, createdBy: { type: 'string', @@ -1427,7 +1425,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Administrative action to update an account's email", + description: "Administrative action to update an account's email.", input: { encoding: 'application/json', schema: { @@ -1454,7 +1452,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Administrative action to update an account's handle", + description: "Administrative action to update an account's handle.", input: { encoding: 'application/json', schema: { @@ -1482,7 +1480,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Update the service-specific admin status of a subject (account, record, or blob)', + 'Update the service-specific admin status of a subject (account, record, or blob).', input: { encoding: 'application/json', schema: { @@ -1568,7 +1566,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Updates the handle of the account', + description: 'Updates the handle of the account.', input: { encoding: 'application/json', schema: { @@ -1591,41 +1589,42 @@ export const schemaDict = { defs: { label: { type: 'object', - description: 'Metadata tag on an atproto resource (eg, repo or record)', + description: + 'Metadata tag on an atproto resource (eg, repo or record).', required: ['src', 'uri', 'val', 'cts'], properties: { src: { type: 'string', format: 'did', - description: 'DID of the actor who created this label', + description: 'DID of the actor who created this label.', }, uri: { type: 'string', format: 'uri', description: - 'AT URI of the record, repository (account), or other resource which this label applies to', + 'AT URI of the record, repository (account), or other resource that this label applies to.', }, cid: { type: 'string', format: 'cid', description: - "optionally, CID specifying the specific version of 'uri' resource this label applies to", + "Optionally, CID specifying the specific version of 'uri' resource this label applies to.", }, val: { type: 'string', maxLength: 128, description: - 'the short string name of the value or type of this label', + 'The short string name of the value or type of this label.', }, neg: { type: 'boolean', description: - 'if true, this is a negation label, overwriting a previous label', + 'If true, this is a negation label, overwriting a previous label.', }, cts: { type: 'string', format: 'datetime', - description: 'timestamp when this label was created', + description: 'Timestamp when this label was created.', }, }, }, @@ -1648,14 +1647,14 @@ export const schemaDict = { selfLabel: { type: 'object', description: - 'Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel.', + 'Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.', required: ['val'], properties: { val: { type: 'string', maxLength: 128, description: - 'the short string name of the value or type of this label', + 'The short string name of the value or type of this label.', }, }, }, @@ -1678,7 +1677,7 @@ export const schemaDict = { type: 'string', }, description: - "List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI", + "List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI.", }, sources: { type: 'array', @@ -1686,7 +1685,8 @@ export const schemaDict = { type: 'string', format: 'did', }, - description: 'Optional list of label sources (DIDs) to filter on', + description: + 'Optional list of label sources (DIDs) to filter on.', }, limit: { type: 'integer', @@ -1727,7 +1727,7 @@ export const schemaDict = { defs: { main: { type: 'subscription', - description: 'Subscribe to label updates', + description: 'Subscribe to label updates.', parameters: { type: 'params', properties: { @@ -1922,7 +1922,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the records?', + description: 'Flag for validating the records.', }, writes: { type: 'array', @@ -2031,7 +2031,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the record?', + description: 'Flag for validating the record.', }, record: { type: 'unknown', @@ -2041,7 +2041,7 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2102,13 +2102,13 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous record by cid.', + 'Compare and swap with the previous record by CID.', }, swapCommit: { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2278,7 +2278,7 @@ export const schemaDict = { }, reverse: { type: 'boolean', - description: 'Reverse the order of the returned records?', + description: 'Flag to reverse the order of the returned records.', }, }, }, @@ -2353,7 +2353,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the record?', + description: 'Flag for validating the record.', }, record: { type: 'unknown', @@ -2363,13 +2363,13 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous record by cid.', + 'Compare and swap with the previous record by CID.', }, swapCommit: { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2583,7 +2583,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Create an app-specific password.', + description: 'Create an App Password.', input: { encoding: 'application/json', schema: { @@ -2671,7 +2671,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Create an invite code.', + description: 'Create invite codes.', input: { encoding: 'application/json', schema: { @@ -2859,7 +2859,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Delete a user account with a token and password.', + description: "Delete an actor's account with a token and password.", input: { encoding: 'application/json', schema: { @@ -2950,7 +2950,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Get all invite codes for a given account', + description: 'Get all invite codes for a given account.', parameters: { type: 'params', properties: { @@ -3030,7 +3030,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List all app-specific passwords.', + description: 'List all App Passwords.', output: { encoding: 'application/json', schema: { @@ -3126,7 +3126,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Request an email with a code to confirm ownership of email', + 'Request an email with a code to confirm ownership of email.', }, }, }, @@ -3248,7 +3248,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Revoke an app-specific password by name.', + description: 'Revoke an App Password by name.', input: { encoding: 'application/json', schema: { @@ -3337,7 +3337,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Gets blocks from a given repo.', + description: 'Get blocks from a given repo.', parameters: { type: 'params', required: ['did', 'cids'], @@ -3432,7 +3432,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Gets the current commit CID & revision of the repo.', + description: 'Get the current commit CID & revision of the repo.', parameters: { type: 'params', required: ['did'], @@ -3475,7 +3475,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Gets blocks needed for existence or non-existence of record.', + 'Get blocks needed for existence or non-existence of record.', parameters: { type: 'params', required: ['did', 'collection', 'rkey'], @@ -3512,7 +3512,7 @@ export const schemaDict = { main: { type: 'query', description: - "Gets the did's repo, optionally catching up from a specific revision.", + "Gets the DID's repo, optionally catching up from a specific revision.", parameters: { type: 'params', required: ['did'], @@ -3540,7 +3540,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List blob cids since some revision', + description: 'List blob CIDs since some revision.', parameters: { type: 'params', required: ['did'], @@ -3552,7 +3552,7 @@ export const schemaDict = { }, since: { type: 'string', - description: 'Optional revision of the repo to list blobs since', + description: 'Optional revision of the repo to list blobs since.', }, limit: { type: 'integer', @@ -3593,7 +3593,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List dids and root cids of hosted repos', + description: 'List DIDs and root CIDs of hosted repos.', parameters: { type: 'params', properties: { @@ -3654,7 +3654,7 @@ export const schemaDict = { 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.', + 'Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break.', input: { encoding: 'application/json', schema: { @@ -3702,7 +3702,7 @@ export const schemaDict = { defs: { main: { type: 'subscription', - description: 'Subscribe to repo updates', + description: 'Subscribe to repo updates.', parameters: { type: 'params', properties: { @@ -3771,15 +3771,15 @@ export const schemaDict = { }, rev: { type: 'string', - description: 'The rev of the emitted commit', + description: 'The rev of the emitted commit.', }, 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.', }, blocks: { type: 'bytes', - description: 'CAR file containing relevant blocks', + description: 'CAR file containing relevant blocks.', maxLength: 1000000, }, ops: { @@ -3877,7 +3877,7 @@ export const schemaDict = { 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.", + "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.", required: ['action', 'path', 'cid'], nullable: ['cid'], properties: { @@ -4164,7 +4164,7 @@ export const schemaDict = { birthDate: { type: 'string', format: 'datetime', - description: 'The birth date of the owner of the account.', + description: 'The birth date of account owner.', }, }, }, @@ -4206,7 +4206,7 @@ export const schemaDict = { properties: { sort: { type: 'string', - description: 'Sorting mode.', + description: 'Sorting mode for threads.', knownValues: ['oldest', 'newest', 'most-likes', 'random'], }, prioritizeFollowedUsers: { @@ -4250,6 +4250,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get detailed profile view of an actor.', parameters: { type: 'params', required: ['actor'], @@ -4276,6 +4277,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get detailed profile views of multiple actors.', parameters: { type: 'params', required: ['actors'], @@ -4315,8 +4317,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: - 'Get a list of actors suggested for following. Used in discovery UIs.', + description: 'Get a list of suggested actors, used for discovery.', parameters: { type: 'params', properties: { @@ -4359,6 +4360,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a profile.', key: 'literal:self', record: { type: 'object', @@ -4398,7 +4400,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Sets the private preferences attached to the account.', + description: 'Set the private preferences attached to the account.', input: { encoding: 'application/json', schema: { @@ -4427,12 +4429,12 @@ export const schemaDict = { properties: { term: { type: 'string', - description: "DEPRECATED: use 'q' instead", + description: "DEPRECATED: use 'q' instead.", }, q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -4473,17 +4475,17 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Find actor suggestions for a search term.', + description: 'Find actor suggestions for a prefix search term.', parameters: { type: 'params', properties: { term: { type: 'string', - description: "DEPRECATED: use 'q' instead", + description: "DEPRECATED: use 'q' instead.", }, q: { type: 'string', - description: 'search query prefix; not a full query string', + description: 'Search query prefix; not a full query string.', }, limit: { type: 'integer', @@ -4516,7 +4518,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.external', description: - 'A representation of some externally linked content, embedded in another form of content', + 'A representation of some externally linked content, embedded in another form of content.', defs: { main: { type: 'object', @@ -4583,7 +4585,7 @@ export const schemaDict = { AppBskyEmbedImages: { 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 some other form of content.', defs: { main: { type: 'object', @@ -4672,7 +4674,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.record', description: - 'A representation of a record embedded in another form of content', + 'A representation of a record embedded in another form of content.', defs: { main: { type: 'object', @@ -4782,7 +4784,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.recordWithMedia', description: - 'A representation of a record embedded in another form of content, alongside other compatible embeds', + 'A representation of a record embedded in another form of content, alongside other compatible embeds.', defs: { main: { type: 'object', @@ -5150,7 +5152,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Returns information about a given feed generator including TOS & offered feed URIs', + 'Get information about a feed generator, including policies and offered feed URIs.', output: { encoding: 'application/json', schema: { @@ -5205,7 +5207,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A declaration of the existence of a feed generator', + description: 'A declaration of the existence of a feed generator.', key: 'any', record: { type: 'object', @@ -5256,7 +5258,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Retrieve a list of feeds created by a given actor', + description: 'Get a list of feeds created by the actor.', parameters: { type: 'params', required: ['actor'], @@ -5304,7 +5306,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A view of the posts liked by an actor.', + description: 'Get a list of posts liked by an actor.', parameters: { type: 'params', required: ['actor'], @@ -5360,7 +5362,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of an actor's feed.", + description: "Get a view of an actor's feed.", parameters: { type: 'params', required: ['actor'], @@ -5426,7 +5428,7 @@ export const schemaDict = { main: { type: 'query', description: - "Compose and hydrate a feed from a user's selected feed generator", + "Get a hydrated feed from an actor's selected feed generator.", parameters: { type: 'params', required: ['feed'], @@ -5479,8 +5481,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: - 'Get information about a specific feed offered by a feed generator, such as its online status', + description: 'Get information about a feed generator.', parameters: { type: 'params', required: ['feed'], @@ -5519,7 +5520,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Get information about a list of feed generators', + description: 'Get information about a list of feed generators.', parameters: { type: 'params', required: ['feeds'], @@ -5558,7 +5559,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A skeleton of a feed provided by a feed generator', + description: 'Get a skeleton of a feed provided by a feed generator.', parameters: { type: 'params', required: ['feed'], @@ -5611,6 +5612,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get the list of likes.', parameters: { type: 'params', required: ['uri'], @@ -5688,7 +5690,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A view of a recent posts from actors in a list', + description: 'Get a view of a recent posts from actors in a list.', parameters: { type: 'params', required: ['list'], @@ -5741,6 +5743,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get posts in a thread.', parameters: { type: 'params', required: ['uri'], @@ -5794,7 +5797,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of an actor's feed.", + description: "Get a view of an actor's feed.", parameters: { type: 'params', required: ['uris'], @@ -5834,6 +5837,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get a list of reposts.', parameters: { type: 'params', required: ['uri'], @@ -5936,7 +5940,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of the user's home timeline.", + description: "Get a view of the actor's home timeline.", parameters: { type: 'params', properties: { @@ -5982,6 +5986,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a like.', key: 'tid', record: { type: 'object', @@ -6006,6 +6011,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a post.', key: 'tid', record: { type: 'object', @@ -6128,6 +6134,7 @@ export const schemaDict = { id: 'app.bsky.feed.repost', defs: { main: { + description: 'A declaration of a repost.', type: 'record', key: 'tid', record: { @@ -6153,7 +6160,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Find posts matching search criteria', + description: 'Find posts matching search criteria.', parameters: { type: 'params', required: ['q'], @@ -6161,7 +6168,7 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -6172,7 +6179,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -6188,7 +6195,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, posts: { type: 'array', @@ -6273,7 +6280,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A block.', + description: 'A declaration of a block.', key: 'tid', record: { type: 'object', @@ -6400,12 +6407,12 @@ export const schemaDict = { modlist: { type: 'token', description: - 'A list of actors to apply an aggregate moderation action (mute/block) on', + 'A list of actors to apply an aggregate moderation action (mute/block) on.', }, curatelist: { type: 'token', description: - 'A list of actors used for curation purposes such as list feeds or interaction gating', + 'A list of actors used for curation purposes such as list feeds or interaction gating.', }, listViewerState: { type: 'object', @@ -6427,7 +6434,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A social follow.', + description: 'A declaration of a social follow.', key: 'tid', record: { type: 'object', @@ -6452,7 +6459,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Who is the requester's account blocking?", + description: 'Get a list of who the actor is blocking.', parameters: { type: 'params', properties: { @@ -6495,7 +6502,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who is following an actor?', + description: "Get a list of an actor's followers.", parameters: { type: 'params', required: ['actor'], @@ -6547,7 +6554,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who is an actor following?', + description: 'Get a list of who the actor follows.', parameters: { type: 'params', required: ['actor'], @@ -6599,7 +6606,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Fetch a list of actors', + description: 'Get a list of actors.', parameters: { type: 'params', required: ['list'], @@ -6651,7 +6658,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Which lists is the requester's account blocking?", + description: 'Get lists that the actor is blocking.', parameters: { type: 'params', properties: { @@ -6694,7 +6701,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Which lists is the requester's account muting?", + description: 'Get lists that the actor is muting.', parameters: { type: 'params', properties: { @@ -6737,7 +6744,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Fetch a list of lists that belong to an actor', + description: 'Get a list of lists that belong to an actor.', parameters: { type: 'params', required: ['actor'], @@ -6785,7 +6792,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who does the viewer mute?', + description: 'Get a list of who the actor mutes.', parameters: { type: 'params', properties: { @@ -6940,7 +6947,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'An item under a declared list of actors', + description: 'An item under a declared list of actors.', key: 'tid', record: { type: 'object', @@ -6969,7 +6976,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Mute an actor by did or handle.', + description: 'Mute an actor by DID or handle.', input: { encoding: 'application/json', schema: { @@ -7015,7 +7022,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Unmute an actor by did or handle.', + description: 'Unmute an actor by DID or handle.', input: { encoding: 'application/json', schema: { @@ -7061,6 +7068,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get the count of unread notifications.', parameters: { type: 'params', properties: { @@ -7091,6 +7099,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get a list of notifications.', parameters: { type: 'params', properties: { @@ -7197,7 +7206,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Register for push notifications with a service', + description: 'Register for push notifications with a service.', input: { encoding: 'application/json', schema: { @@ -7357,7 +7366,7 @@ export const schemaDict = { main: { type: 'query', description: - 'DEPRECATED: will be removed soon, please find a feed generator alternative', + 'DEPRECATED: will be removed soon. Use a feed generator alternative.', parameters: { type: 'params', properties: { @@ -7404,7 +7413,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'An unspecced view of globally popular feed generators', + description: 'An unspecced view of globally popular feed generators.', parameters: { type: 'params', properties: { @@ -7450,7 +7459,8 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A skeleton of a timeline - UNSPECCED & WILL GO AWAY SOON', + description: + 'DEPRECATED: a skeleton of a timeline. Unspecced and will be unavailable soon.', parameters: { type: 'params', properties: { @@ -7498,7 +7508,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Backend Actors (profile) search, returning only skeleton', + description: 'Backend Actors (profile) search, returns only skeleton.', parameters: { type: 'params', required: ['q'], @@ -7506,11 +7516,11 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.', }, typeahead: { type: 'boolean', - description: "if true, acts as fast/simple 'typeahead' query", + description: "If true, acts as fast/simple 'typeahead' query.", }, limit: { type: 'integer', @@ -7521,7 +7531,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -7537,7 +7547,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, actors: { type: 'array', @@ -7563,7 +7573,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Backend Posts search, returning only skeleton', + description: 'Backend Posts search, returns only skeleton', parameters: { type: 'params', required: ['q'], @@ -7571,7 +7581,7 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -7582,7 +7592,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -7598,7 +7608,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, posts: { type: 'array', diff --git a/packages/bsky/src/lexicon/types/app/bsky/actor/defs.ts b/packages/bsky/src/lexicon/types/app/bsky/actor/defs.ts index 171f5c5ef48..c20177ca50e 100644 --- a/packages/bsky/src/lexicon/types/app/bsky/actor/defs.ts +++ b/packages/bsky/src/lexicon/types/app/bsky/actor/defs.ts @@ -169,7 +169,7 @@ export function validateSavedFeedsPref(v: unknown): ValidationResult { } export interface PersonalDetailsPref { - /** The birth date of the owner of the account. */ + /** The birth date of account owner. */ birthDate?: string [k: string]: unknown } @@ -215,7 +215,7 @@ export function validateFeedViewPref(v: unknown): ValidationResult { } export interface ThreadViewPref { - /** Sorting mode. */ + /** Sorting mode for threads. */ sort?: 'oldest' | 'newest' | 'most-likes' | 'random' | (string & {}) /** Show followed users at the top of all replies. */ prioritizeFollowedUsers?: boolean diff --git a/packages/bsky/src/lexicon/types/app/bsky/actor/searchActors.ts b/packages/bsky/src/lexicon/types/app/bsky/actor/searchActors.ts index 0222f3658da..f072b8a4d04 100644 --- a/packages/bsky/src/lexicon/types/app/bsky/actor/searchActors.ts +++ b/packages/bsky/src/lexicon/types/app/bsky/actor/searchActors.ts @@ -10,9 +10,9 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyActorDefs from './defs' export interface QueryParams { - /** DEPRECATED: use 'q' instead */ + /** DEPRECATED: use 'q' instead. */ term?: string - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q?: string limit: number cursor?: string diff --git a/packages/bsky/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts b/packages/bsky/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts index ba0d62444ce..0cf56753db2 100644 --- a/packages/bsky/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts +++ b/packages/bsky/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts @@ -10,9 +10,9 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyActorDefs from './defs' export interface QueryParams { - /** DEPRECATED: use 'q' instead */ + /** DEPRECATED: use 'q' instead. */ term?: string - /** search query prefix; not a full query string */ + /** Search query prefix; not a full query string. */ q?: string limit: number } diff --git a/packages/bsky/src/lexicon/types/app/bsky/feed/searchPosts.ts b/packages/bsky/src/lexicon/types/app/bsky/feed/searchPosts.ts index 6b5fe08e467..36ac7cbb67d 100644 --- a/packages/bsky/src/lexicon/types/app/bsky/feed/searchPosts.ts +++ b/packages/bsky/src/lexicon/types/app/bsky/feed/searchPosts.ts @@ -10,10 +10,10 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyFeedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q: string limit: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -21,7 +21,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number posts: AppBskyFeedDefs.PostView[] [k: string]: unknown diff --git a/packages/bsky/src/lexicon/types/app/bsky/graph/defs.ts b/packages/bsky/src/lexicon/types/app/bsky/graph/defs.ts index 121d9db200a..f6c7cb7d77d 100644 --- a/packages/bsky/src/lexicon/types/app/bsky/graph/defs.ts +++ b/packages/bsky/src/lexicon/types/app/bsky/graph/defs.ts @@ -79,9 +79,9 @@ export type ListPurpose = | 'app.bsky.graph.defs#curatelist' | (string & {}) -/** A list of actors to apply an aggregate moderation action (mute/block) on */ +/** A list of actors to apply an aggregate moderation action (mute/block) on. */ export const MODLIST = 'app.bsky.graph.defs#modlist' -/** A list of actors used for curation purposes such as list feeds or interaction gating */ +/** A list of actors used for curation purposes such as list feeds or interaction gating. */ export const CURATELIST = 'app.bsky.graph.defs#curatelist' export interface ListViewerState { diff --git a/packages/bsky/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts b/packages/bsky/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts index 2cf59bf86a9..5c45b9fb622 100644 --- a/packages/bsky/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts +++ b/packages/bsky/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts @@ -10,12 +10,12 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyUnspeccedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax. */ q: string - /** if true, acts as fast/simple 'typeahead' query */ + /** If true, acts as fast/simple 'typeahead' query. */ typeahead?: boolean limit: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -23,7 +23,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number actors: AppBskyUnspeccedDefs.SkeletonSearchActor[] [k: string]: unknown diff --git a/packages/bsky/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts b/packages/bsky/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts index df990d2c5c6..15532087b82 100644 --- a/packages/bsky/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts +++ b/packages/bsky/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts @@ -10,10 +10,10 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyUnspeccedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q: string limit: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -21,7 +21,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number posts: AppBskyUnspeccedDefs.SkeletonSearchPost[] [k: string]: unknown diff --git a/packages/bsky/src/lexicon/types/com/atproto/admin/defs.ts b/packages/bsky/src/lexicon/types/com/atproto/admin/defs.ts index 7c74f6b8b98..8a21c42119e 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/admin/defs.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/admin/defs.ts @@ -31,7 +31,7 @@ export function validateStatusAttr(v: unknown): ValidationResult { export interface ActionView { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number subject: | RepoRef @@ -63,7 +63,7 @@ export function validateActionView(v: unknown): ValidationResult { export interface ActionViewDetail { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number subject: | RepoView @@ -97,7 +97,7 @@ export function validateActionViewDetail(v: unknown): ValidationResult { export interface ActionViewCurrent { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number [k: string]: unknown } diff --git a/packages/bsky/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts b/packages/bsky/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts index 051fabb65e1..62864923dfd 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts @@ -12,7 +12,7 @@ export interface QueryParams {} export interface InputSchema { account: string - /** Additionally add a note describing why the invites were disabled */ + /** Optional reason for disabled invites. */ note?: string [k: string]: unknown } diff --git a/packages/bsky/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts b/packages/bsky/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts index 4a26d302333..fb3aa8b8375 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts @@ -12,7 +12,7 @@ export interface QueryParams {} export interface InputSchema { account: string - /** Additionally add a note describing why the invites were enabled */ + /** Optional reason for enabled invites. */ note?: string [k: string]: unknown } diff --git a/packages/bsky/src/lexicon/types/com/atproto/admin/getModerationReports.ts b/packages/bsky/src/lexicon/types/com/atproto/admin/getModerationReports.ts index d50af44c757..b80811cf213 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/admin/getModerationReports.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/admin/getModerationReports.ts @@ -12,9 +12,9 @@ import * as ComAtprotoAdminDefs from './defs' export interface QueryParams { subject?: string ignoreSubjects?: string[] - /** Get all reports that were actioned by a specific moderator */ + /** Get all reports that were actioned by a specific moderator. */ actionedBy?: string - /** Filter reports made by one or more DIDs */ + /** Filter reports made by one or more DIDs. */ reporters?: string[] resolved?: boolean actionType?: @@ -25,7 +25,7 @@ export interface QueryParams { | (string & {}) limit: number cursor?: string - /** Reverse the order of the returned records? when true, returns reports in chronological order */ + /** Reverse the order of the returned records. When true, returns reports in chronological order. */ reverse?: boolean } diff --git a/packages/bsky/src/lexicon/types/com/atproto/admin/takeModerationAction.ts b/packages/bsky/src/lexicon/types/com/atproto/admin/takeModerationAction.ts index fbbf14dff0f..33877d90d11 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/admin/takeModerationAction.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/admin/takeModerationAction.ts @@ -26,7 +26,7 @@ export interface InputSchema { createLabelVals?: string[] negateLabelVals?: string[] reason: string - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number createdBy: string [k: string]: unknown diff --git a/packages/bsky/src/lexicon/types/com/atproto/label/defs.ts b/packages/bsky/src/lexicon/types/com/atproto/label/defs.ts index a01ad78e254..7268650129a 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/label/defs.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/label/defs.ts @@ -6,19 +6,19 @@ import { lexicons } from '../../../../lexicons' import { isObj, hasProp } from '../../../../util' import { CID } from 'multiformats/cid' -/** Metadata tag on an atproto resource (eg, repo or record) */ +/** Metadata tag on an atproto resource (eg, repo or record). */ export interface Label { - /** DID of the actor who created this label */ + /** DID of the actor who created this label. */ src: string - /** AT URI of the record, repository (account), or other resource which this label applies to */ + /** AT URI of the record, repository (account), or other resource that this label applies to. */ uri: string - /** optionally, CID specifying the specific version of 'uri' resource this label applies to */ + /** Optionally, CID specifying the specific version of 'uri' resource this label applies to. */ cid?: string - /** the short string name of the value or type of this label */ + /** The short string name of the value or type of this label. */ val: string - /** if true, this is a negation label, overwriting a previous label */ + /** If true, this is a negation label, overwriting a previous label. */ neg?: boolean - /** timestamp when this label was created */ + /** Timestamp when this label was created. */ cts: string [k: string]: unknown } @@ -53,9 +53,9 @@ export function validateSelfLabels(v: unknown): ValidationResult { return lexicons.validate('com.atproto.label.defs#selfLabels', v) } -/** Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel. */ +/** Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel. */ export interface SelfLabel { - /** the short string name of the value or type of this label */ + /** The short string name of the value or type of this label. */ val: string [k: string]: unknown } diff --git a/packages/bsky/src/lexicon/types/com/atproto/label/queryLabels.ts b/packages/bsky/src/lexicon/types/com/atproto/label/queryLabels.ts index 72cf5c52be6..1d7f8a4def5 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/label/queryLabels.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/label/queryLabels.ts @@ -10,9 +10,9 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as ComAtprotoLabelDefs from './defs' export interface QueryParams { - /** List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI */ + /** List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI. */ uriPatterns: string[] - /** Optional list of label sources (DIDs) to filter on */ + /** Optional list of label sources (DIDs) to filter on. */ sources?: string[] limit: number cursor?: string diff --git a/packages/bsky/src/lexicon/types/com/atproto/repo/applyWrites.ts b/packages/bsky/src/lexicon/types/com/atproto/repo/applyWrites.ts index 53f2972e116..61d1e7c28e4 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/repo/applyWrites.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/repo/applyWrites.ts @@ -13,7 +13,7 @@ export interface QueryParams {} export interface InputSchema { /** The handle or DID of the repo. */ repo: string - /** Validate the records? */ + /** Flag for validating the records. */ validate: boolean writes: (Create | Update | Delete)[] swapCommit?: string diff --git a/packages/bsky/src/lexicon/types/com/atproto/repo/createRecord.ts b/packages/bsky/src/lexicon/types/com/atproto/repo/createRecord.ts index e069f8caf74..df8c5d9e600 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/repo/createRecord.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/repo/createRecord.ts @@ -17,11 +17,11 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey?: string - /** Validate the record? */ + /** Flag for validating the record. */ validate: boolean /** The record to create. */ record: {} - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/bsky/src/lexicon/types/com/atproto/repo/deleteRecord.ts b/packages/bsky/src/lexicon/types/com/atproto/repo/deleteRecord.ts index 5ee016cbed1..f45118a3769 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/repo/deleteRecord.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/repo/deleteRecord.ts @@ -17,9 +17,9 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey: string - /** Compare and swap with the previous record by cid. */ + /** Compare and swap with the previous record by CID. */ swapRecord?: string - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/bsky/src/lexicon/types/com/atproto/repo/listRecords.ts b/packages/bsky/src/lexicon/types/com/atproto/repo/listRecords.ts index e58d9714e33..a6cf6abd1f3 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/repo/listRecords.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/repo/listRecords.ts @@ -20,7 +20,7 @@ export interface QueryParams { rkeyStart?: string /** DEPRECATED: The highest sort-ordered rkey to stop at (exclusive) */ rkeyEnd?: string - /** Reverse the order of the returned records? */ + /** Flag to reverse the order of the returned records. */ reverse?: boolean } diff --git a/packages/bsky/src/lexicon/types/com/atproto/repo/putRecord.ts b/packages/bsky/src/lexicon/types/com/atproto/repo/putRecord.ts index 364eb59f6f1..f10f773c1c4 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/repo/putRecord.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/repo/putRecord.ts @@ -17,13 +17,13 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey: string - /** Validate the record? */ + /** Flag for validating the record. */ validate: boolean /** The record to write. */ record: {} - /** Compare and swap with the previous record by cid. */ + /** Compare and swap with the previous record by CID. */ swapRecord?: string | null - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/bsky/src/lexicon/types/com/atproto/sync/listBlobs.ts b/packages/bsky/src/lexicon/types/com/atproto/sync/listBlobs.ts index 936b08a69f8..b397bb3b3df 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/sync/listBlobs.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/sync/listBlobs.ts @@ -11,7 +11,7 @@ import { HandlerAuth } from '@atproto/xrpc-server' export interface QueryParams { /** The DID of the repo. */ did: string - /** Optional revision of the repo to list blobs since */ + /** Optional revision of the repo to list blobs since. */ since?: string limit: number cursor?: string diff --git a/packages/bsky/src/lexicon/types/com/atproto/sync/subscribeRepos.ts b/packages/bsky/src/lexicon/types/com/atproto/sync/subscribeRepos.ts index ae9cf01f8f2..fb334778bf6 100644 --- a/packages/bsky/src/lexicon/types/com/atproto/sync/subscribeRepos.ts +++ b/packages/bsky/src/lexicon/types/com/atproto/sync/subscribeRepos.ts @@ -39,11 +39,11 @@ export interface Commit { repo: string commit: CID prev?: CID | null - /** The rev of the emitted commit */ + /** The rev of the emitted commit. */ rev: string - /** The rev of the last emitted commit from this repo */ + /** The rev of the last emitted commit from this repo. */ since: string | null - /** CAR file containing relevant blocks */ + /** CAR file containing relevant blocks. */ blocks: Uint8Array ops: RepoOp[] blobs: CID[] @@ -140,7 +140,7 @@ export function validateInfo(v: unknown): ValidationResult { return lexicons.validate('com.atproto.sync.subscribeRepos#info', v) } -/** 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. */ +/** 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. */ export interface RepoOp { action: 'create' | 'update' | 'delete' | (string & {}) path: string diff --git a/packages/pds/src/lexicon/lexicons.ts b/packages/pds/src/lexicon/lexicons.ts index 545d8e9d43d..14c1be9f477 100644 --- a/packages/pds/src/lexicon/lexicons.ts +++ b/packages/pds/src/lexicon/lexicons.ts @@ -43,7 +43,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, subject: { type: 'union', @@ -116,7 +116,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, subject: { type: 'union', @@ -184,7 +184,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, }, }, @@ -725,7 +725,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Disable an account from receiving new invite codes, but does not invalidate existing codes', + 'Disable an account from receiving new invite codes, but does not invalidate existing codes.', input: { encoding: 'application/json', schema: { @@ -738,8 +738,7 @@ export const schemaDict = { }, note: { type: 'string', - description: - 'Additionally add a note describing why the invites were disabled', + description: 'Optional reason for disabled invites.', }, }, }, @@ -754,7 +753,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Disable some set of codes and/or all codes associated with a set of users', + 'Disable some set of codes and/or all codes associated with a set of users.', input: { encoding: 'application/json', schema: { @@ -784,7 +783,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Re-enable an accounts ability to receive invite codes', + description: "Re-enable an account's ability to receive invite codes.", input: { encoding: 'application/json', schema: { @@ -797,8 +796,7 @@ export const schemaDict = { }, note: { type: 'string', - description: - 'Additionally add a note describing why the invites were enabled', + description: 'Optional reason for enabled invites.', }, }, }, @@ -812,7 +810,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about an account.', + description: 'Get details about an account.', parameters: { type: 'params', required: ['did'], @@ -839,7 +837,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Admin view of invite codes', + description: 'Get an admin view of invite codes.', parameters: { type: 'params', properties: { @@ -887,7 +885,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a moderation action.', + description: 'Get details about a moderation action.', parameters: { type: 'params', required: ['id'], @@ -913,7 +911,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List moderation actions related to a subject.', + description: 'Get a list of moderation actions related to a subject.', parameters: { type: 'params', properties: { @@ -959,7 +957,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a moderation report.', + description: 'Get details about a moderation report.', parameters: { type: 'params', required: ['id'], @@ -985,7 +983,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List moderation reports related to a subject.', + description: 'Get moderation reports related to a subject.', parameters: { type: 'params', properties: { @@ -1002,14 +1000,14 @@ export const schemaDict = { type: 'string', format: 'did', description: - 'Get all reports that were actioned by a specific moderator', + 'Get all reports that were actioned by a specific moderator.', }, reporters: { type: 'array', items: { type: 'string', }, - description: 'Filter reports made by one or more DIDs', + description: 'Filter reports made by one or more DIDs.', }, resolved: { type: 'boolean', @@ -1035,7 +1033,7 @@ export const schemaDict = { reverse: { type: 'boolean', description: - 'Reverse the order of the returned records? when true, returns reports in chronological order', + 'Reverse the order of the returned records. When true, returns reports in chronological order.', }, }, }, @@ -1067,7 +1065,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a record.', + description: 'Get details about a record.', parameters: { type: 'params', required: ['uri'], @@ -1103,7 +1101,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'View details about a repository.', + description: 'Get details about a repository.', parameters: { type: 'params', required: ['did'], @@ -1136,7 +1134,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Fetch the service-specific the admin status of a subject (account, record, or blob)', + 'Get the service-specific admin status of a subject (account, record, or blob).', parameters: { type: 'params', properties: { @@ -1309,7 +1307,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Send email to a user's primary email address", + description: "Send email to a user's account email address.", input: { encoding: 'application/json', schema: { @@ -1350,7 +1348,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Take a moderation action on a repo.', + description: 'Take a moderation action on an actor.', input: { encoding: 'application/json', schema: { @@ -1397,7 +1395,7 @@ export const schemaDict = { durationInHours: { type: 'integer', description: - 'Indicates how long this action was meant to be in effect before automatically expiring.', + 'Indicates how long this action is meant to be in effect before automatically expiring.', }, createdBy: { type: 'string', @@ -1427,7 +1425,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Administrative action to update an account's email", + description: "Administrative action to update an account's email.", input: { encoding: 'application/json', schema: { @@ -1454,7 +1452,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: "Administrative action to update an account's handle", + description: "Administrative action to update an account's handle.", input: { encoding: 'application/json', schema: { @@ -1482,7 +1480,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Update the service-specific admin status of a subject (account, record, or blob)', + 'Update the service-specific admin status of a subject (account, record, or blob).', input: { encoding: 'application/json', schema: { @@ -1568,7 +1566,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Updates the handle of the account', + description: 'Updates the handle of the account.', input: { encoding: 'application/json', schema: { @@ -1591,41 +1589,42 @@ export const schemaDict = { defs: { label: { type: 'object', - description: 'Metadata tag on an atproto resource (eg, repo or record)', + description: + 'Metadata tag on an atproto resource (eg, repo or record).', required: ['src', 'uri', 'val', 'cts'], properties: { src: { type: 'string', format: 'did', - description: 'DID of the actor who created this label', + description: 'DID of the actor who created this label.', }, uri: { type: 'string', format: 'uri', description: - 'AT URI of the record, repository (account), or other resource which this label applies to', + 'AT URI of the record, repository (account), or other resource that this label applies to.', }, cid: { type: 'string', format: 'cid', description: - "optionally, CID specifying the specific version of 'uri' resource this label applies to", + "Optionally, CID specifying the specific version of 'uri' resource this label applies to.", }, val: { type: 'string', maxLength: 128, description: - 'the short string name of the value or type of this label', + 'The short string name of the value or type of this label.', }, neg: { type: 'boolean', description: - 'if true, this is a negation label, overwriting a previous label', + 'If true, this is a negation label, overwriting a previous label.', }, cts: { type: 'string', format: 'datetime', - description: 'timestamp when this label was created', + description: 'Timestamp when this label was created.', }, }, }, @@ -1648,14 +1647,14 @@ export const schemaDict = { selfLabel: { type: 'object', description: - 'Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel.', + 'Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.', required: ['val'], properties: { val: { type: 'string', maxLength: 128, description: - 'the short string name of the value or type of this label', + 'The short string name of the value or type of this label.', }, }, }, @@ -1678,7 +1677,7 @@ export const schemaDict = { type: 'string', }, description: - "List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI", + "List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI.", }, sources: { type: 'array', @@ -1686,7 +1685,8 @@ export const schemaDict = { type: 'string', format: 'did', }, - description: 'Optional list of label sources (DIDs) to filter on', + description: + 'Optional list of label sources (DIDs) to filter on.', }, limit: { type: 'integer', @@ -1727,7 +1727,7 @@ export const schemaDict = { defs: { main: { type: 'subscription', - description: 'Subscribe to label updates', + description: 'Subscribe to label updates.', parameters: { type: 'params', properties: { @@ -1922,7 +1922,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the records?', + description: 'Flag for validating the records.', }, writes: { type: 'array', @@ -2031,7 +2031,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the record?', + description: 'Flag for validating the record.', }, record: { type: 'unknown', @@ -2041,7 +2041,7 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2102,13 +2102,13 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous record by cid.', + 'Compare and swap with the previous record by CID.', }, swapCommit: { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2278,7 +2278,7 @@ export const schemaDict = { }, reverse: { type: 'boolean', - description: 'Reverse the order of the returned records?', + description: 'Flag to reverse the order of the returned records.', }, }, }, @@ -2353,7 +2353,7 @@ export const schemaDict = { validate: { type: 'boolean', default: true, - description: 'Validate the record?', + description: 'Flag for validating the record.', }, record: { type: 'unknown', @@ -2363,13 +2363,13 @@ export const schemaDict = { type: 'string', format: 'cid', description: - 'Compare and swap with the previous record by cid.', + 'Compare and swap with the previous record by CID.', }, swapCommit: { type: 'string', format: 'cid', description: - 'Compare and swap with the previous commit by cid.', + 'Compare and swap with the previous commit by CID.', }, }, }, @@ -2583,7 +2583,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Create an app-specific password.', + description: 'Create an App Password.', input: { encoding: 'application/json', schema: { @@ -2671,7 +2671,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Create an invite code.', + description: 'Create invite codes.', input: { encoding: 'application/json', schema: { @@ -2859,7 +2859,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Delete a user account with a token and password.', + description: "Delete an actor's account with a token and password.", input: { encoding: 'application/json', schema: { @@ -2950,7 +2950,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Get all invite codes for a given account', + description: 'Get all invite codes for a given account.', parameters: { type: 'params', properties: { @@ -3030,7 +3030,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List all app-specific passwords.', + description: 'List all App Passwords.', output: { encoding: 'application/json', schema: { @@ -3126,7 +3126,7 @@ export const schemaDict = { main: { type: 'procedure', description: - 'Request an email with a code to confirm ownership of email', + 'Request an email with a code to confirm ownership of email.', }, }, }, @@ -3248,7 +3248,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Revoke an app-specific password by name.', + description: 'Revoke an App Password by name.', input: { encoding: 'application/json', schema: { @@ -3337,7 +3337,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Gets blocks from a given repo.', + description: 'Get blocks from a given repo.', parameters: { type: 'params', required: ['did', 'cids'], @@ -3432,7 +3432,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Gets the current commit CID & revision of the repo.', + description: 'Get the current commit CID & revision of the repo.', parameters: { type: 'params', required: ['did'], @@ -3475,7 +3475,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Gets blocks needed for existence or non-existence of record.', + 'Get blocks needed for existence or non-existence of record.', parameters: { type: 'params', required: ['did', 'collection', 'rkey'], @@ -3512,7 +3512,7 @@ export const schemaDict = { main: { type: 'query', description: - "Gets the did's repo, optionally catching up from a specific revision.", + "Gets the DID's repo, optionally catching up from a specific revision.", parameters: { type: 'params', required: ['did'], @@ -3540,7 +3540,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List blob cids since some revision', + description: 'List blob CIDs since some revision.', parameters: { type: 'params', required: ['did'], @@ -3552,7 +3552,7 @@ export const schemaDict = { }, since: { type: 'string', - description: 'Optional revision of the repo to list blobs since', + description: 'Optional revision of the repo to list blobs since.', }, limit: { type: 'integer', @@ -3593,7 +3593,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'List dids and root cids of hosted repos', + description: 'List DIDs and root CIDs of hosted repos.', parameters: { type: 'params', properties: { @@ -3654,7 +3654,7 @@ export const schemaDict = { 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.', + 'Notify a crawling service of a recent update; often when a long break between updates causes the connection with the crawling service to break.', input: { encoding: 'application/json', schema: { @@ -3702,7 +3702,7 @@ export const schemaDict = { defs: { main: { type: 'subscription', - description: 'Subscribe to repo updates', + description: 'Subscribe to repo updates.', parameters: { type: 'params', properties: { @@ -3771,15 +3771,15 @@ export const schemaDict = { }, rev: { type: 'string', - description: 'The rev of the emitted commit', + description: 'The rev of the emitted commit.', }, 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.', }, blocks: { type: 'bytes', - description: 'CAR file containing relevant blocks', + description: 'CAR file containing relevant blocks.', maxLength: 1000000, }, ops: { @@ -3877,7 +3877,7 @@ export const schemaDict = { 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.", + "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.", required: ['action', 'path', 'cid'], nullable: ['cid'], properties: { @@ -4164,7 +4164,7 @@ export const schemaDict = { birthDate: { type: 'string', format: 'datetime', - description: 'The birth date of the owner of the account.', + description: 'The birth date of account owner.', }, }, }, @@ -4206,7 +4206,7 @@ export const schemaDict = { properties: { sort: { type: 'string', - description: 'Sorting mode.', + description: 'Sorting mode for threads.', knownValues: ['oldest', 'newest', 'most-likes', 'random'], }, prioritizeFollowedUsers: { @@ -4250,6 +4250,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get detailed profile view of an actor.', parameters: { type: 'params', required: ['actor'], @@ -4276,6 +4277,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get detailed profile views of multiple actors.', parameters: { type: 'params', required: ['actors'], @@ -4315,8 +4317,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: - 'Get a list of actors suggested for following. Used in discovery UIs.', + description: 'Get a list of suggested actors, used for discovery.', parameters: { type: 'params', properties: { @@ -4359,6 +4360,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a profile.', key: 'literal:self', record: { type: 'object', @@ -4398,7 +4400,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Sets the private preferences attached to the account.', + description: 'Set the private preferences attached to the account.', input: { encoding: 'application/json', schema: { @@ -4427,12 +4429,12 @@ export const schemaDict = { properties: { term: { type: 'string', - description: "DEPRECATED: use 'q' instead", + description: "DEPRECATED: use 'q' instead.", }, q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -4473,17 +4475,17 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Find actor suggestions for a search term.', + description: 'Find actor suggestions for a prefix search term.', parameters: { type: 'params', properties: { term: { type: 'string', - description: "DEPRECATED: use 'q' instead", + description: "DEPRECATED: use 'q' instead.", }, q: { type: 'string', - description: 'search query prefix; not a full query string', + description: 'Search query prefix; not a full query string.', }, limit: { type: 'integer', @@ -4516,7 +4518,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.external', description: - 'A representation of some externally linked content, embedded in another form of content', + 'A representation of some externally linked content, embedded in another form of content.', defs: { main: { type: 'object', @@ -4583,7 +4585,7 @@ export const schemaDict = { AppBskyEmbedImages: { 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 some other form of content.', defs: { main: { type: 'object', @@ -4672,7 +4674,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.record', description: - 'A representation of a record embedded in another form of content', + 'A representation of a record embedded in another form of content.', defs: { main: { type: 'object', @@ -4782,7 +4784,7 @@ export const schemaDict = { lexicon: 1, id: 'app.bsky.embed.recordWithMedia', description: - 'A representation of a record embedded in another form of content, alongside other compatible embeds', + 'A representation of a record embedded in another form of content, alongside other compatible embeds.', defs: { main: { type: 'object', @@ -5150,7 +5152,7 @@ export const schemaDict = { main: { type: 'query', description: - 'Returns information about a given feed generator including TOS & offered feed URIs', + 'Get information about a feed generator, including policies and offered feed URIs.', output: { encoding: 'application/json', schema: { @@ -5205,7 +5207,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A declaration of the existence of a feed generator', + description: 'A declaration of the existence of a feed generator.', key: 'any', record: { type: 'object', @@ -5256,7 +5258,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Retrieve a list of feeds created by a given actor', + description: 'Get a list of feeds created by the actor.', parameters: { type: 'params', required: ['actor'], @@ -5304,7 +5306,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A view of the posts liked by an actor.', + description: 'Get a list of posts liked by an actor.', parameters: { type: 'params', required: ['actor'], @@ -5360,7 +5362,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of an actor's feed.", + description: "Get a view of an actor's feed.", parameters: { type: 'params', required: ['actor'], @@ -5426,7 +5428,7 @@ export const schemaDict = { main: { type: 'query', description: - "Compose and hydrate a feed from a user's selected feed generator", + "Get a hydrated feed from an actor's selected feed generator.", parameters: { type: 'params', required: ['feed'], @@ -5479,8 +5481,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: - 'Get information about a specific feed offered by a feed generator, such as its online status', + description: 'Get information about a feed generator.', parameters: { type: 'params', required: ['feed'], @@ -5519,7 +5520,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Get information about a list of feed generators', + description: 'Get information about a list of feed generators.', parameters: { type: 'params', required: ['feeds'], @@ -5558,7 +5559,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A skeleton of a feed provided by a feed generator', + description: 'Get a skeleton of a feed provided by a feed generator.', parameters: { type: 'params', required: ['feed'], @@ -5611,6 +5612,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get the list of likes.', parameters: { type: 'params', required: ['uri'], @@ -5688,7 +5690,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A view of a recent posts from actors in a list', + description: 'Get a view of a recent posts from actors in a list.', parameters: { type: 'params', required: ['list'], @@ -5741,6 +5743,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get posts in a thread.', parameters: { type: 'params', required: ['uri'], @@ -5794,7 +5797,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of an actor's feed.", + description: "Get a view of an actor's feed.", parameters: { type: 'params', required: ['uris'], @@ -5834,6 +5837,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get a list of reposts.', parameters: { type: 'params', required: ['uri'], @@ -5936,7 +5940,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "A view of the user's home timeline.", + description: "Get a view of the actor's home timeline.", parameters: { type: 'params', properties: { @@ -5982,6 +5986,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a like.', key: 'tid', record: { type: 'object', @@ -6006,6 +6011,7 @@ export const schemaDict = { defs: { main: { type: 'record', + description: 'A declaration of a post.', key: 'tid', record: { type: 'object', @@ -6128,6 +6134,7 @@ export const schemaDict = { id: 'app.bsky.feed.repost', defs: { main: { + description: 'A declaration of a repost.', type: 'record', key: 'tid', record: { @@ -6153,7 +6160,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Find posts matching search criteria', + description: 'Find posts matching search criteria.', parameters: { type: 'params', required: ['q'], @@ -6161,7 +6168,7 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -6172,7 +6179,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -6188,7 +6195,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, posts: { type: 'array', @@ -6273,7 +6280,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A block.', + description: 'A declaration of a block.', key: 'tid', record: { type: 'object', @@ -6400,12 +6407,12 @@ export const schemaDict = { modlist: { type: 'token', description: - 'A list of actors to apply an aggregate moderation action (mute/block) on', + 'A list of actors to apply an aggregate moderation action (mute/block) on.', }, curatelist: { type: 'token', description: - 'A list of actors used for curation purposes such as list feeds or interaction gating', + 'A list of actors used for curation purposes such as list feeds or interaction gating.', }, listViewerState: { type: 'object', @@ -6427,7 +6434,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'A social follow.', + description: 'A declaration of a social follow.', key: 'tid', record: { type: 'object', @@ -6452,7 +6459,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Who is the requester's account blocking?", + description: 'Get a list of who the actor is blocking.', parameters: { type: 'params', properties: { @@ -6495,7 +6502,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who is following an actor?', + description: "Get a list of an actor's followers.", parameters: { type: 'params', required: ['actor'], @@ -6547,7 +6554,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who is an actor following?', + description: 'Get a list of who the actor follows.', parameters: { type: 'params', required: ['actor'], @@ -6599,7 +6606,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Fetch a list of actors', + description: 'Get a list of actors.', parameters: { type: 'params', required: ['list'], @@ -6651,7 +6658,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Which lists is the requester's account blocking?", + description: 'Get lists that the actor is blocking.', parameters: { type: 'params', properties: { @@ -6694,7 +6701,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: "Which lists is the requester's account muting?", + description: 'Get lists that the actor is muting.', parameters: { type: 'params', properties: { @@ -6737,7 +6744,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Fetch a list of lists that belong to an actor', + description: 'Get a list of lists that belong to an actor.', parameters: { type: 'params', required: ['actor'], @@ -6785,7 +6792,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Who does the viewer mute?', + description: 'Get a list of who the actor mutes.', parameters: { type: 'params', properties: { @@ -6940,7 +6947,7 @@ export const schemaDict = { defs: { main: { type: 'record', - description: 'An item under a declared list of actors', + description: 'An item under a declared list of actors.', key: 'tid', record: { type: 'object', @@ -6969,7 +6976,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Mute an actor by did or handle.', + description: 'Mute an actor by DID or handle.', input: { encoding: 'application/json', schema: { @@ -7015,7 +7022,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Unmute an actor by did or handle.', + description: 'Unmute an actor by DID or handle.', input: { encoding: 'application/json', schema: { @@ -7061,6 +7068,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get the count of unread notifications.', parameters: { type: 'params', properties: { @@ -7091,6 +7099,7 @@ export const schemaDict = { defs: { main: { type: 'query', + description: 'Get a list of notifications.', parameters: { type: 'params', properties: { @@ -7197,7 +7206,7 @@ export const schemaDict = { defs: { main: { type: 'procedure', - description: 'Register for push notifications with a service', + description: 'Register for push notifications with a service.', input: { encoding: 'application/json', schema: { @@ -7357,7 +7366,7 @@ export const schemaDict = { main: { type: 'query', description: - 'DEPRECATED: will be removed soon, please find a feed generator alternative', + 'DEPRECATED: will be removed soon. Use a feed generator alternative.', parameters: { type: 'params', properties: { @@ -7404,7 +7413,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'An unspecced view of globally popular feed generators', + description: 'An unspecced view of globally popular feed generators.', parameters: { type: 'params', properties: { @@ -7450,7 +7459,8 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'A skeleton of a timeline - UNSPECCED & WILL GO AWAY SOON', + description: + 'DEPRECATED: a skeleton of a timeline. Unspecced and will be unavailable soon.', parameters: { type: 'params', properties: { @@ -7498,7 +7508,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Backend Actors (profile) search, returning only skeleton', + description: 'Backend Actors (profile) search, returns only skeleton.', parameters: { type: 'params', required: ['q'], @@ -7506,11 +7516,11 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.', }, typeahead: { type: 'boolean', - description: "if true, acts as fast/simple 'typeahead' query", + description: "If true, acts as fast/simple 'typeahead' query.", }, limit: { type: 'integer', @@ -7521,7 +7531,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -7537,7 +7547,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, actors: { type: 'array', @@ -7563,7 +7573,7 @@ export const schemaDict = { defs: { main: { type: 'query', - description: 'Backend Posts search, returning only skeleton', + description: 'Backend Posts search, returns only skeleton', parameters: { type: 'params', required: ['q'], @@ -7571,7 +7581,7 @@ export const schemaDict = { q: { type: 'string', description: - 'search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended', + 'Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.', }, limit: { type: 'integer', @@ -7582,7 +7592,7 @@ export const schemaDict = { cursor: { type: 'string', description: - 'optional pagination mechanism; may not necessarily allow scrolling through entire result set', + 'Optional pagination mechanism; may not necessarily allow scrolling through entire result set.', }, }, }, @@ -7598,7 +7608,7 @@ export const schemaDict = { hitsTotal: { type: 'integer', description: - 'count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits', + 'Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.', }, posts: { type: 'array', diff --git a/packages/pds/src/lexicon/types/app/bsky/actor/defs.ts b/packages/pds/src/lexicon/types/app/bsky/actor/defs.ts index 171f5c5ef48..c20177ca50e 100644 --- a/packages/pds/src/lexicon/types/app/bsky/actor/defs.ts +++ b/packages/pds/src/lexicon/types/app/bsky/actor/defs.ts @@ -169,7 +169,7 @@ export function validateSavedFeedsPref(v: unknown): ValidationResult { } export interface PersonalDetailsPref { - /** The birth date of the owner of the account. */ + /** The birth date of account owner. */ birthDate?: string [k: string]: unknown } @@ -215,7 +215,7 @@ export function validateFeedViewPref(v: unknown): ValidationResult { } export interface ThreadViewPref { - /** Sorting mode. */ + /** Sorting mode for threads. */ sort?: 'oldest' | 'newest' | 'most-likes' | 'random' | (string & {}) /** Show followed users at the top of all replies. */ prioritizeFollowedUsers?: boolean diff --git a/packages/pds/src/lexicon/types/app/bsky/actor/searchActors.ts b/packages/pds/src/lexicon/types/app/bsky/actor/searchActors.ts index 0222f3658da..f072b8a4d04 100644 --- a/packages/pds/src/lexicon/types/app/bsky/actor/searchActors.ts +++ b/packages/pds/src/lexicon/types/app/bsky/actor/searchActors.ts @@ -10,9 +10,9 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyActorDefs from './defs' export interface QueryParams { - /** DEPRECATED: use 'q' instead */ + /** DEPRECATED: use 'q' instead. */ term?: string - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q?: string limit: number cursor?: string diff --git a/packages/pds/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts b/packages/pds/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts index ba0d62444ce..0cf56753db2 100644 --- a/packages/pds/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts +++ b/packages/pds/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts @@ -10,9 +10,9 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyActorDefs from './defs' export interface QueryParams { - /** DEPRECATED: use 'q' instead */ + /** DEPRECATED: use 'q' instead. */ term?: string - /** search query prefix; not a full query string */ + /** Search query prefix; not a full query string. */ q?: string limit: number } diff --git a/packages/pds/src/lexicon/types/app/bsky/feed/searchPosts.ts b/packages/pds/src/lexicon/types/app/bsky/feed/searchPosts.ts index 6b5fe08e467..36ac7cbb67d 100644 --- a/packages/pds/src/lexicon/types/app/bsky/feed/searchPosts.ts +++ b/packages/pds/src/lexicon/types/app/bsky/feed/searchPosts.ts @@ -10,10 +10,10 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyFeedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q: string limit: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -21,7 +21,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number posts: AppBskyFeedDefs.PostView[] [k: string]: unknown diff --git a/packages/pds/src/lexicon/types/app/bsky/graph/defs.ts b/packages/pds/src/lexicon/types/app/bsky/graph/defs.ts index 121d9db200a..f6c7cb7d77d 100644 --- a/packages/pds/src/lexicon/types/app/bsky/graph/defs.ts +++ b/packages/pds/src/lexicon/types/app/bsky/graph/defs.ts @@ -79,9 +79,9 @@ export type ListPurpose = | 'app.bsky.graph.defs#curatelist' | (string & {}) -/** A list of actors to apply an aggregate moderation action (mute/block) on */ +/** A list of actors to apply an aggregate moderation action (mute/block) on. */ export const MODLIST = 'app.bsky.graph.defs#modlist' -/** A list of actors used for curation purposes such as list feeds or interaction gating */ +/** A list of actors used for curation purposes such as list feeds or interaction gating. */ export const CURATELIST = 'app.bsky.graph.defs#curatelist' export interface ListViewerState { diff --git a/packages/pds/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts b/packages/pds/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts index 2cf59bf86a9..5c45b9fb622 100644 --- a/packages/pds/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts +++ b/packages/pds/src/lexicon/types/app/bsky/unspecced/searchActorsSkeleton.ts @@ -10,12 +10,12 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyUnspeccedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax. */ q: string - /** if true, acts as fast/simple 'typeahead' query */ + /** If true, acts as fast/simple 'typeahead' query. */ typeahead?: boolean limit: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -23,7 +23,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number actors: AppBskyUnspeccedDefs.SkeletonSearchActor[] [k: string]: unknown diff --git a/packages/pds/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts b/packages/pds/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts index df990d2c5c6..15532087b82 100644 --- a/packages/pds/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts +++ b/packages/pds/src/lexicon/types/app/bsky/unspecced/searchPostsSkeleton.ts @@ -10,10 +10,10 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as AppBskyUnspeccedDefs from './defs' export interface QueryParams { - /** search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended */ + /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */ q: string limit: number - /** optional pagination mechanism; may not necessarily allow scrolling through entire result set */ + /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */ cursor?: string } @@ -21,7 +21,7 @@ export type InputSchema = undefined export interface OutputSchema { cursor?: string - /** count of search hits. optional, may be rounded/truncated, and may not be possible to paginate through all hits */ + /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */ hitsTotal?: number posts: AppBskyUnspeccedDefs.SkeletonSearchPost[] [k: string]: unknown diff --git a/packages/pds/src/lexicon/types/com/atproto/admin/defs.ts b/packages/pds/src/lexicon/types/com/atproto/admin/defs.ts index 7c74f6b8b98..8a21c42119e 100644 --- a/packages/pds/src/lexicon/types/com/atproto/admin/defs.ts +++ b/packages/pds/src/lexicon/types/com/atproto/admin/defs.ts @@ -31,7 +31,7 @@ export function validateStatusAttr(v: unknown): ValidationResult { export interface ActionView { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number subject: | RepoRef @@ -63,7 +63,7 @@ export function validateActionView(v: unknown): ValidationResult { export interface ActionViewDetail { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number subject: | RepoView @@ -97,7 +97,7 @@ export function validateActionViewDetail(v: unknown): ValidationResult { export interface ActionViewCurrent { id: number action: ActionType - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number [k: string]: unknown } diff --git a/packages/pds/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts b/packages/pds/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts index 051fabb65e1..62864923dfd 100644 --- a/packages/pds/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts +++ b/packages/pds/src/lexicon/types/com/atproto/admin/disableAccountInvites.ts @@ -12,7 +12,7 @@ export interface QueryParams {} export interface InputSchema { account: string - /** Additionally add a note describing why the invites were disabled */ + /** Optional reason for disabled invites. */ note?: string [k: string]: unknown } diff --git a/packages/pds/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts b/packages/pds/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts index 4a26d302333..fb3aa8b8375 100644 --- a/packages/pds/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts +++ b/packages/pds/src/lexicon/types/com/atproto/admin/enableAccountInvites.ts @@ -12,7 +12,7 @@ export interface QueryParams {} export interface InputSchema { account: string - /** Additionally add a note describing why the invites were enabled */ + /** Optional reason for enabled invites. */ note?: string [k: string]: unknown } diff --git a/packages/pds/src/lexicon/types/com/atproto/admin/getModerationReports.ts b/packages/pds/src/lexicon/types/com/atproto/admin/getModerationReports.ts index d50af44c757..b80811cf213 100644 --- a/packages/pds/src/lexicon/types/com/atproto/admin/getModerationReports.ts +++ b/packages/pds/src/lexicon/types/com/atproto/admin/getModerationReports.ts @@ -12,9 +12,9 @@ import * as ComAtprotoAdminDefs from './defs' export interface QueryParams { subject?: string ignoreSubjects?: string[] - /** Get all reports that were actioned by a specific moderator */ + /** Get all reports that were actioned by a specific moderator. */ actionedBy?: string - /** Filter reports made by one or more DIDs */ + /** Filter reports made by one or more DIDs. */ reporters?: string[] resolved?: boolean actionType?: @@ -25,7 +25,7 @@ export interface QueryParams { | (string & {}) limit: number cursor?: string - /** Reverse the order of the returned records? when true, returns reports in chronological order */ + /** Reverse the order of the returned records. When true, returns reports in chronological order. */ reverse?: boolean } diff --git a/packages/pds/src/lexicon/types/com/atproto/admin/takeModerationAction.ts b/packages/pds/src/lexicon/types/com/atproto/admin/takeModerationAction.ts index fbbf14dff0f..33877d90d11 100644 --- a/packages/pds/src/lexicon/types/com/atproto/admin/takeModerationAction.ts +++ b/packages/pds/src/lexicon/types/com/atproto/admin/takeModerationAction.ts @@ -26,7 +26,7 @@ export interface InputSchema { createLabelVals?: string[] negateLabelVals?: string[] reason: string - /** Indicates how long this action was meant to be in effect before automatically expiring. */ + /** Indicates how long this action is meant to be in effect before automatically expiring. */ durationInHours?: number createdBy: string [k: string]: unknown diff --git a/packages/pds/src/lexicon/types/com/atproto/label/defs.ts b/packages/pds/src/lexicon/types/com/atproto/label/defs.ts index a01ad78e254..7268650129a 100644 --- a/packages/pds/src/lexicon/types/com/atproto/label/defs.ts +++ b/packages/pds/src/lexicon/types/com/atproto/label/defs.ts @@ -6,19 +6,19 @@ import { lexicons } from '../../../../lexicons' import { isObj, hasProp } from '../../../../util' import { CID } from 'multiformats/cid' -/** Metadata tag on an atproto resource (eg, repo or record) */ +/** Metadata tag on an atproto resource (eg, repo or record). */ export interface Label { - /** DID of the actor who created this label */ + /** DID of the actor who created this label. */ src: string - /** AT URI of the record, repository (account), or other resource which this label applies to */ + /** AT URI of the record, repository (account), or other resource that this label applies to. */ uri: string - /** optionally, CID specifying the specific version of 'uri' resource this label applies to */ + /** Optionally, CID specifying the specific version of 'uri' resource this label applies to. */ cid?: string - /** the short string name of the value or type of this label */ + /** The short string name of the value or type of this label. */ val: string - /** if true, this is a negation label, overwriting a previous label */ + /** If true, this is a negation label, overwriting a previous label. */ neg?: boolean - /** timestamp when this label was created */ + /** Timestamp when this label was created. */ cts: string [k: string]: unknown } @@ -53,9 +53,9 @@ export function validateSelfLabels(v: unknown): ValidationResult { return lexicons.validate('com.atproto.label.defs#selfLabels', v) } -/** Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel. */ +/** Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel. */ export interface SelfLabel { - /** the short string name of the value or type of this label */ + /** The short string name of the value or type of this label. */ val: string [k: string]: unknown } diff --git a/packages/pds/src/lexicon/types/com/atproto/label/queryLabels.ts b/packages/pds/src/lexicon/types/com/atproto/label/queryLabels.ts index 72cf5c52be6..1d7f8a4def5 100644 --- a/packages/pds/src/lexicon/types/com/atproto/label/queryLabels.ts +++ b/packages/pds/src/lexicon/types/com/atproto/label/queryLabels.ts @@ -10,9 +10,9 @@ import { HandlerAuth } from '@atproto/xrpc-server' import * as ComAtprotoLabelDefs from './defs' export interface QueryParams { - /** List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI */ + /** List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI. */ uriPatterns: string[] - /** Optional list of label sources (DIDs) to filter on */ + /** Optional list of label sources (DIDs) to filter on. */ sources?: string[] limit: number cursor?: string diff --git a/packages/pds/src/lexicon/types/com/atproto/repo/applyWrites.ts b/packages/pds/src/lexicon/types/com/atproto/repo/applyWrites.ts index 53f2972e116..61d1e7c28e4 100644 --- a/packages/pds/src/lexicon/types/com/atproto/repo/applyWrites.ts +++ b/packages/pds/src/lexicon/types/com/atproto/repo/applyWrites.ts @@ -13,7 +13,7 @@ export interface QueryParams {} export interface InputSchema { /** The handle or DID of the repo. */ repo: string - /** Validate the records? */ + /** Flag for validating the records. */ validate: boolean writes: (Create | Update | Delete)[] swapCommit?: string diff --git a/packages/pds/src/lexicon/types/com/atproto/repo/createRecord.ts b/packages/pds/src/lexicon/types/com/atproto/repo/createRecord.ts index e069f8caf74..df8c5d9e600 100644 --- a/packages/pds/src/lexicon/types/com/atproto/repo/createRecord.ts +++ b/packages/pds/src/lexicon/types/com/atproto/repo/createRecord.ts @@ -17,11 +17,11 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey?: string - /** Validate the record? */ + /** Flag for validating the record. */ validate: boolean /** The record to create. */ record: {} - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/pds/src/lexicon/types/com/atproto/repo/deleteRecord.ts b/packages/pds/src/lexicon/types/com/atproto/repo/deleteRecord.ts index 5ee016cbed1..f45118a3769 100644 --- a/packages/pds/src/lexicon/types/com/atproto/repo/deleteRecord.ts +++ b/packages/pds/src/lexicon/types/com/atproto/repo/deleteRecord.ts @@ -17,9 +17,9 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey: string - /** Compare and swap with the previous record by cid. */ + /** Compare and swap with the previous record by CID. */ swapRecord?: string - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/pds/src/lexicon/types/com/atproto/repo/listRecords.ts b/packages/pds/src/lexicon/types/com/atproto/repo/listRecords.ts index e58d9714e33..a6cf6abd1f3 100644 --- a/packages/pds/src/lexicon/types/com/atproto/repo/listRecords.ts +++ b/packages/pds/src/lexicon/types/com/atproto/repo/listRecords.ts @@ -20,7 +20,7 @@ export interface QueryParams { rkeyStart?: string /** DEPRECATED: The highest sort-ordered rkey to stop at (exclusive) */ rkeyEnd?: string - /** Reverse the order of the returned records? */ + /** Flag to reverse the order of the returned records. */ reverse?: boolean } diff --git a/packages/pds/src/lexicon/types/com/atproto/repo/putRecord.ts b/packages/pds/src/lexicon/types/com/atproto/repo/putRecord.ts index 364eb59f6f1..f10f773c1c4 100644 --- a/packages/pds/src/lexicon/types/com/atproto/repo/putRecord.ts +++ b/packages/pds/src/lexicon/types/com/atproto/repo/putRecord.ts @@ -17,13 +17,13 @@ export interface InputSchema { collection: string /** The key of the record. */ rkey: string - /** Validate the record? */ + /** Flag for validating the record. */ validate: boolean /** The record to write. */ record: {} - /** Compare and swap with the previous record by cid. */ + /** Compare and swap with the previous record by CID. */ swapRecord?: string | null - /** Compare and swap with the previous commit by cid. */ + /** Compare and swap with the previous commit by CID. */ swapCommit?: string [k: string]: unknown } diff --git a/packages/pds/src/lexicon/types/com/atproto/sync/listBlobs.ts b/packages/pds/src/lexicon/types/com/atproto/sync/listBlobs.ts index 936b08a69f8..b397bb3b3df 100644 --- a/packages/pds/src/lexicon/types/com/atproto/sync/listBlobs.ts +++ b/packages/pds/src/lexicon/types/com/atproto/sync/listBlobs.ts @@ -11,7 +11,7 @@ import { HandlerAuth } from '@atproto/xrpc-server' export interface QueryParams { /** The DID of the repo. */ did: string - /** Optional revision of the repo to list blobs since */ + /** Optional revision of the repo to list blobs since. */ since?: string limit: number cursor?: string diff --git a/packages/pds/src/lexicon/types/com/atproto/sync/subscribeRepos.ts b/packages/pds/src/lexicon/types/com/atproto/sync/subscribeRepos.ts index ae9cf01f8f2..fb334778bf6 100644 --- a/packages/pds/src/lexicon/types/com/atproto/sync/subscribeRepos.ts +++ b/packages/pds/src/lexicon/types/com/atproto/sync/subscribeRepos.ts @@ -39,11 +39,11 @@ export interface Commit { repo: string commit: CID prev?: CID | null - /** The rev of the emitted commit */ + /** The rev of the emitted commit. */ rev: string - /** The rev of the last emitted commit from this repo */ + /** The rev of the last emitted commit from this repo. */ since: string | null - /** CAR file containing relevant blocks */ + /** CAR file containing relevant blocks. */ blocks: Uint8Array ops: RepoOp[] blobs: CID[] @@ -140,7 +140,7 @@ export function validateInfo(v: unknown): ValidationResult { return lexicons.validate('com.atproto.sync.subscribeRepos#info', v) } -/** 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. */ +/** 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. */ export interface RepoOp { action: 'create' | 'update' | 'delete' | (string & {}) path: string