back round 0 view raw

Add schema for Lexicon-defined API #3

closed
opened by hexmani.ac targeting main from lexicons-extension

This will build the foundations for a basic Lexicon-defined API to be used by the backend. Right now I'm focusing solely on implementing ways to get indexed content from the database as well as a basic "preferences" system similar to was Bluesky has, mainly for expanding private preferences in the future once we move to the frontend. There are also some search query lexicons in there, just for good measure.

options
unified split
Changed files
+31
lexdocs
social
clippr
actor
defs.json
feed
defs.json
getClips.json
getProfileFeed.json
getTagList.json
getTags.json
searchClips.json
searchTags.json
+7
lexdocs/social/clippr/feed/defs.json 
···

       

       
1

       
+

       
{


     

       

       
2

       
+

       
  "lexicon": 1,


     

       

       
3

       
+

       
  "id": "social.clippr.feed.defs",


     

       

       
4

       
+

       
  "defs": {


     

       

       
5

       
+

       



     

       

       
6

       
+

       
  }


     

       

       
7

       
+

       
}
lexdocs/social/clippr/feed/getClips.json
lexdocs/social/clippr/feed/getProfileFeed.json
lexdocs/social/clippr/feed/getTagList.json
lexdocs/social/clippr/feed/getTags.json
lexdocs/social/clippr/feed/searchClips.json
lexdocs/social/clippr/feed/searchTags.json
+24
lexdocs/social/clippr/actor/defs.json 
···

       
38

       
38

       
 

       
          "format": "datetime"


     

       
39

       
39

       
 

       
        }


     

       
40

       
40

       
 

       
      }


     

       

       
41

       
+

       
    },


     

       

       
42

       
+

       
    "preferences": {


     

       

       
43

       
+

       
      "type": "array",


     

       

       
44

       
+

       
      "description": "An array of preference types",


     

       

       
45

       
+

       
      "refs": [


     

       

       
46

       
+

       
        "#publishingScopesPref"


     

       

       
47

       
+

       
      ]


     

       

       
48

       
+

       
    },


     

       

       
49

       
+

       
    "publishingScopesPref": {


     

       

       
50

       
+

       
      "type": "object",


     

       

       
51

       
+

       
      "description": "Preferences for an user's publishing scopes",


     

       

       
52

       
+

       
      "required": [


     

       

       
53

       
+

       
        "defaultScope"


     

       

       
54

       
+

       
      ],


     

       

       
55

       
+

       
      "properties": {


     

       

       
56

       
+

       
        "defaultScope": {


     

       

       
57

       
+

       
          "type": "string",


     

       

       
58

       
+

       
          "knownValues": [


     

       

       
59

       
+

       
            "public",


     

       

       
60

       
+

       
            "unlisted"


     

       

       
61

       
+

       
          ],


     

       

       
62

       
+

       
          "description": "What publishing scope to mark a clip as by default."


     

       

       
63

       
+

       
        }


     

       

       
64

       
+

       
      }


     

       
41

       
65

       
 

       
    }


     

       
42

       
66

       
 

       
  }


     

       
43

       
67

       
 

       
}