Skip to content

Commit

Permalink
Tweak lexicon descriptions (#1859)
Browse files Browse the repository at this point in the history
* Tweak lexicon descriptions

* Tweak birthdate

* Update lexicons/app/bsky/actor/getProfiles.json

Co-authored-by: devin ivy <devinivy@gmail.com>

* Regenerate packages from lexicons

---------

Co-authored-by: devin ivy <devinivy@gmail.com>
  • Loading branch information
emilyliu7321 and devinivy authored Nov 20, 2023
1 parent c28754f commit 59f70db
Show file tree
Hide file tree
Showing 161 changed files with 709 additions and 668 deletions.
4 changes: 2 additions & 2 deletions lexicons/app/bsky/actor/defs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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."
}
}
},
Expand Down Expand Up @@ -191,7 +191,7 @@
"properties": {
"sort": {
"type": "string",
"description": "Sorting mode.",
"description": "Sorting mode for threads.",
"knownValues": ["oldest", "newest", "most-likes", "random"]
},
"prioritizeFollowedUsers": {
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/actor/getProfile.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"defs": {
"main": {
"type": "query",
"description": "Get detailed profile view of an actor.",
"parameters": {
"type": "params",
"required": ["actor"],
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/actor/getProfiles.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"defs": {
"main": {
"type": "query",
"description": "Get detailed profile views of multiple actors.",
"parameters": {
"type": "params",
"required": ["actors"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/actor/getSuggestions.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/actor/profile.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"defs": {
"main": {
"type": "record",
"description": "A declaration of a profile.",
"key": "literal:self",
"record": {
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/actor/putPreferences.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
4 changes: 2 additions & 2 deletions lexicons/app/bsky/actor/searchActors.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 3 additions & 3 deletions lexicons/app/bsky/actor/searchActorsTypeahead.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/embed/external.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/embed/images.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/embed/record.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/embed/recordWithMedia.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/describeFeedGenerator.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/generator.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getActorFeeds.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getActorLikes.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getAuthorFeed.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getFeed.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getFeedGenerator.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getFeedGenerators.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getFeedSkeleton.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/feed/getLikes.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"defs": {
"main": {
"type": "query",
"description": "Get the list of likes.",
"parameters": {
"type": "params",
"required": ["uri"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getListFeed.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/feed/getPostThread.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"defs": {
"main": {
"type": "query",
"description": "Get posts in a thread.",
"parameters": {
"type": "params",
"required": ["uri"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getPosts.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/feed/getRepostedBy.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"defs": {
"main": {
"type": "query",
"description": "Get a list of reposts.",
"parameters": {
"type": "params",
"required": ["uri"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/feed/getTimeline.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/feed/like.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"defs": {
"main": {
"type": "record",
"description": "A declaration of a like.",
"key": "tid",
"record": {
"type": "object",
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/feed/post.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"defs": {
"main": {
"type": "record",
"description": "A declaration of a post.",
"key": "tid",
"record": {
"type": "object",
Expand Down
1 change: 1 addition & 0 deletions lexicons/app/bsky/feed/repost.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"id": "app.bsky.feed.repost",
"defs": {
"main": {
"description": "A declaration of a repost.",
"type": "record",
"key": "tid",
"record": {
Expand Down
8 changes: 4 additions & 4 deletions lexicons/app/bsky/feed/searchPosts.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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."
}
}
},
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/graph/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"defs": {
"main": {
"type": "record",
"description": "A block.",
"description": "A declaration of a block.",
"key": "tid",
"record": {
"type": "object",
Expand Down
4 changes: 2 additions & 2 deletions lexicons/app/bsky/graph/defs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/graph/follow.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"defs": {
"main": {
"type": "record",
"description": "A social follow.",
"description": "A declaration of a social follow.",
"key": "tid",
"record": {
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/graph/getBlocks.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/graph/getFollowers.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/graph/getFollows.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/graph/getList.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion lexicons/app/bsky/graph/getListBlocks.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
Loading

0 comments on commit 59f70db

Please sign in to comment.