social bookmarking for atproto

[lexdocs] create all remaining lexicons

hexmani.ac b8ddef88 9965b6c4

verified
+21 -11
lexdocs/social/clippr/actor/defs.json
··· 4 4 "defs": { 5 5 "profileView": { 6 6 "type": "object", 7 + "description": "A view of an actor's profile.", 7 8 "required": [ 8 9 "did", 9 10 "handle" ··· 11 12 "properties": { 12 13 "did": { 13 14 "type": "string", 14 - "format": "did" 15 + "format": "did", 16 + "description": "The DID of the profile" 15 17 }, 16 18 "handle": { 17 19 "type": "string", 18 - "format": "handle" 20 + "format": "handle", 21 + "description": "The handle of the profile" 19 22 }, 20 23 "displayName": { 21 24 "type": "string", 22 25 "minGraphemes": 1, 23 26 "minLength": 10, 24 27 "maxGraphemes": 64, 25 - "maxLength": 640 28 + "maxLength": 640, 29 + "description": "The display name associated to the profile" 26 30 }, 27 31 "description": { 28 32 "type": "string", 29 33 "maxGraphemes": 500, 30 - "maxLength": 5000 34 + "maxLength": 5000, 35 + "description": "The biography associated to the profile" 31 36 }, 32 37 "avatar": { 33 38 "type": "string", 34 - "format": "uri" 39 + "format": "uri", 40 + "description": "A link to the profile's avatar" 35 41 }, 36 42 "createdAt": { 37 43 "type": "string", 38 - "format": "datetime" 44 + "format": "datetime", 45 + "description": "When the profile record was first created" 39 46 } 40 47 } 41 48 }, 42 49 "preferences": { 43 50 "type": "array", 44 - "description": "An array of preference types", 45 - "refs": [ 46 - "#publishingScopesPref" 47 - ] 51 + "description": "An array of refs to various preferences", 52 + "items": { 53 + "type": "union", 54 + "refs": [ 55 + "#publishingScopesPref" 56 + ] 57 + } 48 58 }, 49 59 "publishingScopesPref": { 50 60 "type": "object", ··· 59 69 "public", 60 70 "unlisted" 61 71 ], 62 - "description": "What publishing scope to mark a clip as by default." 72 + "description": "What publishing scope to mark a clip as by default" 63 73 } 64 74 } 65 75 }
+4 -3
lexdocs/social/clippr/actor/getPreferences.json
··· 4 4 "defs": { 5 5 "main": { 6 6 "type": "query", 7 - "description": "Get the private user preferences associated to the account.", 7 + "description": "Get the private user preferences associated to the account.", 8 8 "parameters": { 9 9 "type": "params", 10 10 "properties": {} ··· 19 19 "properties": { 20 20 "preferences": { 21 21 "type": "ref", 22 - "ref": "social.clippr.actor.defs#preferences" 22 + "ref": "social.clippr.actor.defs#preferences", 23 + "description": "A ref to the user's preferences" 23 24 } 24 25 } 25 26 } 26 27 } 27 28 } 28 29 } 29 - } 30 + }
+29 -28
lexdocs/social/clippr/actor/getProfile.json
··· 1 1 { 2 - "lexicon": 1, 3 - "id": "social.clippr.actor.getProfile", 4 - "defs": { 5 - "main": { 6 - "type": "query", 7 - "description": "Get profile view of an actor. Does not require auth.", 8 - "parameters": { 9 - "type": "params", 10 - "required": [ 11 - "actor" 12 - ], 13 - "properties": { 14 - "actor": { 15 - "type": "string", 16 - "format": "at-identifier", 17 - "description": "Handle or DID of account to fetch profile of." 18 - } 19 - } 20 - }, 21 - "output": { 22 - "encoding": "application/json", 23 - "schema": { 24 - "type": "ref", 25 - "ref": "social.clippr.actor.defs#profileView" 26 - } 27 - } 28 - } 29 - } 2 + "lexicon": 1, 3 + "id": "social.clippr.actor.getProfile", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Get profile view of an actor. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "required": [ 11 + "actor" 12 + ], 13 + "properties": { 14 + "actor": { 15 + "type": "string", 16 + "format": "at-identifier", 17 + "description": "Handle or DID of account to fetch profile of" 18 + } 19 + } 20 + }, 21 + "output": { 22 + "encoding": "application/json", 23 + "schema": { 24 + "type": "ref", 25 + "ref": "social.clippr.actor.defs#profileView", 26 + "description": "A reference to the profile view of the actor" 27 + } 28 + } 29 + } 30 + } 30 31 }
+46 -45
lexdocs/social/clippr/actor/profile.json
··· 1 1 { 2 - "lexicon": 1, 3 - "id": "social.clippr.actor.profile", 4 - "defs": { 5 - "main": { 6 - "type": "record", 7 - "description": "A declaration of a Clippr account's profile.", 8 - "key": "literal:self", 9 - "record": { 10 - "type": "object", 11 - "required": [ 12 - "createdAt", 13 - "displayName" 14 - ], 15 - "properties": { 16 - "displayName": { 17 - "type": "string", 18 - "description": "A display name to be shown on a profile.", 19 - "minGraphemes": 1, 20 - "minLength": 10, 21 - "maxGraphemes": 64, 22 - "maxLength": 640 23 - }, 24 - "description": { 25 - "type": "string", 26 - "description": "Text for user to describe themselves", 27 - "maxGraphemes": 500, 28 - "maxLength": 5000 29 - }, 30 - "avatar": { 31 - "type": "blob", 32 - "description": "Image to show on user's profiles.", 33 - "accept": [ 34 - "image/png", 35 - "image/jpeg" 36 - ], 37 - "maxSize": 1000000 38 - }, 39 - "createdAt": { 40 - "type": "string", 41 - "format": "datetime" 42 - } 43 - } 44 - } 45 - } 46 - } 2 + "lexicon": 1, 3 + "id": "social.clippr.actor.profile", 4 + "defs": { 5 + "main": { 6 + "type": "record", 7 + "description": "A declaration of a Clippr account's profile.", 8 + "key": "literal:self", 9 + "record": { 10 + "type": "object", 11 + "required": [ 12 + "createdAt", 13 + "displayName" 14 + ], 15 + "properties": { 16 + "displayName": { 17 + "type": "string", 18 + "description": "A display name to be shown on a profile", 19 + "minGraphemes": 1, 20 + "minLength": 10, 21 + "maxGraphemes": 64, 22 + "maxLength": 640 23 + }, 24 + "description": { 25 + "type": "string", 26 + "description": "Text for user to describe themselves", 27 + "maxGraphemes": 500, 28 + "maxLength": 5000 29 + }, 30 + "avatar": { 31 + "type": "blob", 32 + "description": "Image to show on user's profiles", 33 + "accept": [ 34 + "image/png", 35 + "image/jpeg" 36 + ], 37 + "maxSize": 1000000 38 + }, 39 + "createdAt": { 40 + "type": "string", 41 + "format": "datetime", 42 + "description": "The creation date of the profile" 43 + } 44 + } 45 + } 46 + } 47 + } 47 48 }
+6 -3
lexdocs/social/clippr/actor/putPreferences.json
··· 9 9 "encoding": "application/json", 10 10 "schema": { 11 11 "type": "object", 12 - "required": ["preferences"], 12 + "required": [ 13 + "preferences" 14 + ], 13 15 "properties": { 14 16 "preferences": { 15 17 "type": "ref", 16 - "ref": "social.clippr.actor.defs#preferences" 18 + "ref": "social.clippr.actor.defs#preferences", 19 + "description": "A ref to the user's preferences" 17 20 } 18 21 } 19 22 } 20 23 } 21 24 } 22 25 } 23 - } 26 + }
+51 -42
lexdocs/social/clippr/actor/searchProfiles.json
··· 1 1 { 2 - "lexicon": 1, 3 - "id": "social.clippr.actor.searchProfiles", 4 - "defs": { 5 - "main": { 6 - "type": "query", 7 - "description": "Find profiles matching search criteria. Does not require auth.", 8 - "parameters": { 9 - "type": "params", 10 - "properties": { 11 - "q": { 12 - "type": "string", 13 - "description": "Search query string." 14 - }, 15 - "limit": { 16 - "type": "integer", 17 - "minimum": 1, 18 - "maximum": 100, 19 - "default": 25 20 - }, 21 - "cursor": { "type": "string" } 22 - } 23 - }, 24 - "output": { 25 - "encoding": "application/json", 26 - "schema": { 27 - "type": "object", 28 - "required": ["actors"], 29 - "properties": { 30 - "cursor": { "type": "string" }, 31 - "actors": { 32 - "type": "array", 33 - "items": { 34 - "type": "ref", 35 - "ref": "social.clippr.actor.defs#profileView" 36 - } 37 - } 38 - } 39 - } 40 - } 41 - } 42 - } 43 - } 2 + "lexicon": 1, 3 + "id": "social.clippr.actor.searchProfiles", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Find profiles matching search criteria. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "properties": { 11 + "q": { 12 + "type": "string", 13 + "description": "Search query string" 14 + }, 15 + "limit": { 16 + "type": "integer", 17 + "minimum": 1, 18 + "maximum": 100, 19 + "default": 25, 20 + "description": "The number of profiles to be returned in the query" 21 + }, 22 + "cursor": { 23 + "type": "string", 24 + "description": "A parameter used for pagination" 25 + } 26 + } 27 + }, 28 + "output": { 29 + "encoding": "application/json", 30 + "schema": { 31 + "type": "object", 32 + "required": [ 33 + "actors" 34 + ], 35 + "properties": { 36 + "cursor": { 37 + "type": "string", 38 + "description": "A parameter used for pagination" 39 + }, 40 + "actors": { 41 + "type": "array", 42 + "items": { 43 + "type": "ref", 44 + "ref": "social.clippr.actor.defs#profileView" 45 + } 46 + } 47 + } 48 + } 49 + } 50 + } 51 + } 52 + }
+86 -86
lexdocs/social/clippr/feed/clip.json
··· 1 1 { 2 - "lexicon": 1, 3 - "id": "social.clippr.feed.clip", 4 - "defs": { 5 - "main": { 6 - "type": "record", 7 - "description": "Record containing a bookmark item, or 'clip'.", 8 - "key": "any", 9 - "record": { 10 - "type": "object", 11 - "required": [ 12 - "url", 13 - "title", 14 - "description", 15 - "unlisted", 16 - "createdAt" 17 - ], 18 - "properties": { 19 - "url": { 20 - "type": "string", 21 - "format": "uri", 22 - "description": "The URL of the bookmark. Cannot be left empty or be modified after creation.", 23 - "minGraphemes": 3, 24 - "minLength": 30, 25 - "maxGraphemes": 2000, 26 - "maxLength": 20000 27 - }, 28 - "title": { 29 - "type": "string", 30 - "description": "The title of the bookmark. If left empty, reuse the URL.", 31 - "minGraphemes": 1, 32 - "minLength": 10, 33 - "maxGraphemes": 2048, 34 - "maxLength": 20480 35 - }, 36 - "description": { 37 - "type": "string", 38 - "description": "A description of the bookmark's content. This should be ripped from the URL metadata and be static for all records using the URL.", 39 - "minGraphemes": 1, 40 - "minLength": 10, 41 - "maxGraphemes": 4096, 42 - "maxLength": 40960 43 - }, 44 - "notes": { 45 - "type": "string", 46 - "description": "User-written notes for the bookmark. Public and personal.", 47 - "minGraphemes": 1, 48 - "minLength": 10, 49 - "maxGraphemes": 10000, 50 - "maxLength": 100000 51 - }, 52 - "tags": { 53 - "type": "array", 54 - "description": "An array of tags. A format of solely alphanumeric characters and dashes should be used.", 55 - "items": { 56 - "type": "ref", 57 - "ref": "com.atproto.repo.strongRef" 58 - } 59 - }, 60 - "unlisted": { 61 - "type": "boolean", 62 - "description": "Whether the bookmark can be used for feed indexing and aggregation.", 63 - "default": false 64 - }, 65 - "unread": { 66 - "type": "boolean", 67 - "description": "Whether the bookmark has been read by the user.", 68 - "default": true 69 - }, 70 - "languages": { 71 - "type": "array", 72 - "description": "Indicates human language of the given URL.", 73 - "maxLength": 5, 74 - "items": { 75 - "type": "string", 76 - "format": "language" 77 - } 78 - }, 79 - "createdAt": { 80 - "type": "string", 81 - "description": "Client-declared timestamp when the bookmark is created.", 82 - "format": "datetime" 83 - } 84 - } 85 - } 86 - } 87 - } 2 + "lexicon": 1, 3 + "id": "social.clippr.feed.clip", 4 + "defs": { 5 + "main": { 6 + "type": "record", 7 + "description": "Record containing a bookmarked item, or 'clip'.", 8 + "key": "any", 9 + "record": { 10 + "type": "object", 11 + "required": [ 12 + "url", 13 + "title", 14 + "description", 15 + "unlisted", 16 + "createdAt" 17 + ], 18 + "properties": { 19 + "url": { 20 + "type": "string", 21 + "format": "uri", 22 + "description": "The URL of the bookmark. Cannot be left empty or be modified after creation.", 23 + "minGraphemes": 3, 24 + "minLength": 30, 25 + "maxGraphemes": 2000, 26 + "maxLength": 20000 27 + }, 28 + "title": { 29 + "type": "string", 30 + "description": "The title of the bookmark. If left empty, reuse the URL.", 31 + "minGraphemes": 1, 32 + "minLength": 10, 33 + "maxGraphemes": 2048, 34 + "maxLength": 20480 35 + }, 36 + "description": { 37 + "type": "string", 38 + "description": "A description of the bookmark's content. This should be ripped from the URL metadata and be static for all records using the URL.", 39 + "minGraphemes": 1, 40 + "minLength": 10, 41 + "maxGraphemes": 4096, 42 + "maxLength": 40960 43 + }, 44 + "notes": { 45 + "type": "string", 46 + "description": "User-written notes for the bookmark. Public and personal.", 47 + "minGraphemes": 1, 48 + "minLength": 10, 49 + "maxGraphemes": 10000, 50 + "maxLength": 100000 51 + }, 52 + "tags": { 53 + "type": "array", 54 + "description": "An array of tags. A format of solely alphanumeric characters and dashes should be used.", 55 + "items": { 56 + "type": "ref", 57 + "ref": "com.atproto.repo.strongRef" 58 + } 59 + }, 60 + "unlisted": { 61 + "type": "boolean", 62 + "description": "Whether the bookmark can be used for feed indexing and aggregation", 63 + "default": false 64 + }, 65 + "unread": { 66 + "type": "boolean", 67 + "description": "Whether the bookmark has been read by the user", 68 + "default": true 69 + }, 70 + "languages": { 71 + "type": "array", 72 + "description": "Indicates human language of the given URL", 73 + "maxLength": 5, 74 + "items": { 75 + "type": "string", 76 + "format": "language" 77 + } 78 + }, 79 + "createdAt": { 80 + "type": "string", 81 + "description": "Client-declared timestamp when the bookmark is created", 82 + "format": "datetime" 83 + } 84 + } 85 + } 86 + } 87 + } 88 88 }
+75 -2
lexdocs/social/clippr/feed/defs.json
··· 2 2 "lexicon": 1, 3 3 "id": "social.clippr.feed.defs", 4 4 "defs": { 5 - 5 + "clipView": { 6 + "type": "object", 7 + "description": "A view of a single bookmark (or 'clip').", 8 + "required": [ 9 + "uri", 10 + "cid", 11 + "author", 12 + "record", 13 + "indexedAt" 14 + ], 15 + "properties": { 16 + "uri": { 17 + "type": "string", 18 + "format": "at-uri", 19 + "description": "The AT-URI of the clip" 20 + }, 21 + "cid": { 22 + "type": "string", 23 + "format": "cid", 24 + "description": "The CID of the clip" 25 + }, 26 + "author": { 27 + "type": "ref", 28 + "ref": "social.clippr.actor.defs#profileView", 29 + "description": "A reference to the actor's profile" 30 + }, 31 + "record": { 32 + "type": "unknown", 33 + "description": "The raw record of the clip" 34 + }, 35 + "indexedAt": { 36 + "type": "string", 37 + "format": "datetime", 38 + "description": "The time in which the clip's record was indexed by the AppView" 39 + } 40 + } 41 + }, 42 + "tagView": { 43 + "type": "object", 44 + "description": "A view of a single tag.", 45 + "required": [ 46 + "uri", 47 + "cid", 48 + "author", 49 + "record", 50 + "indexedAt" 51 + ], 52 + "properties": { 53 + "uri": { 54 + "type": "string", 55 + "format": "at-uri", 56 + "description": "The AT-URI to the tag" 57 + }, 58 + "cid": { 59 + "type": "string", 60 + "format": "cid", 61 + "description": "The CID of the tag" 62 + }, 63 + "author": { 64 + "type": "ref", 65 + "ref": "social.clippr.actor.defs#profileView", 66 + "description": "A reference to the actor's profile" 67 + }, 68 + "record": { 69 + "type": "unknown", 70 + "description": "The raw record of the tag" 71 + }, 72 + "indexedAt": { 73 + "type": "string", 74 + "format": "datetime", 75 + "description": "The time in which the tag's recoord was indexed by the AppView" 76 + } 77 + } 78 + } 6 79 } 7 - } 80 + }
+46
lexdocs/social/clippr/feed/getClips.json
··· 1 + { 2 + "lexicon": 1, 3 + "id": "social.clippr.feed.getClips", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Get a list of clips. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "required": [ 11 + "uris" 12 + ], 13 + "properties": { 14 + "uris": { 15 + "type": "array", 16 + "description": "List of clip AT-URIs to return hydrated views for.", 17 + "items": { 18 + "type": "string", 19 + "format": "at-uri" 20 + }, 21 + "maxLength": 25 22 + } 23 + } 24 + }, 25 + "output": { 26 + "encoding": "application/json", 27 + "schema": { 28 + "type": "object", 29 + "required": [ 30 + "clips" 31 + ], 32 + "properties": { 33 + "clips": { 34 + "type": "array", 35 + "items": { 36 + "type": "ref", 37 + "ref": "social.clippr.feed.defs#clipView" 38 + }, 39 + "description": "An array of hydrated clip views" 40 + } 41 + } 42 + } 43 + } 44 + } 45 + } 46 + }
+65
lexdocs/social/clippr/feed/getProfileClips.json
··· 1 + { 2 + "lexicon": 1, 3 + "id": "social.clippr.feed.getProfileClips", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Get a view of a profile's reverse-chronological clips feed. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "required": [ 11 + "actor" 12 + ], 13 + "properties": { 14 + "actor": { 15 + "type": "string", 16 + "format": "at-identifier", 17 + "description": "An actor to get feed data from" 18 + }, 19 + "limit": { 20 + "type": "integer", 21 + "minimum": 1, 22 + "maximum": 100, 23 + "default": 50, 24 + "description": "How many results to return with the query" 25 + }, 26 + "cursor": { 27 + "type": "string", 28 + "description": "A parameter to paginate results" 29 + }, 30 + "filter": { 31 + "type": "string", 32 + "knownValues": [ 33 + "all_clips", 34 + "tagged_clips", 35 + "untagged_clips" 36 + ], 37 + "default": "all_clips", 38 + "description": "What types to include in response" 39 + } 40 + } 41 + }, 42 + "output": { 43 + "encoding": "application/json", 44 + "schema": { 45 + "type": "object", 46 + "required": [ 47 + "feed" 48 + ], 49 + "properties": { 50 + "cursor": { 51 + "type": "string" 52 + }, 53 + "feed": { 54 + "type": "array", 55 + "items": { 56 + "type": "ref", 57 + "ref": "social.clippr.feed.defs#clipView" 58 + } 59 + } 60 + } 61 + } 62 + } 63 + } 64 + } 65 + }
lexdocs/social/clippr/feed/getProfileFeed.json

This is a binary file and will not be displayed.

+55
lexdocs/social/clippr/feed/getProfileTags.json
··· 1 + { 2 + "lexicon": 1, 3 + "id": "social.clippr.feed.getProfileTags", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Get a view of a profile's reverse-chronological clips feed. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "required": [ 11 + "actor" 12 + ], 13 + "properties": { 14 + "actor": { 15 + "type": "string", 16 + "format": "at-identifier", 17 + "description": "An actor to get feed data from" 18 + }, 19 + "limit": { 20 + "type": "integer", 21 + "minimum": 1, 22 + "maximum": 100, 23 + "default": 50, 24 + "description": "How many results to return with the query" 25 + }, 26 + "cursor": { 27 + "type": "string", 28 + "description": "A parameter to paginate results" 29 + } 30 + } 31 + }, 32 + "output": { 33 + "encoding": "application/json", 34 + "schema": { 35 + "type": "object", 36 + "required": [ 37 + "feed" 38 + ], 39 + "properties": { 40 + "cursor": { 41 + "type": "string" 42 + }, 43 + "feed": { 44 + "type": "array", 45 + "items": { 46 + "type": "ref", 47 + "ref": "social.clippr.feed.defs#tagView" 48 + } 49 + } 50 + } 51 + } 52 + } 53 + } 54 + } 55 + }
+39
lexdocs/social/clippr/feed/getTagList.json
··· 1 + { 2 + "lexicon": 1, 3 + "id": "social.clippr.feed.getTagList", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Get a user's list of tags. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "properties": { 11 + "actor": { 12 + "type": "string", 13 + "format": "at-identifier", 14 + "description": "An actor to fetch the tag list from" 15 + } 16 + } 17 + }, 18 + "output": { 19 + "encoding": "application/json", 20 + "schema": { 21 + "type": "object", 22 + "required": [ 23 + "tags" 24 + ], 25 + "properties": { 26 + "tags": { 27 + "type": "array", 28 + "items": { 29 + "type": "ref", 30 + "ref": "social.clippr.feed.defs#tagView" 31 + }, 32 + "description": "A list of tags and their associated details" 33 + } 34 + } 35 + } 36 + } 37 + } 38 + } 39 + }
+46
lexdocs/social/clippr/feed/getTags.json
··· 1 + { 2 + "lexicon": 1, 3 + "id": "social.clippr.feed.getClips", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Get a list of tags. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "required": [ 11 + "uris" 12 + ], 13 + "properties": { 14 + "uris": { 15 + "type": "array", 16 + "description": "List of tag AT-URIs to return hydrated views for", 17 + "items": { 18 + "type": "string", 19 + "format": "at-uri" 20 + }, 21 + "maxLength": 25 22 + } 23 + } 24 + }, 25 + "output": { 26 + "encoding": "application/json", 27 + "schema": { 28 + "type": "object", 29 + "required": [ 30 + "tags" 31 + ], 32 + "properties": { 33 + "tags": { 34 + "type": "array", 35 + "items": { 36 + "type": "ref", 37 + "ref": "social.clippr.feed.defs#tagView" 38 + }, 39 + "description": "An array of hydrated tag views" 40 + } 41 + } 42 + } 43 + } 44 + } 45 + } 46 + }
+61
lexdocs/social/clippr/feed/searchClips.json
··· 1 + { 2 + "lexicon": 1, 3 + "id": "social.clippr.actor.searchClips", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Find clips matching search criteria. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "required": [ 11 + "q" 12 + ], 13 + "properties": { 14 + "q": { 15 + "type": "string", 16 + "description": "Search query string" 17 + }, 18 + "limit": { 19 + "type": "integer", 20 + "minimum": 1, 21 + "maximum": 100, 22 + "default": 25, 23 + "description": "How many clips to return in the query output" 24 + }, 25 + "actor": { 26 + "type": "string", 27 + "format": "at-identifier", 28 + "description": "An actor to filter results to" 29 + }, 30 + "cursor": { 31 + "type": "string", 32 + "description": "A parameter to paginate results" 33 + } 34 + } 35 + }, 36 + "output": { 37 + "encoding": "application/json", 38 + "schema": { 39 + "type": "object", 40 + "required": [ 41 + "clips" 42 + ], 43 + "properties": { 44 + "cursor": { 45 + "type": "string", 46 + "description": "A parameter to paginate results" 47 + }, 48 + "clips": { 49 + "type": "array", 50 + "items": { 51 + "type": "ref", 52 + "ref": "social.clippr.feed.defs#clipView" 53 + }, 54 + "description": "A list of clips and their associated details" 55 + } 56 + } 57 + } 58 + } 59 + } 60 + } 61 + }
+61
lexdocs/social/clippr/feed/searchTags.json
··· 1 + { 2 + "lexicon": 1, 3 + "id": "social.clippr.actor.searchTags", 4 + "defs": { 5 + "main": { 6 + "type": "query", 7 + "description": "Find tags matching search criteria. Does not require auth.", 8 + "parameters": { 9 + "type": "params", 10 + "required": [ 11 + "q" 12 + ], 13 + "properties": { 14 + "q": { 15 + "type": "string", 16 + "description": "Search query string" 17 + }, 18 + "limit": { 19 + "type": "integer", 20 + "minimum": 1, 21 + "maximum": 100, 22 + "default": 25, 23 + "description": "How many tags to return in the query output" 24 + }, 25 + "actor": { 26 + "type": "string", 27 + "format": "at-identifier", 28 + "description": "An actor to filter results to" 29 + }, 30 + "cursor": { 31 + "type": "string", 32 + "description": "A parameter to paginate results" 33 + } 34 + } 35 + }, 36 + "output": { 37 + "encoding": "application/json", 38 + "schema": { 39 + "type": "object", 40 + "required": [ 41 + "tags" 42 + ], 43 + "properties": { 44 + "cursor": { 45 + "type": "string", 46 + "description": "A parameter to paginate results" 47 + }, 48 + "tags": { 49 + "type": "array", 50 + "items": { 51 + "type": "ref", 52 + "ref": "social.clippr.feed.defs#tagView" 53 + }, 54 + "description": "A list of tags and their associated details" 55 + } 56 + } 57 + } 58 + } 59 + } 60 + } 61 + }
+47 -39
lexdocs/social/clippr/feed/tag.json
··· 1 1 { 2 - "lexicon": 1, 3 - "id": "social.clippr.feed.tag", 4 - "defs": { 5 - "main": { 6 - "type": "record", 7 - "description": "A record containing a bookmark tag for organization.", 8 - "key": "any", 9 - "record": { 10 - "type": "object", 11 - "required": [ 12 - "name", 13 - "createdAt" 14 - ], 15 - "properties": { 16 - "name": { 17 - "type": "string", 18 - "description": "A de-duplicated string containing the name of the tag.", 19 - "minGraphemes": 1, 20 - "minLength": 10, 21 - "maxGraphemes": 64, 22 - "maxLength": 640 23 - }, 24 - "color": { 25 - "type": "string", 26 - "description": "A hexadecimal color code.", 27 - "minGraphemes": 4, 28 - "minLength": 40, 29 - "maxGraphemes": 7, 30 - "maxLength": 70 31 - }, 32 - "createdAt": { 33 - "type": "string", 34 - "description": "A client-defined timestamp for the creation of the tag.", 35 - "format": "datetime" 36 - } 37 - } 38 - } 39 - } 40 - } 2 + "lexicon": 1, 3 + "id": "social.clippr.feed.tag", 4 + "defs": { 5 + "main": { 6 + "type": "record", 7 + "description": "A record containing a bookmark tag for organization.", 8 + "key": "any", 9 + "record": { 10 + "type": "object", 11 + "required": [ 12 + "name", 13 + "createdAt" 14 + ], 15 + "properties": { 16 + "name": { 17 + "type": "string", 18 + "minGraphemes": 1, 19 + "minLength": 10, 20 + "maxGraphemes": 64, 21 + "maxLength": 640, 22 + "description": "A de-duplicated string containing the name of the tag" 23 + }, 24 + "color": { 25 + "type": "string", 26 + "minGraphemes": 4, 27 + "minLength": 40, 28 + "maxGraphemes": 7, 29 + "maxLength": 70, 30 + "description": "A hexadecimal color code" 31 + }, 32 + "description": { 33 + "type": "string", 34 + "minGraphemes": 1, 35 + "minLength": 10, 36 + "maxGraphemes": 5000, 37 + "maxLength": 50000, 38 + "description": "A description of the tag for additional context" 39 + }, 40 + "createdAt": { 41 + "type": "string", 42 + "format": "datetime", 43 + "description": "A client-defined timestamp for the creation of the tag" 44 + } 45 + } 46 + } 47 + } 48 + } 41 49 }