perlsky is a Perl 5 implementation of an AT Protocol Personal Data Server.
Initialize project scaffold and vendored lexicons
+3973
100 changed files
share
lexicons
com
atproto
admin
identity
lexicon
moderation
repo
server
sync
tools
+19
.gitignore
+19
.gitignore
···
1
1
+
.build/
2
2
+
.cpanm/
3
3
+
.local/
4
4
+
.tools/
5
5
+
.prove
6
6
+
blib/
7
7
+
cover_db/
8
8
+
data/runtime/
9
9
+
local/
10
10
+
nytprof.out
11
11
+
pm_to_blib
12
12
+
*.sqlite
13
13
+
*.sqlite-shm
14
14
+
*.sqlite-wal
15
15
+
*.tar.gz
16
16
+
*.tmp
17
17
+
*.swp
18
18
+
.DS_Store
19
19
+
.vendor/
+16
README.md
+16
README.md
···
1
1
+
# perlds
2
2
+
3
3
+
`perlds` is a Perl 5 Personal Data Server for the AT Protocol / Bluesky ecosystem.
4
4
+
5
5
+
The project goal is to expose the current external `com.atproto.*` PDS-facing XRPC
6
6
+
surface from the official lexicons, with a local SQLite-backed implementation for:
7
7
+
8
8
+
- account and session management
9
9
+
- DID/handle identity resolution
10
10
+
- record and blob storage
11
11
+
- DAG-CBOR block storage
12
12
+
- Merkle Search Tree repository state
13
13
+
- CAR export/import and sync endpoints
14
14
+
15
15
+
The codebase intentionally keeps protocol metadata close to the source by deriving
16
16
+
its route inventory from the upstream lexicons vendored during development.
+8
cpanfile
+8
cpanfile
+11
etc/perlds.example.json
+11
etc/perlds.example.json
···
1
1
+
{
2
2
+
"host": "127.0.0.1",
3
3
+
"port": 7755,
4
4
+
"base_url": "http://127.0.0.1:7755",
5
5
+
"service_did_method": "did:web",
6
6
+
"service_handle_domain": "localhost",
7
7
+
"jwt_secret": "change-me",
8
8
+
"admin_password": "change-me-too",
9
9
+
"data_dir": "data/runtime",
10
10
+
"db_path": "data/runtime/perlds.sqlite"
11
11
+
}
+71
share/lexicons/com/atproto/admin/defs.json
+71
share/lexicons/com/atproto/admin/defs.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.defs",
4
4
+
"defs": {
5
5
+
"statusAttr": {
6
6
+
"type": "object",
7
7
+
"required": ["applied"],
8
8
+
"properties": {
9
9
+
"applied": { "type": "boolean" },
10
10
+
"ref": { "type": "string" }
11
11
+
}
12
12
+
},
13
13
+
"accountView": {
14
14
+
"type": "object",
15
15
+
"required": ["did", "handle", "indexedAt"],
16
16
+
"properties": {
17
17
+
"did": { "type": "string", "format": "did" },
18
18
+
"handle": { "type": "string", "format": "handle" },
19
19
+
"email": { "type": "string" },
20
20
+
"relatedRecords": { "type": "array", "items": { "type": "unknown" } },
21
21
+
"indexedAt": { "type": "string", "format": "datetime" },
22
22
+
"invitedBy": {
23
23
+
"type": "ref",
24
24
+
"ref": "com.atproto.server.defs#inviteCode"
25
25
+
},
26
26
+
"invites": {
27
27
+
"type": "array",
28
28
+
"items": {
29
29
+
"type": "ref",
30
30
+
"ref": "com.atproto.server.defs#inviteCode"
31
31
+
}
32
32
+
},
33
33
+
"invitesDisabled": { "type": "boolean" },
34
34
+
"emailConfirmedAt": { "type": "string", "format": "datetime" },
35
35
+
"inviteNote": { "type": "string" },
36
36
+
"deactivatedAt": { "type": "string", "format": "datetime" },
37
37
+
"threatSignatures": {
38
38
+
"type": "array",
39
39
+
"items": {
40
40
+
"type": "ref",
41
41
+
"ref": "#threatSignature"
42
42
+
}
43
43
+
}
44
44
+
}
45
45
+
},
46
46
+
"repoRef": {
47
47
+
"type": "object",
48
48
+
"required": ["did"],
49
49
+
"properties": {
50
50
+
"did": { "type": "string", "format": "did" }
51
51
+
}
52
52
+
},
53
53
+
"repoBlobRef": {
54
54
+
"type": "object",
55
55
+
"required": ["did", "cid"],
56
56
+
"properties": {
57
57
+
"did": { "type": "string", "format": "did" },
58
58
+
"cid": { "type": "string", "format": "cid" },
59
59
+
"recordUri": { "type": "string", "format": "at-uri" }
60
60
+
}
61
61
+
},
62
62
+
"threatSignature": {
63
63
+
"type": "object",
64
64
+
"required": ["property", "value"],
65
65
+
"properties": {
66
66
+
"property": { "type": "string" },
67
67
+
"value": { "type": "string" }
68
68
+
}
69
69
+
}
70
70
+
}
71
71
+
}
+20
share/lexicons/com/atproto/admin/deleteAccount.json
+20
share/lexicons/com/atproto/admin/deleteAccount.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.deleteAccount",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Delete a user account as an administrator.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["did"],
13
13
+
"properties": {
14
14
+
"did": { "type": "string", "format": "did" }
15
15
+
}
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
+24
share/lexicons/com/atproto/admin/disableAccountInvites.json
+24
share/lexicons/com/atproto/admin/disableAccountInvites.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.disableAccountInvites",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Disable an account from receiving new invite codes, but does not invalidate existing codes.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["account"],
13
13
+
"properties": {
14
14
+
"account": { "type": "string", "format": "did" },
15
15
+
"note": {
16
16
+
"type": "string",
17
17
+
"description": "Optional reason for disabled invites."
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
}
+26
share/lexicons/com/atproto/admin/disableInviteCodes.json
+26
share/lexicons/com/atproto/admin/disableInviteCodes.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.disableInviteCodes",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Disable some set of codes and/or all codes associated with a set of users.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"properties": {
13
13
+
"codes": {
14
14
+
"type": "array",
15
15
+
"items": { "type": "string" }
16
16
+
},
17
17
+
"accounts": {
18
18
+
"type": "array",
19
19
+
"items": { "type": "string" }
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
}
25
25
+
}
26
26
+
}
+24
share/lexicons/com/atproto/admin/enableAccountInvites.json
+24
share/lexicons/com/atproto/admin/enableAccountInvites.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.enableAccountInvites",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Re-enable an account's ability to receive invite codes.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["account"],
13
13
+
"properties": {
14
14
+
"account": { "type": "string", "format": "did" },
15
15
+
"note": {
16
16
+
"type": "string",
17
17
+
"description": "Optional reason for enabled invites."
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
}
+24
share/lexicons/com/atproto/admin/getAccountInfo.json
+24
share/lexicons/com/atproto/admin/getAccountInfo.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.getAccountInfo",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get details about an account.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did"],
11
11
+
"properties": {
12
12
+
"did": { "type": "string", "format": "did" }
13
13
+
}
14
14
+
},
15
15
+
"output": {
16
16
+
"encoding": "application/json",
17
17
+
"schema": {
18
18
+
"type": "ref",
19
19
+
"ref": "com.atproto.admin.defs#accountView"
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
}
+36
share/lexicons/com/atproto/admin/getAccountInfos.json
+36
share/lexicons/com/atproto/admin/getAccountInfos.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.getAccountInfos",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get details about some accounts.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["dids"],
11
11
+
"properties": {
12
12
+
"dids": {
13
13
+
"type": "array",
14
14
+
"items": { "type": "string", "format": "did" }
15
15
+
}
16
16
+
}
17
17
+
},
18
18
+
"output": {
19
19
+
"encoding": "application/json",
20
20
+
"schema": {
21
21
+
"type": "object",
22
22
+
"required": ["infos"],
23
23
+
"properties": {
24
24
+
"infos": {
25
25
+
"type": "array",
26
26
+
"items": {
27
27
+
"type": "ref",
28
28
+
"ref": "com.atproto.admin.defs#accountView"
29
29
+
}
30
30
+
}
31
31
+
}
32
32
+
}
33
33
+
}
34
34
+
}
35
35
+
}
36
36
+
}
+44
share/lexicons/com/atproto/admin/getInviteCodes.json
+44
share/lexicons/com/atproto/admin/getInviteCodes.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.getInviteCodes",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get an admin view of invite codes.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"sort": {
12
12
+
"type": "string",
13
13
+
"knownValues": ["recent", "usage"],
14
14
+
"default": "recent"
15
15
+
},
16
16
+
"limit": {
17
17
+
"type": "integer",
18
18
+
"minimum": 1,
19
19
+
"maximum": 500,
20
20
+
"default": 100
21
21
+
},
22
22
+
"cursor": { "type": "string" }
23
23
+
}
24
24
+
},
25
25
+
"output": {
26
26
+
"encoding": "application/json",
27
27
+
"schema": {
28
28
+
"type": "object",
29
29
+
"required": ["codes"],
30
30
+
"properties": {
31
31
+
"cursor": { "type": "string" },
32
32
+
"codes": {
33
33
+
"type": "array",
34
34
+
"items": {
35
35
+
"type": "ref",
36
36
+
"ref": "com.atproto.server.defs#inviteCode"
37
37
+
}
38
38
+
}
39
39
+
}
40
40
+
}
41
41
+
}
42
42
+
}
43
43
+
}
44
44
+
}
+43
share/lexicons/com/atproto/admin/getSubjectStatus.json
+43
share/lexicons/com/atproto/admin/getSubjectStatus.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.getSubjectStatus",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get the service-specific admin status of a subject (account, record, or blob).",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"did": { "type": "string", "format": "did" },
12
12
+
"uri": { "type": "string", "format": "at-uri" },
13
13
+
"blob": { "type": "string", "format": "cid" }
14
14
+
}
15
15
+
},
16
16
+
"output": {
17
17
+
"encoding": "application/json",
18
18
+
"schema": {
19
19
+
"type": "object",
20
20
+
"required": ["subject"],
21
21
+
"properties": {
22
22
+
"subject": {
23
23
+
"type": "union",
24
24
+
"refs": [
25
25
+
"com.atproto.admin.defs#repoRef",
26
26
+
"com.atproto.repo.strongRef",
27
27
+
"com.atproto.admin.defs#repoBlobRef"
28
28
+
]
29
29
+
},
30
30
+
"takedown": {
31
31
+
"type": "ref",
32
32
+
"ref": "com.atproto.admin.defs#statusAttr"
33
33
+
},
34
34
+
"deactivated": {
35
35
+
"type": "ref",
36
36
+
"ref": "com.atproto.admin.defs#statusAttr"
37
37
+
}
38
38
+
}
39
39
+
}
40
40
+
}
41
41
+
}
42
42
+
}
43
43
+
}
+40
share/lexicons/com/atproto/admin/searchAccounts.json
+40
share/lexicons/com/atproto/admin/searchAccounts.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.searchAccounts",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get list of accounts that matches your search query.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"email": { "type": "string" },
12
12
+
"cursor": { "type": "string" },
13
13
+
"limit": {
14
14
+
"type": "integer",
15
15
+
"minimum": 1,
16
16
+
"maximum": 100,
17
17
+
"default": 50
18
18
+
}
19
19
+
}
20
20
+
},
21
21
+
"output": {
22
22
+
"encoding": "application/json",
23
23
+
"schema": {
24
24
+
"type": "object",
25
25
+
"required": ["accounts"],
26
26
+
"properties": {
27
27
+
"cursor": { "type": "string" },
28
28
+
"accounts": {
29
29
+
"type": "array",
30
30
+
"items": {
31
31
+
"type": "ref",
32
32
+
"ref": "com.atproto.admin.defs#accountView"
33
33
+
}
34
34
+
}
35
35
+
}
36
36
+
}
37
37
+
}
38
38
+
}
39
39
+
}
40
40
+
}
+37
share/lexicons/com/atproto/admin/sendEmail.json
+37
share/lexicons/com/atproto/admin/sendEmail.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.sendEmail",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Send email to a user's account email address.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["recipientDid", "content", "senderDid"],
13
13
+
"properties": {
14
14
+
"recipientDid": { "type": "string", "format": "did" },
15
15
+
"content": { "type": "string" },
16
16
+
"subject": { "type": "string" },
17
17
+
"senderDid": { "type": "string", "format": "did" },
18
18
+
"comment": {
19
19
+
"type": "string",
20
20
+
"description": "Additional comment by the sender that won't be used in the email itself but helpful to provide more context for moderators/reviewers"
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
},
25
25
+
"output": {
26
26
+
"encoding": "application/json",
27
27
+
"schema": {
28
28
+
"type": "object",
29
29
+
"required": ["sent"],
30
30
+
"properties": {
31
31
+
"sent": { "type": "boolean" }
32
32
+
}
33
33
+
}
34
34
+
}
35
35
+
}
36
36
+
}
37
37
+
}
+25
share/lexicons/com/atproto/admin/updateAccountEmail.json
+25
share/lexicons/com/atproto/admin/updateAccountEmail.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.updateAccountEmail",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Administrative action to update an account's email.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["account", "email"],
13
13
+
"properties": {
14
14
+
"account": {
15
15
+
"type": "string",
16
16
+
"format": "at-identifier",
17
17
+
"description": "The handle or DID of the repo."
18
18
+
},
19
19
+
"email": { "type": "string" }
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
}
25
25
+
}
+21
share/lexicons/com/atproto/admin/updateAccountHandle.json
+21
share/lexicons/com/atproto/admin/updateAccountHandle.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.updateAccountHandle",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Administrative action to update an account's handle.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["did", "handle"],
13
13
+
"properties": {
14
14
+
"did": { "type": "string", "format": "did" },
15
15
+
"handle": { "type": "string", "format": "handle" }
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
+21
share/lexicons/com/atproto/admin/updateAccountPassword.json
+21
share/lexicons/com/atproto/admin/updateAccountPassword.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.updateAccountPassword",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Update the password for a user account as an administrator.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["did", "password"],
13
13
+
"properties": {
14
14
+
"did": { "type": "string", "format": "did" },
15
15
+
"password": { "type": "string" }
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
+25
share/lexicons/com/atproto/admin/updateAccountSigningKey.json
+25
share/lexicons/com/atproto/admin/updateAccountSigningKey.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.updateAccountSigningKey",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Administrative action to update an account's signing key in their Did document.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["did", "signingKey"],
13
13
+
"properties": {
14
14
+
"did": { "type": "string", "format": "did" },
15
15
+
"signingKey": {
16
16
+
"type": "string",
17
17
+
"format": "did",
18
18
+
"description": "Did-key formatted public key"
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
}
25
25
+
}
+56
share/lexicons/com/atproto/admin/updateSubjectStatus.json
+56
share/lexicons/com/atproto/admin/updateSubjectStatus.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.admin.updateSubjectStatus",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Update the service-specific admin status of a subject (account, record, or blob).",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["subject"],
13
13
+
"properties": {
14
14
+
"subject": {
15
15
+
"type": "union",
16
16
+
"refs": [
17
17
+
"com.atproto.admin.defs#repoRef",
18
18
+
"com.atproto.repo.strongRef",
19
19
+
"com.atproto.admin.defs#repoBlobRef"
20
20
+
]
21
21
+
},
22
22
+
"takedown": {
23
23
+
"type": "ref",
24
24
+
"ref": "com.atproto.admin.defs#statusAttr"
25
25
+
},
26
26
+
"deactivated": {
27
27
+
"type": "ref",
28
28
+
"ref": "com.atproto.admin.defs#statusAttr"
29
29
+
}
30
30
+
}
31
31
+
}
32
32
+
},
33
33
+
"output": {
34
34
+
"encoding": "application/json",
35
35
+
"schema": {
36
36
+
"type": "object",
37
37
+
"required": ["subject"],
38
38
+
"properties": {
39
39
+
"subject": {
40
40
+
"type": "union",
41
41
+
"refs": [
42
42
+
"com.atproto.admin.defs#repoRef",
43
43
+
"com.atproto.repo.strongRef",
44
44
+
"com.atproto.admin.defs#repoBlobRef"
45
45
+
]
46
46
+
},
47
47
+
"takedown": {
48
48
+
"type": "ref",
49
49
+
"ref": "com.atproto.admin.defs#statusAttr"
50
50
+
}
51
51
+
}
52
52
+
}
53
53
+
}
54
54
+
}
55
55
+
}
56
56
+
}
+22
share/lexicons/com/atproto/identity/defs.json
+22
share/lexicons/com/atproto/identity/defs.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.defs",
4
4
+
"defs": {
5
5
+
"identityInfo": {
6
6
+
"type": "object",
7
7
+
"required": ["did", "handle", "didDoc"],
8
8
+
"properties": {
9
9
+
"did": { "type": "string", "format": "did" },
10
10
+
"handle": {
11
11
+
"type": "string",
12
12
+
"format": "handle",
13
13
+
"description": "The validated handle of the account; or 'handle.invalid' if the handle did not bi-directionally match the DID document."
14
14
+
},
15
15
+
"didDoc": {
16
16
+
"type": "unknown",
17
17
+
"description": "The complete DID document for the identity."
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
+29
share/lexicons/com/atproto/identity/getRecommendedDidCredentials.json
+29
share/lexicons/com/atproto/identity/getRecommendedDidCredentials.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.getRecommendedDidCredentials",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Describe the credentials that should be included in the DID doc of an account that is migrating to this service.",
8
8
+
"output": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"properties": {
13
13
+
"rotationKeys": {
14
14
+
"description": "Recommended rotation keys for PLC dids. Should be undefined (or ignored) for did:webs.",
15
15
+
"type": "array",
16
16
+
"items": { "type": "string" }
17
17
+
},
18
18
+
"alsoKnownAs": {
19
19
+
"type": "array",
20
20
+
"items": { "type": "string" }
21
21
+
},
22
22
+
"verificationMethods": { "type": "unknown" },
23
23
+
"services": { "type": "unknown" }
24
24
+
}
25
25
+
}
26
26
+
}
27
27
+
}
28
28
+
}
29
29
+
}
+44
share/lexicons/com/atproto/identity/refreshIdentity.json
+44
share/lexicons/com/atproto/identity/refreshIdentity.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.refreshIdentity",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Request that the server re-resolve an identity (DID and handle). The server may ignore this request, or require authentication, depending on the role, implementation, and policy of the server.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["identifier"],
13
13
+
"properties": {
14
14
+
"identifier": {
15
15
+
"type": "string",
16
16
+
"format": "at-identifier"
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
},
21
21
+
"output": {
22
22
+
"encoding": "application/json",
23
23
+
"schema": {
24
24
+
"type": "ref",
25
25
+
"ref": "com.atproto.identity.defs#identityInfo"
26
26
+
}
27
27
+
},
28
28
+
"errors": [
29
29
+
{
30
30
+
"name": "HandleNotFound",
31
31
+
"description": "The resolution process confirmed that the handle does not resolve to any DID."
32
32
+
},
33
33
+
{
34
34
+
"name": "DidNotFound",
35
35
+
"description": "The DID resolution process confirmed that there is no current DID."
36
36
+
},
37
37
+
{
38
38
+
"name": "DidDeactivated",
39
39
+
"description": "The DID previously existed, but has been deactivated."
40
40
+
}
41
41
+
]
42
42
+
}
43
43
+
}
44
44
+
}
+10
share/lexicons/com/atproto/identity/requestPlcOperationSignature.json
+10
share/lexicons/com/atproto/identity/requestPlcOperationSignature.json
+44
share/lexicons/com/atproto/identity/resolveDid.json
+44
share/lexicons/com/atproto/identity/resolveDid.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.resolveDid",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Resolves DID to DID document. Does not bi-directionally verify handle.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "DID to resolve."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"required": ["didDoc"],
24
24
+
"properties": {
25
25
+
"didDoc": {
26
26
+
"type": "unknown",
27
27
+
"description": "The complete DID document for the identity."
28
28
+
}
29
29
+
}
30
30
+
}
31
31
+
},
32
32
+
"errors": [
33
33
+
{
34
34
+
"name": "DidNotFound",
35
35
+
"description": "The DID resolution process confirmed that there is no current DID."
36
36
+
},
37
37
+
{
38
38
+
"name": "DidDeactivated",
39
39
+
"description": "The DID previously existed, but has been deactivated."
40
40
+
}
41
41
+
]
42
42
+
}
43
43
+
}
44
44
+
}
+37
share/lexicons/com/atproto/identity/resolveHandle.json
+37
share/lexicons/com/atproto/identity/resolveHandle.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.resolveHandle",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Resolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["handle"],
11
11
+
"properties": {
12
12
+
"handle": {
13
13
+
"type": "string",
14
14
+
"format": "handle",
15
15
+
"description": "The handle to resolve."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"required": ["did"],
24
24
+
"properties": {
25
25
+
"did": { "type": "string", "format": "did" }
26
26
+
}
27
27
+
}
28
28
+
},
29
29
+
"errors": [
30
30
+
{
31
31
+
"name": "HandleNotFound",
32
32
+
"description": "The resolution process confirmed that the handle does not resolve to any DID."
33
33
+
}
34
34
+
]
35
35
+
}
36
36
+
}
37
37
+
}
+42
share/lexicons/com/atproto/identity/resolveIdentity.json
+42
share/lexicons/com/atproto/identity/resolveIdentity.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.resolveIdentity",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Resolves an identity (DID or Handle) to a full identity (DID document and verified handle).",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["identifier"],
11
11
+
"properties": {
12
12
+
"identifier": {
13
13
+
"type": "string",
14
14
+
"format": "at-identifier",
15
15
+
"description": "Handle or DID to resolve."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "ref",
23
23
+
"ref": "com.atproto.identity.defs#identityInfo"
24
24
+
}
25
25
+
},
26
26
+
"errors": [
27
27
+
{
28
28
+
"name": "HandleNotFound",
29
29
+
"description": "The resolution process confirmed that the handle does not resolve to any DID."
30
30
+
},
31
31
+
{
32
32
+
"name": "DidNotFound",
33
33
+
"description": "The DID resolution process confirmed that there is no current DID."
34
34
+
},
35
35
+
{
36
36
+
"name": "DidDeactivated",
37
37
+
"description": "The DID previously existed, but has been deactivated."
38
38
+
}
39
39
+
]
40
40
+
}
41
41
+
}
42
42
+
}
+45
share/lexicons/com/atproto/identity/signPlcOperation.json
+45
share/lexicons/com/atproto/identity/signPlcOperation.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.signPlcOperation",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Signs a PLC operation to update some value(s) in the requesting DID's document.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"properties": {
13
13
+
"token": {
14
14
+
"description": "A token received through com.atproto.identity.requestPlcOperationSignature",
15
15
+
"type": "string"
16
16
+
},
17
17
+
"rotationKeys": {
18
18
+
"type": "array",
19
19
+
"items": { "type": "string" }
20
20
+
},
21
21
+
"alsoKnownAs": {
22
22
+
"type": "array",
23
23
+
"items": { "type": "string" }
24
24
+
},
25
25
+
"verificationMethods": { "type": "unknown" },
26
26
+
"services": { "type": "unknown" }
27
27
+
}
28
28
+
}
29
29
+
},
30
30
+
"output": {
31
31
+
"encoding": "application/json",
32
32
+
"schema": {
33
33
+
"type": "object",
34
34
+
"required": ["operation"],
35
35
+
"properties": {
36
36
+
"operation": {
37
37
+
"type": "unknown",
38
38
+
"description": "A signed DID PLC operation."
39
39
+
}
40
40
+
}
41
41
+
}
42
42
+
}
43
43
+
}
44
44
+
}
45
45
+
}
+20
share/lexicons/com/atproto/identity/submitPlcOperation.json
+20
share/lexicons/com/atproto/identity/submitPlcOperation.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.submitPlcOperation",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Validates a PLC operation to ensure that it doesn't violate a service's constraints or get the identity into a bad state, then submits it to the PLC registry",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["operation"],
13
13
+
"properties": {
14
14
+
"operation": { "type": "unknown" }
15
15
+
}
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
+24
share/lexicons/com/atproto/identity/updateHandle.json
+24
share/lexicons/com/atproto/identity/updateHandle.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.identity.updateHandle",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["handle"],
13
13
+
"properties": {
14
14
+
"handle": {
15
15
+
"type": "string",
16
16
+
"format": "handle",
17
17
+
"description": "The new handle."
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
}
+156
share/lexicons/com/atproto/label/defs.json
+156
share/lexicons/com/atproto/label/defs.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.label.defs",
4
4
+
"defs": {
5
5
+
"label": {
6
6
+
"type": "object",
7
7
+
"description": "Metadata tag on an atproto resource (eg, repo or record).",
8
8
+
"required": ["src", "uri", "val", "cts"],
9
9
+
"properties": {
10
10
+
"ver": {
11
11
+
"type": "integer",
12
12
+
"description": "The AT Protocol version of the label object."
13
13
+
},
14
14
+
"src": {
15
15
+
"type": "string",
16
16
+
"format": "did",
17
17
+
"description": "DID of the actor who created this label."
18
18
+
},
19
19
+
"uri": {
20
20
+
"type": "string",
21
21
+
"format": "uri",
22
22
+
"description": "AT URI of the record, repository (account), or other resource that this label applies to."
23
23
+
},
24
24
+
"cid": {
25
25
+
"type": "string",
26
26
+
"format": "cid",
27
27
+
"description": "Optionally, CID specifying the specific version of 'uri' resource this label applies to."
28
28
+
},
29
29
+
"val": {
30
30
+
"type": "string",
31
31
+
"maxLength": 128,
32
32
+
"description": "The short string name of the value or type of this label."
33
33
+
},
34
34
+
"neg": {
35
35
+
"type": "boolean",
36
36
+
"description": "If true, this is a negation label, overwriting a previous label."
37
37
+
},
38
38
+
"cts": {
39
39
+
"type": "string",
40
40
+
"format": "datetime",
41
41
+
"description": "Timestamp when this label was created."
42
42
+
},
43
43
+
"exp": {
44
44
+
"type": "string",
45
45
+
"format": "datetime",
46
46
+
"description": "Timestamp at which this label expires (no longer applies)."
47
47
+
},
48
48
+
"sig": {
49
49
+
"type": "bytes",
50
50
+
"description": "Signature of dag-cbor encoded label."
51
51
+
}
52
52
+
}
53
53
+
},
54
54
+
"selfLabels": {
55
55
+
"type": "object",
56
56
+
"description": "Metadata tags on an atproto record, published by the author within the record.",
57
57
+
"required": ["values"],
58
58
+
"properties": {
59
59
+
"values": {
60
60
+
"type": "array",
61
61
+
"items": { "type": "ref", "ref": "#selfLabel" },
62
62
+
"maxLength": 10
63
63
+
}
64
64
+
}
65
65
+
},
66
66
+
"selfLabel": {
67
67
+
"type": "object",
68
68
+
"description": "Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.",
69
69
+
"required": ["val"],
70
70
+
"properties": {
71
71
+
"val": {
72
72
+
"type": "string",
73
73
+
"maxLength": 128,
74
74
+
"description": "The short string name of the value or type of this label."
75
75
+
}
76
76
+
}
77
77
+
},
78
78
+
"labelValueDefinition": {
79
79
+
"type": "object",
80
80
+
"description": "Declares a label value and its expected interpretations and behaviors.",
81
81
+
"required": ["identifier", "severity", "blurs", "locales"],
82
82
+
"properties": {
83
83
+
"identifier": {
84
84
+
"type": "string",
85
85
+
"description": "The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).",
86
86
+
"maxLength": 100,
87
87
+
"maxGraphemes": 100
88
88
+
},
89
89
+
"severity": {
90
90
+
"type": "string",
91
91
+
"description": "How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.",
92
92
+
"knownValues": ["inform", "alert", "none"]
93
93
+
},
94
94
+
"blurs": {
95
95
+
"type": "string",
96
96
+
"description": "What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.",
97
97
+
"knownValues": ["content", "media", "none"]
98
98
+
},
99
99
+
"defaultSetting": {
100
100
+
"type": "string",
101
101
+
"description": "The default setting for this label.",
102
102
+
"knownValues": ["ignore", "warn", "hide"],
103
103
+
"default": "warn"
104
104
+
},
105
105
+
"adultOnly": {
106
106
+
"type": "boolean",
107
107
+
"description": "Does the user need to have adult content enabled in order to configure this label?"
108
108
+
},
109
109
+
"locales": {
110
110
+
"type": "array",
111
111
+
"items": { "type": "ref", "ref": "#labelValueDefinitionStrings" }
112
112
+
}
113
113
+
}
114
114
+
},
115
115
+
"labelValueDefinitionStrings": {
116
116
+
"type": "object",
117
117
+
"description": "Strings which describe the label in the UI, localized into a specific language.",
118
118
+
"required": ["lang", "name", "description"],
119
119
+
"properties": {
120
120
+
"lang": {
121
121
+
"type": "string",
122
122
+
"description": "The code of the language these strings are written in.",
123
123
+
"format": "language"
124
124
+
},
125
125
+
"name": {
126
126
+
"type": "string",
127
127
+
"description": "A short human-readable name for the label.",
128
128
+
"maxGraphemes": 64,
129
129
+
"maxLength": 640
130
130
+
},
131
131
+
"description": {
132
132
+
"type": "string",
133
133
+
"description": "A longer description of what the label means and why it might be applied.",
134
134
+
"maxGraphemes": 10000,
135
135
+
"maxLength": 100000
136
136
+
}
137
137
+
}
138
138
+
},
139
139
+
"labelValue": {
140
140
+
"type": "string",
141
141
+
"knownValues": [
142
142
+
"!hide",
143
143
+
"!no-promote",
144
144
+
"!warn",
145
145
+
"!no-unauthenticated",
146
146
+
"dmca-violation",
147
147
+
"doxxing",
148
148
+
"porn",
149
149
+
"sexual",
150
150
+
"nudity",
151
151
+
"nsfl",
152
152
+
"gore"
153
153
+
]
154
154
+
}
155
155
+
}
156
156
+
}
+47
share/lexicons/com/atproto/label/queryLabels.json
+47
share/lexicons/com/atproto/label/queryLabels.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.label.queryLabels",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["uriPatterns"],
11
11
+
"properties": {
12
12
+
"uriPatterns": {
13
13
+
"type": "array",
14
14
+
"items": { "type": "string" },
15
15
+
"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."
16
16
+
},
17
17
+
"sources": {
18
18
+
"type": "array",
19
19
+
"items": { "type": "string", "format": "did" },
20
20
+
"description": "Optional list of label sources (DIDs) to filter on."
21
21
+
},
22
22
+
"limit": {
23
23
+
"type": "integer",
24
24
+
"minimum": 1,
25
25
+
"maximum": 250,
26
26
+
"default": 50
27
27
+
},
28
28
+
"cursor": { "type": "string" }
29
29
+
}
30
30
+
},
31
31
+
"output": {
32
32
+
"encoding": "application/json",
33
33
+
"schema": {
34
34
+
"type": "object",
35
35
+
"required": ["labels"],
36
36
+
"properties": {
37
37
+
"cursor": { "type": "string" },
38
38
+
"labels": {
39
39
+
"type": "array",
40
40
+
"items": { "type": "ref", "ref": "com.atproto.label.defs#label" }
41
41
+
}
42
42
+
}
43
43
+
}
44
44
+
}
45
45
+
}
46
46
+
}
47
47
+
}
+50
share/lexicons/com/atproto/label/subscribeLabels.json
+50
share/lexicons/com/atproto/label/subscribeLabels.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.label.subscribeLabels",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "subscription",
7
7
+
"description": "Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"cursor": {
12
12
+
"type": "integer",
13
13
+
"description": "The last known event seq number to backfill from."
14
14
+
}
15
15
+
}
16
16
+
},
17
17
+
"message": {
18
18
+
"schema": {
19
19
+
"type": "union",
20
20
+
"refs": ["#labels", "#info"]
21
21
+
}
22
22
+
},
23
23
+
"errors": [{ "name": "FutureCursor" }]
24
24
+
},
25
25
+
"labels": {
26
26
+
"type": "object",
27
27
+
"required": ["seq", "labels"],
28
28
+
"properties": {
29
29
+
"seq": { "type": "integer" },
30
30
+
"labels": {
31
31
+
"type": "array",
32
32
+
"items": { "type": "ref", "ref": "com.atproto.label.defs#label" }
33
33
+
}
34
34
+
}
35
35
+
},
36
36
+
"info": {
37
37
+
"type": "object",
38
38
+
"required": ["name"],
39
39
+
"properties": {
40
40
+
"name": {
41
41
+
"type": "string",
42
42
+
"knownValues": ["OutdatedCursor"]
43
43
+
},
44
44
+
"message": {
45
45
+
"type": "string"
46
46
+
}
47
47
+
}
48
48
+
}
49
49
+
}
50
50
+
}
+51
share/lexicons/com/atproto/lexicon/resolveLexicon.json
+51
share/lexicons/com/atproto/lexicon/resolveLexicon.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.lexicon.resolveLexicon",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Resolves an atproto lexicon (NSID) to a schema.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"nsid": {
12
12
+
"format": "nsid",
13
13
+
"type": "string",
14
14
+
"description": "The lexicon NSID to resolve."
15
15
+
}
16
16
+
},
17
17
+
"required": ["nsid"]
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"properties": {
24
24
+
"cid": {
25
25
+
"type": "string",
26
26
+
"format": "cid",
27
27
+
"description": "The CID of the lexicon schema record."
28
28
+
},
29
29
+
"schema": {
30
30
+
"type": "ref",
31
31
+
"ref": "com.atproto.lexicon.schema#main",
32
32
+
"description": "The resolved lexicon schema record."
33
33
+
},
34
34
+
"uri": {
35
35
+
"type": "string",
36
36
+
"format": "at-uri",
37
37
+
"description": "The AT-URI of the lexicon schema record."
38
38
+
}
39
39
+
},
40
40
+
"required": ["uri", "cid", "schema"]
41
41
+
}
42
42
+
},
43
43
+
"errors": [
44
44
+
{
45
45
+
"description": "No lexicon was resolved for the NSID.",
46
46
+
"name": "LexiconNotFound"
47
47
+
}
48
48
+
]
49
49
+
}
50
50
+
}
51
51
+
}
+21
share/lexicons/com/atproto/lexicon/schema.json
+21
share/lexicons/com/atproto/lexicon/schema.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.lexicon.schema",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "record",
7
7
+
"description": "Representation of Lexicon schemas themselves, when published as atproto records. Note that the schema language is not defined in Lexicon; this meta schema currently only includes a single version field ('lexicon'). See the atproto specifications for description of the other expected top-level fields ('id', 'defs', etc).",
8
8
+
"key": "nsid",
9
9
+
"record": {
10
10
+
"type": "object",
11
11
+
"required": ["lexicon"],
12
12
+
"properties": {
13
13
+
"lexicon": {
14
14
+
"type": "integer",
15
15
+
"description": "Indicates the 'version' of the Lexicon language. Must be '1' for the current atproto/Lexicon schema system."
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
+90
share/lexicons/com/atproto/moderation/createReport.json
+90
share/lexicons/com/atproto/moderation/createReport.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.moderation.createReport",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["reasonType", "subject"],
13
13
+
"properties": {
14
14
+
"reasonType": {
15
15
+
"type": "ref",
16
16
+
"description": "Indicates the broad category of violation the report is for.",
17
17
+
"ref": "com.atproto.moderation.defs#reasonType"
18
18
+
},
19
19
+
"reason": {
20
20
+
"type": "string",
21
21
+
"maxGraphemes": 2000,
22
22
+
"maxLength": 20000,
23
23
+
"description": "Additional context about the content and violation."
24
24
+
},
25
25
+
"subject": {
26
26
+
"type": "union",
27
27
+
"refs": [
28
28
+
"com.atproto.admin.defs#repoRef",
29
29
+
"com.atproto.repo.strongRef"
30
30
+
]
31
31
+
},
32
32
+
"modTool": {
33
33
+
"type": "ref",
34
34
+
"ref": "#modTool"
35
35
+
}
36
36
+
}
37
37
+
}
38
38
+
},
39
39
+
"output": {
40
40
+
"encoding": "application/json",
41
41
+
"schema": {
42
42
+
"type": "object",
43
43
+
"required": [
44
44
+
"id",
45
45
+
"reasonType",
46
46
+
"subject",
47
47
+
"reportedBy",
48
48
+
"createdAt"
49
49
+
],
50
50
+
"properties": {
51
51
+
"id": { "type": "integer" },
52
52
+
"reasonType": {
53
53
+
"type": "ref",
54
54
+
"ref": "com.atproto.moderation.defs#reasonType"
55
55
+
},
56
56
+
"reason": {
57
57
+
"type": "string",
58
58
+
"maxGraphemes": 2000,
59
59
+
"maxLength": 20000
60
60
+
},
61
61
+
"subject": {
62
62
+
"type": "union",
63
63
+
"refs": [
64
64
+
"com.atproto.admin.defs#repoRef",
65
65
+
"com.atproto.repo.strongRef"
66
66
+
]
67
67
+
},
68
68
+
"reportedBy": { "type": "string", "format": "did" },
69
69
+
"createdAt": { "type": "string", "format": "datetime" }
70
70
+
}
71
71
+
}
72
72
+
}
73
73
+
},
74
74
+
"modTool": {
75
75
+
"type": "object",
76
76
+
"description": "Moderation tool information for tracing the source of the action",
77
77
+
"required": ["name"],
78
78
+
"properties": {
79
79
+
"name": {
80
80
+
"type": "string",
81
81
+
"description": "Name/identifier of the source (e.g., 'bsky-app/android', 'bsky-web/chrome')"
82
82
+
},
83
83
+
"meta": {
84
84
+
"type": "unknown",
85
85
+
"description": "Additional arbitrary metadata about the source"
86
86
+
}
87
87
+
}
88
88
+
}
89
89
+
}
90
90
+
}
+99
share/lexicons/com/atproto/moderation/defs.json
+99
share/lexicons/com/atproto/moderation/defs.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.moderation.defs",
4
4
+
"defs": {
5
5
+
"reasonType": {
6
6
+
"type": "string",
7
7
+
"knownValues": [
8
8
+
"com.atproto.moderation.defs#reasonSpam",
9
9
+
"com.atproto.moderation.defs#reasonViolation",
10
10
+
"com.atproto.moderation.defs#reasonMisleading",
11
11
+
"com.atproto.moderation.defs#reasonSexual",
12
12
+
"com.atproto.moderation.defs#reasonRude",
13
13
+
"com.atproto.moderation.defs#reasonOther",
14
14
+
"com.atproto.moderation.defs#reasonAppeal",
15
15
+
16
16
+
"tools.ozone.report.defs#reasonAppeal",
17
17
+
"tools.ozone.report.defs#reasonOther",
18
18
+
19
19
+
"tools.ozone.report.defs#reasonViolenceAnimal",
20
20
+
"tools.ozone.report.defs#reasonViolenceThreats",
21
21
+
"tools.ozone.report.defs#reasonViolenceGraphicContent",
22
22
+
"tools.ozone.report.defs#reasonViolenceGlorification",
23
23
+
"tools.ozone.report.defs#reasonViolenceExtremistContent",
24
24
+
"tools.ozone.report.defs#reasonViolenceTrafficking",
25
25
+
"tools.ozone.report.defs#reasonViolenceOther",
26
26
+
27
27
+
"tools.ozone.report.defs#reasonSexualAbuseContent",
28
28
+
"tools.ozone.report.defs#reasonSexualNCII",
29
29
+
"tools.ozone.report.defs#reasonSexualDeepfake",
30
30
+
"tools.ozone.report.defs#reasonSexualAnimal",
31
31
+
"tools.ozone.report.defs#reasonSexualUnlabeled",
32
32
+
"tools.ozone.report.defs#reasonSexualOther",
33
33
+
34
34
+
"tools.ozone.report.defs#reasonChildSafetyCSAM",
35
35
+
"tools.ozone.report.defs#reasonChildSafetyGroom",
36
36
+
"tools.ozone.report.defs#reasonChildSafetyPrivacy",
37
37
+
"tools.ozone.report.defs#reasonChildSafetyHarassment",
38
38
+
"tools.ozone.report.defs#reasonChildSafetyOther",
39
39
+
40
40
+
"tools.ozone.report.defs#reasonHarassmentTroll",
41
41
+
"tools.ozone.report.defs#reasonHarassmentTargeted",
42
42
+
"tools.ozone.report.defs#reasonHarassmentHateSpeech",
43
43
+
"tools.ozone.report.defs#reasonHarassmentDoxxing",
44
44
+
"tools.ozone.report.defs#reasonHarassmentOther",
45
45
+
46
46
+
"tools.ozone.report.defs#reasonMisleadingBot",
47
47
+
"tools.ozone.report.defs#reasonMisleadingImpersonation",
48
48
+
"tools.ozone.report.defs#reasonMisleadingSpam",
49
49
+
"tools.ozone.report.defs#reasonMisleadingScam",
50
50
+
"tools.ozone.report.defs#reasonMisleadingElections",
51
51
+
"tools.ozone.report.defs#reasonMisleadingOther",
52
52
+
53
53
+
"tools.ozone.report.defs#reasonRuleSiteSecurity",
54
54
+
"tools.ozone.report.defs#reasonRuleProhibitedSales",
55
55
+
"tools.ozone.report.defs#reasonRuleBanEvasion",
56
56
+
"tools.ozone.report.defs#reasonRuleOther",
57
57
+
58
58
+
"tools.ozone.report.defs#reasonSelfHarmContent",
59
59
+
"tools.ozone.report.defs#reasonSelfHarmED",
60
60
+
"tools.ozone.report.defs#reasonSelfHarmStunts",
61
61
+
"tools.ozone.report.defs#reasonSelfHarmSubstances",
62
62
+
"tools.ozone.report.defs#reasonSelfHarmOther"
63
63
+
]
64
64
+
},
65
65
+
"reasonSpam": {
66
66
+
"type": "token",
67
67
+
"description": "Spam: frequent unwanted promotion, replies, mentions. Prefer new lexicon definition `tools.ozone.report.defs#reasonMisleadingSpam`."
68
68
+
},
69
69
+
"reasonViolation": {
70
70
+
"type": "token",
71
71
+
"description": "Direct violation of server rules, laws, terms of service. Prefer new lexicon definition `tools.ozone.report.defs#reasonRuleOther`."
72
72
+
},
73
73
+
"reasonMisleading": {
74
74
+
"type": "token",
75
75
+
"description": "Misleading identity, affiliation, or content. Prefer new lexicon definition `tools.ozone.report.defs#reasonMisleadingOther`."
76
76
+
},
77
77
+
"reasonSexual": {
78
78
+
"type": "token",
79
79
+
"description": "Unwanted or mislabeled sexual content. Prefer new lexicon definition `tools.ozone.report.defs#reasonSexualUnlabeled`."
80
80
+
},
81
81
+
"reasonRude": {
82
82
+
"type": "token",
83
83
+
"description": "Rude, harassing, explicit, or otherwise unwelcoming behavior. Prefer new lexicon definition `tools.ozone.report.defs#reasonHarassmentOther`."
84
84
+
},
85
85
+
"reasonOther": {
86
86
+
"type": "token",
87
87
+
"description": "Reports not falling under another report category. Prefer new lexicon definition `tools.ozone.report.defs#reasonOther`."
88
88
+
},
89
89
+
"reasonAppeal": {
90
90
+
"type": "token",
91
91
+
"description": "Appeal a previously taken moderation action"
92
92
+
},
93
93
+
"subjectType": {
94
94
+
"type": "string",
95
95
+
"description": "Tag describing a type of subject that might be reported.",
96
96
+
"knownValues": ["account", "record", "chat"]
97
97
+
}
98
98
+
}
99
99
+
}
+131
share/lexicons/com/atproto/repo/applyWrites.json
+131
share/lexicons/com/atproto/repo/applyWrites.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.applyWrites",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["repo", "writes"],
13
13
+
"properties": {
14
14
+
"repo": {
15
15
+
"type": "string",
16
16
+
"format": "at-identifier",
17
17
+
"description": "The handle or DID of the repo (aka, current account)."
18
18
+
},
19
19
+
"validate": {
20
20
+
"type": "boolean",
21
21
+
"description": "Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons."
22
22
+
},
23
23
+
"writes": {
24
24
+
"type": "array",
25
25
+
"items": {
26
26
+
"type": "union",
27
27
+
"refs": ["#create", "#update", "#delete"],
28
28
+
"closed": true
29
29
+
}
30
30
+
},
31
31
+
"swapCommit": {
32
32
+
"type": "string",
33
33
+
"description": "If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.",
34
34
+
"format": "cid"
35
35
+
}
36
36
+
}
37
37
+
}
38
38
+
},
39
39
+
"output": {
40
40
+
"encoding": "application/json",
41
41
+
"schema": {
42
42
+
"type": "object",
43
43
+
"required": [],
44
44
+
"properties": {
45
45
+
"commit": {
46
46
+
"type": "ref",
47
47
+
"ref": "com.atproto.repo.defs#commitMeta"
48
48
+
},
49
49
+
"results": {
50
50
+
"type": "array",
51
51
+
"items": {
52
52
+
"type": "union",
53
53
+
"refs": ["#createResult", "#updateResult", "#deleteResult"],
54
54
+
"closed": true
55
55
+
}
56
56
+
}
57
57
+
}
58
58
+
}
59
59
+
},
60
60
+
"errors": [
61
61
+
{
62
62
+
"name": "InvalidSwap",
63
63
+
"description": "Indicates that the 'swapCommit' parameter did not match current commit."
64
64
+
}
65
65
+
]
66
66
+
},
67
67
+
"create": {
68
68
+
"type": "object",
69
69
+
"description": "Operation which creates a new record.",
70
70
+
"required": ["collection", "value"],
71
71
+
"properties": {
72
72
+
"collection": { "type": "string", "format": "nsid" },
73
73
+
"rkey": {
74
74
+
"type": "string",
75
75
+
"maxLength": 512,
76
76
+
"format": "record-key",
77
77
+
"description": "NOTE: maxLength is redundant with record-key format. Keeping it temporarily to ensure backwards compatibility."
78
78
+
},
79
79
+
"value": { "type": "unknown" }
80
80
+
}
81
81
+
},
82
82
+
"update": {
83
83
+
"type": "object",
84
84
+
"description": "Operation which updates an existing record.",
85
85
+
"required": ["collection", "rkey", "value"],
86
86
+
"properties": {
87
87
+
"collection": { "type": "string", "format": "nsid" },
88
88
+
"rkey": { "type": "string", "format": "record-key" },
89
89
+
"value": { "type": "unknown" }
90
90
+
}
91
91
+
},
92
92
+
"delete": {
93
93
+
"type": "object",
94
94
+
"description": "Operation which deletes an existing record.",
95
95
+
"required": ["collection", "rkey"],
96
96
+
"properties": {
97
97
+
"collection": { "type": "string", "format": "nsid" },
98
98
+
"rkey": { "type": "string", "format": "record-key" }
99
99
+
}
100
100
+
},
101
101
+
"createResult": {
102
102
+
"type": "object",
103
103
+
"required": ["uri", "cid"],
104
104
+
"properties": {
105
105
+
"uri": { "type": "string", "format": "at-uri" },
106
106
+
"cid": { "type": "string", "format": "cid" },
107
107
+
"validationStatus": {
108
108
+
"type": "string",
109
109
+
"knownValues": ["valid", "unknown"]
110
110
+
}
111
111
+
}
112
112
+
},
113
113
+
"updateResult": {
114
114
+
"type": "object",
115
115
+
"required": ["uri", "cid"],
116
116
+
"properties": {
117
117
+
"uri": { "type": "string", "format": "at-uri" },
118
118
+
"cid": { "type": "string", "format": "cid" },
119
119
+
"validationStatus": {
120
120
+
"type": "string",
121
121
+
"knownValues": ["valid", "unknown"]
122
122
+
}
123
123
+
}
124
124
+
},
125
125
+
"deleteResult": {
126
126
+
"type": "object",
127
127
+
"required": [],
128
128
+
"properties": {}
129
129
+
}
130
130
+
}
131
131
+
}
+73
share/lexicons/com/atproto/repo/createRecord.json
+73
share/lexicons/com/atproto/repo/createRecord.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.createRecord",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Create a single new repository record. Requires auth, implemented by PDS.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["repo", "collection", "record"],
13
13
+
"properties": {
14
14
+
"repo": {
15
15
+
"type": "string",
16
16
+
"format": "at-identifier",
17
17
+
"description": "The handle or DID of the repo (aka, current account)."
18
18
+
},
19
19
+
"collection": {
20
20
+
"type": "string",
21
21
+
"format": "nsid",
22
22
+
"description": "The NSID of the record collection."
23
23
+
},
24
24
+
"rkey": {
25
25
+
"type": "string",
26
26
+
"format": "record-key",
27
27
+
"description": "The Record Key.",
28
28
+
"maxLength": 512
29
29
+
},
30
30
+
"validate": {
31
31
+
"type": "boolean",
32
32
+
"description": "Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons."
33
33
+
},
34
34
+
"record": {
35
35
+
"type": "unknown",
36
36
+
"description": "The record itself. Must contain a $type field."
37
37
+
},
38
38
+
"swapCommit": {
39
39
+
"type": "string",
40
40
+
"format": "cid",
41
41
+
"description": "Compare and swap with the previous commit by CID."
42
42
+
}
43
43
+
}
44
44
+
}
45
45
+
},
46
46
+
"output": {
47
47
+
"encoding": "application/json",
48
48
+
"schema": {
49
49
+
"type": "object",
50
50
+
"required": ["uri", "cid"],
51
51
+
"properties": {
52
52
+
"uri": { "type": "string", "format": "at-uri" },
53
53
+
"cid": { "type": "string", "format": "cid" },
54
54
+
"commit": {
55
55
+
"type": "ref",
56
56
+
"ref": "com.atproto.repo.defs#commitMeta"
57
57
+
},
58
58
+
"validationStatus": {
59
59
+
"type": "string",
60
60
+
"knownValues": ["valid", "unknown"]
61
61
+
}
62
62
+
}
63
63
+
}
64
64
+
},
65
65
+
"errors": [
66
66
+
{
67
67
+
"name": "InvalidSwap",
68
68
+
"description": "Indicates that 'swapCommit' didn't match current repo commit."
69
69
+
}
70
70
+
]
71
71
+
}
72
72
+
}
73
73
+
}
+14
share/lexicons/com/atproto/repo/defs.json
+14
share/lexicons/com/atproto/repo/defs.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.defs",
4
4
+
"defs": {
5
5
+
"commitMeta": {
6
6
+
"type": "object",
7
7
+
"required": ["cid", "rev"],
8
8
+
"properties": {
9
9
+
"cid": { "type": "string", "format": "cid" },
10
10
+
"rev": { "type": "string", "format": "tid" }
11
11
+
}
12
12
+
}
13
13
+
}
14
14
+
}
+57
share/lexicons/com/atproto/repo/deleteRecord.json
+57
share/lexicons/com/atproto/repo/deleteRecord.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.deleteRecord",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["repo", "collection", "rkey"],
13
13
+
"properties": {
14
14
+
"repo": {
15
15
+
"type": "string",
16
16
+
"format": "at-identifier",
17
17
+
"description": "The handle or DID of the repo (aka, current account)."
18
18
+
},
19
19
+
"collection": {
20
20
+
"type": "string",
21
21
+
"format": "nsid",
22
22
+
"description": "The NSID of the record collection."
23
23
+
},
24
24
+
"rkey": {
25
25
+
"type": "string",
26
26
+
"format": "record-key",
27
27
+
"description": "The Record Key."
28
28
+
},
29
29
+
"swapRecord": {
30
30
+
"type": "string",
31
31
+
"format": "cid",
32
32
+
"description": "Compare and swap with the previous record by CID."
33
33
+
},
34
34
+
"swapCommit": {
35
35
+
"type": "string",
36
36
+
"format": "cid",
37
37
+
"description": "Compare and swap with the previous commit by CID."
38
38
+
}
39
39
+
}
40
40
+
}
41
41
+
},
42
42
+
"output": {
43
43
+
"encoding": "application/json",
44
44
+
"schema": {
45
45
+
"type": "object",
46
46
+
"properties": {
47
47
+
"commit": {
48
48
+
"type": "ref",
49
49
+
"ref": "com.atproto.repo.defs#commitMeta"
50
50
+
}
51
51
+
}
52
52
+
}
53
53
+
},
54
54
+
"errors": [{ "name": "InvalidSwap" }]
55
55
+
}
56
56
+
}
57
57
+
}
+51
share/lexicons/com/atproto/repo/describeRepo.json
+51
share/lexicons/com/atproto/repo/describeRepo.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.describeRepo",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get information about an account and repository, including the list of collections. Does not require auth.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["repo"],
11
11
+
"properties": {
12
12
+
"repo": {
13
13
+
"type": "string",
14
14
+
"format": "at-identifier",
15
15
+
"description": "The handle or DID of the repo."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"required": [
24
24
+
"handle",
25
25
+
"did",
26
26
+
"didDoc",
27
27
+
"collections",
28
28
+
"handleIsCorrect"
29
29
+
],
30
30
+
"properties": {
31
31
+
"handle": { "type": "string", "format": "handle" },
32
32
+
"did": { "type": "string", "format": "did" },
33
33
+
"didDoc": {
34
34
+
"type": "unknown",
35
35
+
"description": "The complete DID document for this account."
36
36
+
},
37
37
+
"collections": {
38
38
+
"type": "array",
39
39
+
"description": "List of all the collections (NSIDs) for which this repo contains at least one record.",
40
40
+
"items": { "type": "string", "format": "nsid" }
41
41
+
},
42
42
+
"handleIsCorrect": {
43
43
+
"type": "boolean",
44
44
+
"description": "Indicates if handle is currently valid (resolves bi-directionally)"
45
45
+
}
46
46
+
}
47
47
+
}
48
48
+
}
49
49
+
}
50
50
+
}
51
51
+
}
+49
share/lexicons/com/atproto/repo/getRecord.json
+49
share/lexicons/com/atproto/repo/getRecord.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.getRecord",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get a single record from a repository. Does not require auth.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["repo", "collection", "rkey"],
11
11
+
"properties": {
12
12
+
"repo": {
13
13
+
"type": "string",
14
14
+
"format": "at-identifier",
15
15
+
"description": "The handle or DID of the repo."
16
16
+
},
17
17
+
"collection": {
18
18
+
"type": "string",
19
19
+
"format": "nsid",
20
20
+
"description": "The NSID of the record collection."
21
21
+
},
22
22
+
"rkey": {
23
23
+
"type": "string",
24
24
+
"description": "The Record Key.",
25
25
+
"format": "record-key"
26
26
+
},
27
27
+
"cid": {
28
28
+
"type": "string",
29
29
+
"format": "cid",
30
30
+
"description": "The CID of the version of the record. If not specified, then return the most recent version."
31
31
+
}
32
32
+
}
33
33
+
},
34
34
+
"output": {
35
35
+
"encoding": "application/json",
36
36
+
"schema": {
37
37
+
"type": "object",
38
38
+
"required": ["uri", "value"],
39
39
+
"properties": {
40
40
+
"uri": { "type": "string", "format": "at-uri" },
41
41
+
"cid": { "type": "string", "format": "cid" },
42
42
+
"value": { "type": "unknown" }
43
43
+
}
44
44
+
}
45
45
+
},
46
46
+
"errors": [{ "name": "RecordNotFound" }]
47
47
+
}
48
48
+
}
49
49
+
}
+13
share/lexicons/com/atproto/repo/importRepo.json
+13
share/lexicons/com/atproto/repo/importRepo.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.importRepo",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set.",
8
8
+
"input": {
9
9
+
"encoding": "application/vnd.ipld.car"
10
10
+
}
11
11
+
}
12
12
+
}
13
13
+
}
+44
share/lexicons/com/atproto/repo/listMissingBlobs.json
+44
share/lexicons/com/atproto/repo/listMissingBlobs.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.listMissingBlobs",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"limit": {
12
12
+
"type": "integer",
13
13
+
"minimum": 1,
14
14
+
"maximum": 1000,
15
15
+
"default": 500
16
16
+
},
17
17
+
"cursor": { "type": "string" }
18
18
+
}
19
19
+
},
20
20
+
"output": {
21
21
+
"encoding": "application/json",
22
22
+
"schema": {
23
23
+
"type": "object",
24
24
+
"required": ["blobs"],
25
25
+
"properties": {
26
26
+
"cursor": { "type": "string" },
27
27
+
"blobs": {
28
28
+
"type": "array",
29
29
+
"items": { "type": "ref", "ref": "#recordBlob" }
30
30
+
}
31
31
+
}
32
32
+
}
33
33
+
}
34
34
+
},
35
35
+
"recordBlob": {
36
36
+
"type": "object",
37
37
+
"required": ["cid", "recordUri"],
38
38
+
"properties": {
39
39
+
"cid": { "type": "string", "format": "cid" },
40
40
+
"recordUri": { "type": "string", "format": "at-uri" }
41
41
+
}
42
42
+
}
43
43
+
}
44
44
+
}
+61
share/lexicons/com/atproto/repo/listRecords.json
+61
share/lexicons/com/atproto/repo/listRecords.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.listRecords",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "List a range of records in a repository, matching a specific collection. Does not require auth.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["repo", "collection"],
11
11
+
"properties": {
12
12
+
"repo": {
13
13
+
"type": "string",
14
14
+
"format": "at-identifier",
15
15
+
"description": "The handle or DID of the repo."
16
16
+
},
17
17
+
"collection": {
18
18
+
"type": "string",
19
19
+
"format": "nsid",
20
20
+
"description": "The NSID of the record type."
21
21
+
},
22
22
+
"limit": {
23
23
+
"type": "integer",
24
24
+
"minimum": 1,
25
25
+
"maximum": 100,
26
26
+
"default": 50,
27
27
+
"description": "The number of records to return."
28
28
+
},
29
29
+
"cursor": { "type": "string" },
30
30
+
"reverse": {
31
31
+
"type": "boolean",
32
32
+
"description": "Flag to reverse the order of the returned records."
33
33
+
}
34
34
+
}
35
35
+
},
36
36
+
"output": {
37
37
+
"encoding": "application/json",
38
38
+
"schema": {
39
39
+
"type": "object",
40
40
+
"required": ["records"],
41
41
+
"properties": {
42
42
+
"cursor": { "type": "string" },
43
43
+
"records": {
44
44
+
"type": "array",
45
45
+
"items": { "type": "ref", "ref": "#record" }
46
46
+
}
47
47
+
}
48
48
+
}
49
49
+
}
50
50
+
},
51
51
+
"record": {
52
52
+
"type": "object",
53
53
+
"required": ["uri", "cid", "value"],
54
54
+
"properties": {
55
55
+
"uri": { "type": "string", "format": "at-uri" },
56
56
+
"cid": { "type": "string", "format": "cid" },
57
57
+
"value": { "type": "unknown" }
58
58
+
}
59
59
+
}
60
60
+
}
61
61
+
}
+74
share/lexicons/com/atproto/repo/putRecord.json
+74
share/lexicons/com/atproto/repo/putRecord.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.putRecord",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["repo", "collection", "rkey", "record"],
13
13
+
"nullable": ["swapRecord"],
14
14
+
"properties": {
15
15
+
"repo": {
16
16
+
"type": "string",
17
17
+
"format": "at-identifier",
18
18
+
"description": "The handle or DID of the repo (aka, current account)."
19
19
+
},
20
20
+
"collection": {
21
21
+
"type": "string",
22
22
+
"format": "nsid",
23
23
+
"description": "The NSID of the record collection."
24
24
+
},
25
25
+
"rkey": {
26
26
+
"type": "string",
27
27
+
"format": "record-key",
28
28
+
"description": "The Record Key.",
29
29
+
"maxLength": 512
30
30
+
},
31
31
+
"validate": {
32
32
+
"type": "boolean",
33
33
+
"description": "Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons."
34
34
+
},
35
35
+
"record": {
36
36
+
"type": "unknown",
37
37
+
"description": "The record to write."
38
38
+
},
39
39
+
"swapRecord": {
40
40
+
"type": "string",
41
41
+
"format": "cid",
42
42
+
"description": "Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation"
43
43
+
},
44
44
+
"swapCommit": {
45
45
+
"type": "string",
46
46
+
"format": "cid",
47
47
+
"description": "Compare and swap with the previous commit by CID."
48
48
+
}
49
49
+
}
50
50
+
}
51
51
+
},
52
52
+
"output": {
53
53
+
"encoding": "application/json",
54
54
+
"schema": {
55
55
+
"type": "object",
56
56
+
"required": ["uri", "cid"],
57
57
+
"properties": {
58
58
+
"uri": { "type": "string", "format": "at-uri" },
59
59
+
"cid": { "type": "string", "format": "cid" },
60
60
+
"commit": {
61
61
+
"type": "ref",
62
62
+
"ref": "com.atproto.repo.defs#commitMeta"
63
63
+
},
64
64
+
"validationStatus": {
65
65
+
"type": "string",
66
66
+
"knownValues": ["valid", "unknown"]
67
67
+
}
68
68
+
}
69
69
+
}
70
70
+
},
71
71
+
"errors": [{ "name": "InvalidSwap" }]
72
72
+
}
73
73
+
}
74
74
+
}
+15
share/lexicons/com/atproto/repo/strongRef.json
+15
share/lexicons/com/atproto/repo/strongRef.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.strongRef",
4
4
+
"description": "A URI with a content-hash fingerprint.",
5
5
+
"defs": {
6
6
+
"main": {
7
7
+
"type": "object",
8
8
+
"required": ["uri", "cid"],
9
9
+
"properties": {
10
10
+
"uri": { "type": "string", "format": "at-uri" },
11
11
+
"cid": { "type": "string", "format": "cid" }
12
12
+
}
13
13
+
}
14
14
+
}
15
15
+
}
+23
share/lexicons/com/atproto/repo/uploadBlob.json
+23
share/lexicons/com/atproto/repo/uploadBlob.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.repo.uploadBlob",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.",
8
8
+
"input": {
9
9
+
"encoding": "*/*"
10
10
+
},
11
11
+
"output": {
12
12
+
"encoding": "application/json",
13
13
+
"schema": {
14
14
+
"type": "object",
15
15
+
"required": ["blob"],
16
16
+
"properties": {
17
17
+
"blob": { "type": "blob" }
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
+10
share/lexicons/com/atproto/server/activateAccount.json
+10
share/lexicons/com/atproto/server/activateAccount.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.activateAccount",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Activates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup."
8
8
+
}
9
9
+
}
10
10
+
}
+38
share/lexicons/com/atproto/server/checkAccountStatus.json
+38
share/lexicons/com/atproto/server/checkAccountStatus.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.checkAccountStatus",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Returns the status of an account, especially as pertaining to import or recovery. Can be called many times over the course of an account migration. Requires auth and can only be called pertaining to oneself.",
8
8
+
"output": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": [
13
13
+
"activated",
14
14
+
"validDid",
15
15
+
"repoCommit",
16
16
+
"repoRev",
17
17
+
"repoBlocks",
18
18
+
"indexedRecords",
19
19
+
"privateStateValues",
20
20
+
"expectedBlobs",
21
21
+
"importedBlobs"
22
22
+
],
23
23
+
"properties": {
24
24
+
"activated": { "type": "boolean" },
25
25
+
"validDid": { "type": "boolean" },
26
26
+
"repoCommit": { "type": "string", "format": "cid" },
27
27
+
"repoRev": { "type": "string" },
28
28
+
"repoBlocks": { "type": "integer" },
29
29
+
"indexedRecords": { "type": "integer" },
30
30
+
"privateStateValues": { "type": "integer" },
31
31
+
"expectedBlobs": { "type": "integer" },
32
32
+
"importedBlobs": { "type": "integer" }
33
33
+
}
34
34
+
}
35
35
+
}
36
36
+
}
37
37
+
}
38
38
+
}
+27
share/lexicons/com/atproto/server/confirmEmail.json
+27
share/lexicons/com/atproto/server/confirmEmail.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.confirmEmail",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Confirm an email using a token from com.atproto.server.requestEmailConfirmation.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["email", "token"],
13
13
+
"properties": {
14
14
+
"email": { "type": "string" },
15
15
+
"token": { "type": "string" }
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"errors": [
20
20
+
{ "name": "AccountNotFound" },
21
21
+
{ "name": "ExpiredToken" },
22
22
+
{ "name": "InvalidToken" },
23
23
+
{ "name": "InvalidEmail" }
24
24
+
]
25
25
+
}
26
26
+
}
27
27
+
}
+76
share/lexicons/com/atproto/server/createAccount.json
+76
share/lexicons/com/atproto/server/createAccount.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.createAccount",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Create an account. Implemented by PDS.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["handle"],
13
13
+
"properties": {
14
14
+
"email": { "type": "string" },
15
15
+
"handle": {
16
16
+
"type": "string",
17
17
+
"format": "handle",
18
18
+
"description": "Requested handle for the account."
19
19
+
},
20
20
+
"did": {
21
21
+
"type": "string",
22
22
+
"format": "did",
23
23
+
"description": "Pre-existing atproto DID, being imported to a new account."
24
24
+
},
25
25
+
"inviteCode": { "type": "string" },
26
26
+
"verificationCode": { "type": "string" },
27
27
+
"verificationPhone": { "type": "string" },
28
28
+
"password": {
29
29
+
"type": "string",
30
30
+
"description": "Initial account password. May need to meet instance-specific password strength requirements."
31
31
+
},
32
32
+
"recoveryKey": {
33
33
+
"type": "string",
34
34
+
"description": "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation."
35
35
+
},
36
36
+
"plcOp": {
37
37
+
"type": "unknown",
38
38
+
"description": "A signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented."
39
39
+
}
40
40
+
}
41
41
+
}
42
42
+
},
43
43
+
"output": {
44
44
+
"encoding": "application/json",
45
45
+
"schema": {
46
46
+
"type": "object",
47
47
+
"description": "Account login session returned on successful account creation.",
48
48
+
"required": ["accessJwt", "refreshJwt", "handle", "did"],
49
49
+
"properties": {
50
50
+
"accessJwt": { "type": "string" },
51
51
+
"refreshJwt": { "type": "string" },
52
52
+
"handle": { "type": "string", "format": "handle" },
53
53
+
"did": {
54
54
+
"type": "string",
55
55
+
"format": "did",
56
56
+
"description": "The DID of the new account."
57
57
+
},
58
58
+
"didDoc": {
59
59
+
"type": "unknown",
60
60
+
"description": "Complete DID document."
61
61
+
}
62
62
+
}
63
63
+
}
64
64
+
},
65
65
+
"errors": [
66
66
+
{ "name": "InvalidHandle" },
67
67
+
{ "name": "InvalidPassword" },
68
68
+
{ "name": "InvalidInviteCode" },
69
69
+
{ "name": "HandleNotAvailable" },
70
70
+
{ "name": "UnsupportedDomain" },
71
71
+
{ "name": "UnresolvableDid" },
72
72
+
{ "name": "IncompatibleDidDoc" }
73
73
+
]
74
74
+
}
75
75
+
}
76
76
+
}
+45
share/lexicons/com/atproto/server/createAppPassword.json
+45
share/lexicons/com/atproto/server/createAppPassword.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.createAppPassword",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Create an App Password.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["name"],
13
13
+
"properties": {
14
14
+
"name": {
15
15
+
"type": "string",
16
16
+
"description": "A short name for the App Password, to help distinguish them."
17
17
+
},
18
18
+
"privileged": {
19
19
+
"type": "boolean",
20
20
+
"description": "If an app password has 'privileged' access to possibly sensitive account state. Meant for use with trusted clients."
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
},
25
25
+
"output": {
26
26
+
"encoding": "application/json",
27
27
+
"schema": {
28
28
+
"type": "ref",
29
29
+
"ref": "#appPassword"
30
30
+
}
31
31
+
},
32
32
+
"errors": [{ "name": "AccountTakedown" }]
33
33
+
},
34
34
+
"appPassword": {
35
35
+
"type": "object",
36
36
+
"required": ["name", "password", "createdAt"],
37
37
+
"properties": {
38
38
+
"name": { "type": "string" },
39
39
+
"password": { "type": "string" },
40
40
+
"createdAt": { "type": "string", "format": "datetime" },
41
41
+
"privileged": { "type": "boolean" }
42
42
+
}
43
43
+
}
44
44
+
}
45
45
+
}
+31
share/lexicons/com/atproto/server/createInviteCode.json
+31
share/lexicons/com/atproto/server/createInviteCode.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.createInviteCode",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Create an invite code.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["useCount"],
13
13
+
"properties": {
14
14
+
"useCount": { "type": "integer" },
15
15
+
"forAccount": { "type": "string", "format": "did" }
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"required": ["code"],
24
24
+
"properties": {
25
25
+
"code": { "type": "string" }
26
26
+
}
27
27
+
}
28
28
+
}
29
29
+
}
30
30
+
}
31
31
+
}
+49
share/lexicons/com/atproto/server/createInviteCodes.json
+49
share/lexicons/com/atproto/server/createInviteCodes.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.createInviteCodes",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Create invite codes.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["codeCount", "useCount"],
13
13
+
"properties": {
14
14
+
"codeCount": { "type": "integer", "default": 1 },
15
15
+
"useCount": { "type": "integer" },
16
16
+
"forAccounts": {
17
17
+
"type": "array",
18
18
+
"items": { "type": "string", "format": "did" }
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
},
23
23
+
"output": {
24
24
+
"encoding": "application/json",
25
25
+
"schema": {
26
26
+
"type": "object",
27
27
+
"required": ["codes"],
28
28
+
"properties": {
29
29
+
"codes": {
30
30
+
"type": "array",
31
31
+
"items": { "type": "ref", "ref": "#accountCodes" }
32
32
+
}
33
33
+
}
34
34
+
}
35
35
+
}
36
36
+
},
37
37
+
"accountCodes": {
38
38
+
"type": "object",
39
39
+
"required": ["account", "codes"],
40
40
+
"properties": {
41
41
+
"account": { "type": "string" },
42
42
+
"codes": {
43
43
+
"type": "array",
44
44
+
"items": { "type": "string" }
45
45
+
}
46
46
+
}
47
47
+
}
48
48
+
}
49
49
+
}
+56
share/lexicons/com/atproto/server/createSession.json
+56
share/lexicons/com/atproto/server/createSession.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.createSession",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Create an authentication session.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["identifier", "password"],
13
13
+
"properties": {
14
14
+
"identifier": {
15
15
+
"type": "string",
16
16
+
"description": "Handle or other identifier supported by the server for the authenticating user."
17
17
+
},
18
18
+
"password": { "type": "string" },
19
19
+
"authFactorToken": { "type": "string" },
20
20
+
"allowTakendown": {
21
21
+
"type": "boolean",
22
22
+
"description": "When true, instead of throwing error for takendown accounts, a valid response with a narrow scoped token will be returned"
23
23
+
}
24
24
+
}
25
25
+
}
26
26
+
},
27
27
+
"output": {
28
28
+
"encoding": "application/json",
29
29
+
"schema": {
30
30
+
"type": "object",
31
31
+
"required": ["accessJwt", "refreshJwt", "handle", "did"],
32
32
+
"properties": {
33
33
+
"accessJwt": { "type": "string" },
34
34
+
"refreshJwt": { "type": "string" },
35
35
+
"handle": { "type": "string", "format": "handle" },
36
36
+
"did": { "type": "string", "format": "did" },
37
37
+
"didDoc": { "type": "unknown" },
38
38
+
"email": { "type": "string" },
39
39
+
"emailConfirmed": { "type": "boolean" },
40
40
+
"emailAuthFactor": { "type": "boolean" },
41
41
+
"active": { "type": "boolean" },
42
42
+
"status": {
43
43
+
"type": "string",
44
44
+
"description": "If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.",
45
45
+
"knownValues": ["takendown", "suspended", "deactivated"]
46
46
+
}
47
47
+
}
48
48
+
}
49
49
+
},
50
50
+
"errors": [
51
51
+
{ "name": "AccountTakedown" },
52
52
+
{ "name": "AuthFactorTokenRequired" }
53
53
+
]
54
54
+
}
55
55
+
}
56
56
+
}
+23
share/lexicons/com/atproto/server/deactivateAccount.json
+23
share/lexicons/com/atproto/server/deactivateAccount.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.deactivateAccount",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Deactivates a currently active account. Stops serving of repo, and future writes to repo until reactivated. Used to finalize account migration with the old host after the account has been activated on the new host.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"properties": {
13
13
+
"deleteAfter": {
14
14
+
"type": "string",
15
15
+
"format": "datetime",
16
16
+
"description": "A recommendation to server as to how long they should hold onto the deactivated account before deleting."
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
+38
share/lexicons/com/atproto/server/defs.json
+38
share/lexicons/com/atproto/server/defs.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.defs",
4
4
+
"defs": {
5
5
+
"inviteCode": {
6
6
+
"type": "object",
7
7
+
"required": [
8
8
+
"code",
9
9
+
"available",
10
10
+
"disabled",
11
11
+
"forAccount",
12
12
+
"createdBy",
13
13
+
"createdAt",
14
14
+
"uses"
15
15
+
],
16
16
+
"properties": {
17
17
+
"code": { "type": "string" },
18
18
+
"available": { "type": "integer" },
19
19
+
"disabled": { "type": "boolean" },
20
20
+
"forAccount": { "type": "string" },
21
21
+
"createdBy": { "type": "string" },
22
22
+
"createdAt": { "type": "string", "format": "datetime" },
23
23
+
"uses": {
24
24
+
"type": "array",
25
25
+
"items": { "type": "ref", "ref": "#inviteCodeUse" }
26
26
+
}
27
27
+
}
28
28
+
},
29
29
+
"inviteCodeUse": {
30
30
+
"type": "object",
31
31
+
"required": ["usedBy", "usedAt"],
32
32
+
"properties": {
33
33
+
"usedBy": { "type": "string", "format": "did" },
34
34
+
"usedAt": { "type": "string", "format": "datetime" }
35
35
+
}
36
36
+
}
37
37
+
}
38
38
+
}
+23
share/lexicons/com/atproto/server/deleteAccount.json
+23
share/lexicons/com/atproto/server/deleteAccount.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.deleteAccount",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["did", "password", "token"],
13
13
+
"properties": {
14
14
+
"did": { "type": "string", "format": "did" },
15
15
+
"password": { "type": "string" },
16
16
+
"token": { "type": "string" }
17
17
+
}
18
18
+
}
19
19
+
},
20
20
+
"errors": [{ "name": "ExpiredToken" }, { "name": "InvalidToken" }]
21
21
+
}
22
22
+
}
23
23
+
}
+11
share/lexicons/com/atproto/server/deleteSession.json
+11
share/lexicons/com/atproto/server/deleteSession.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.deleteSession",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Delete the current session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
8
8
+
"errors": [{ "name": "InvalidToken" }, { "name": "ExpiredToken" }]
9
9
+
}
10
10
+
}
11
11
+
}
+59
share/lexicons/com/atproto/server/describeServer.json
+59
share/lexicons/com/atproto/server/describeServer.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.describeServer",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Describes the server's account creation requirements and capabilities. Implemented by PDS.",
8
8
+
"output": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["did", "availableUserDomains"],
13
13
+
"properties": {
14
14
+
"inviteCodeRequired": {
15
15
+
"type": "boolean",
16
16
+
"description": "If true, an invite code must be supplied to create an account on this instance."
17
17
+
},
18
18
+
"phoneVerificationRequired": {
19
19
+
"type": "boolean",
20
20
+
"description": "If true, a phone verification token must be supplied to create an account on this instance."
21
21
+
},
22
22
+
"availableUserDomains": {
23
23
+
"type": "array",
24
24
+
"description": "List of domain suffixes that can be used in account handles.",
25
25
+
"items": { "type": "string" }
26
26
+
},
27
27
+
"links": {
28
28
+
"type": "ref",
29
29
+
"description": "URLs of service policy documents.",
30
30
+
"ref": "#links"
31
31
+
},
32
32
+
"contact": {
33
33
+
"type": "ref",
34
34
+
"description": "Contact information",
35
35
+
"ref": "#contact"
36
36
+
},
37
37
+
"did": {
38
38
+
"type": "string",
39
39
+
"format": "did"
40
40
+
}
41
41
+
}
42
42
+
}
43
43
+
}
44
44
+
},
45
45
+
"links": {
46
46
+
"type": "object",
47
47
+
"properties": {
48
48
+
"privacyPolicy": { "type": "string", "format": "uri" },
49
49
+
"termsOfService": { "type": "string", "format": "uri" }
50
50
+
}
51
51
+
},
52
52
+
"contact": {
53
53
+
"type": "object",
54
54
+
"properties": {
55
55
+
"email": { "type": "string" }
56
56
+
}
57
57
+
}
58
58
+
}
59
59
+
}
+38
share/lexicons/com/atproto/server/getAccountInviteCodes.json
+38
share/lexicons/com/atproto/server/getAccountInviteCodes.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.getAccountInviteCodes",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get all invite codes for the current account. Requires auth.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"includeUsed": { "type": "boolean", "default": true },
12
12
+
"createAvailable": {
13
13
+
"type": "boolean",
14
14
+
"default": true,
15
15
+
"description": "Controls whether any new 'earned' but not 'created' invites should be created."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"required": ["codes"],
24
24
+
"properties": {
25
25
+
"codes": {
26
26
+
"type": "array",
27
27
+
"items": {
28
28
+
"type": "ref",
29
29
+
"ref": "com.atproto.server.defs#inviteCode"
30
30
+
}
31
31
+
}
32
32
+
}
33
33
+
}
34
34
+
},
35
35
+
"errors": [{ "name": "DuplicateCreate" }]
36
36
+
}
37
37
+
}
38
38
+
}
+48
share/lexicons/com/atproto/server/getServiceAuth.json
+48
share/lexicons/com/atproto/server/getServiceAuth.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.getServiceAuth",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get a signed token on behalf of the requesting DID for the requested service.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["aud"],
11
11
+
"properties": {
12
12
+
"aud": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the service that the token will be used to authenticate with"
16
16
+
},
17
17
+
"exp": {
18
18
+
"type": "integer",
19
19
+
"description": "The time in Unix Epoch seconds that the JWT expires. Defaults to 60 seconds in the future. The service may enforce certain time bounds on tokens depending on the requested scope."
20
20
+
},
21
21
+
"lxm": {
22
22
+
"type": "string",
23
23
+
"format": "nsid",
24
24
+
"description": "Lexicon (XRPC) method to bind the requested token to"
25
25
+
}
26
26
+
}
27
27
+
},
28
28
+
"output": {
29
29
+
"encoding": "application/json",
30
30
+
"schema": {
31
31
+
"type": "object",
32
32
+
"required": ["token"],
33
33
+
"properties": {
34
34
+
"token": {
35
35
+
"type": "string"
36
36
+
}
37
37
+
}
38
38
+
}
39
39
+
},
40
40
+
"errors": [
41
41
+
{
42
42
+
"name": "BadExpiration",
43
43
+
"description": "Indicates that the requested expiration date is not a valid. May be in the past or may be reliant on the requested scopes."
44
44
+
}
45
45
+
]
46
46
+
}
47
47
+
}
48
48
+
}
+31
share/lexicons/com/atproto/server/getSession.json
+31
share/lexicons/com/atproto/server/getSession.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.getSession",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get information about the current auth session. Requires auth.",
8
8
+
"output": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["handle", "did"],
13
13
+
"properties": {
14
14
+
"handle": { "type": "string", "format": "handle" },
15
15
+
"did": { "type": "string", "format": "did" },
16
16
+
"didDoc": { "type": "unknown" },
17
17
+
"email": { "type": "string" },
18
18
+
"emailConfirmed": { "type": "boolean" },
19
19
+
"emailAuthFactor": { "type": "boolean" },
20
20
+
"active": { "type": "boolean" },
21
21
+
"status": {
22
22
+
"type": "string",
23
23
+
"description": "If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.",
24
24
+
"knownValues": ["takendown", "suspended", "deactivated"]
25
25
+
}
26
26
+
}
27
27
+
}
28
28
+
}
29
29
+
}
30
30
+
}
31
31
+
}
+33
share/lexicons/com/atproto/server/listAppPasswords.json
+33
share/lexicons/com/atproto/server/listAppPasswords.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.listAppPasswords",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "List all App Passwords.",
8
8
+
"output": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["passwords"],
13
13
+
"properties": {
14
14
+
"passwords": {
15
15
+
"type": "array",
16
16
+
"items": { "type": "ref", "ref": "#appPassword" }
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
},
21
21
+
"errors": [{ "name": "AccountTakedown" }]
22
22
+
},
23
23
+
"appPassword": {
24
24
+
"type": "object",
25
25
+
"required": ["name", "createdAt"],
26
26
+
"properties": {
27
27
+
"name": { "type": "string" },
28
28
+
"createdAt": { "type": "string", "format": "datetime" },
29
29
+
"privileged": { "type": "boolean" }
30
30
+
}
31
31
+
}
32
32
+
}
33
33
+
}
+38
share/lexicons/com/atproto/server/refreshSession.json
+38
share/lexicons/com/atproto/server/refreshSession.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.refreshSession",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').",
8
8
+
"output": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["accessJwt", "refreshJwt", "handle", "did"],
13
13
+
"properties": {
14
14
+
"accessJwt": { "type": "string" },
15
15
+
"refreshJwt": { "type": "string" },
16
16
+
"handle": { "type": "string", "format": "handle" },
17
17
+
"did": { "type": "string", "format": "did" },
18
18
+
"didDoc": { "type": "unknown" },
19
19
+
"email": { "type": "string" },
20
20
+
"emailConfirmed": { "type": "boolean" },
21
21
+
"emailAuthFactor": { "type": "boolean" },
22
22
+
"active": { "type": "boolean" },
23
23
+
"status": {
24
24
+
"type": "string",
25
25
+
"description": "Hosting status of the account. If not specified, then assume 'active'.",
26
26
+
"knownValues": ["takendown", "suspended", "deactivated"]
27
27
+
}
28
28
+
}
29
29
+
}
30
30
+
},
31
31
+
"errors": [
32
32
+
{ "name": "AccountTakedown" },
33
33
+
{ "name": "InvalidToken" },
34
34
+
{ "name": "ExpiredToken" }
35
35
+
]
36
36
+
}
37
37
+
}
38
38
+
}
+10
share/lexicons/com/atproto/server/requestAccountDelete.json
+10
share/lexicons/com/atproto/server/requestAccountDelete.json
+10
share/lexicons/com/atproto/server/requestEmailConfirmation.json
+10
share/lexicons/com/atproto/server/requestEmailConfirmation.json
+20
share/lexicons/com/atproto/server/requestEmailUpdate.json
+20
share/lexicons/com/atproto/server/requestEmailUpdate.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.requestEmailUpdate",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Request a token in order to update email.",
8
8
+
"output": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["tokenRequired"],
13
13
+
"properties": {
14
14
+
"tokenRequired": { "type": "boolean" }
15
15
+
}
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
+20
share/lexicons/com/atproto/server/requestPasswordReset.json
+20
share/lexicons/com/atproto/server/requestPasswordReset.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.requestPasswordReset",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Initiate a user account password reset via email.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["email"],
13
13
+
"properties": {
14
14
+
"email": { "type": "string" }
15
15
+
}
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
+36
share/lexicons/com/atproto/server/reserveSigningKey.json
+36
share/lexicons/com/atproto/server/reserveSigningKey.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.reserveSigningKey",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Reserve a repo signing key, for use with account creation. Necessary so that a DID PLC update operation can be constructed during an account migraiton. Public and does not require auth; implemented by PDS. NOTE: this endpoint may change when full account migration is implemented.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"properties": {
13
13
+
"did": {
14
14
+
"type": "string",
15
15
+
"format": "did",
16
16
+
"description": "The DID to reserve a key for."
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
},
21
21
+
"output": {
22
22
+
"encoding": "application/json",
23
23
+
"schema": {
24
24
+
"type": "object",
25
25
+
"required": ["signingKey"],
26
26
+
"properties": {
27
27
+
"signingKey": {
28
28
+
"type": "string",
29
29
+
"description": "The public key for the reserved signing key, in did:key serialization."
30
30
+
}
31
31
+
}
32
32
+
}
33
33
+
}
34
34
+
}
35
35
+
}
36
36
+
}
+22
share/lexicons/com/atproto/server/resetPassword.json
+22
share/lexicons/com/atproto/server/resetPassword.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.resetPassword",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Reset a user account password using a token.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["token", "password"],
13
13
+
"properties": {
14
14
+
"token": { "type": "string" },
15
15
+
"password": { "type": "string" }
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"errors": [{ "name": "ExpiredToken" }, { "name": "InvalidToken" }]
20
20
+
}
21
21
+
}
22
22
+
}
+20
share/lexicons/com/atproto/server/revokeAppPassword.json
+20
share/lexicons/com/atproto/server/revokeAppPassword.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.revokeAppPassword",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Revoke an App Password by name.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["name"],
13
13
+
"properties": {
14
14
+
"name": { "type": "string" }
15
15
+
}
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
+30
share/lexicons/com/atproto/server/updateEmail.json
+30
share/lexicons/com/atproto/server/updateEmail.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.server.updateEmail",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Update an account's email.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["email"],
13
13
+
"properties": {
14
14
+
"email": { "type": "string" },
15
15
+
"emailAuthFactor": { "type": "boolean" },
16
16
+
"token": {
17
17
+
"type": "string",
18
18
+
"description": "Requires a token from com.atproto.sever.requestEmailUpdate if the account's email has been confirmed."
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
},
23
23
+
"errors": [
24
24
+
{ "name": "ExpiredToken" },
25
25
+
{ "name": "InvalidToken" },
26
26
+
{ "name": "TokenRequired" }
27
27
+
]
28
28
+
}
29
29
+
}
30
30
+
}
+10
share/lexicons/com/atproto/sync/defs.json
+10
share/lexicons/com/atproto/sync/defs.json
+36
share/lexicons/com/atproto/sync/getBlob.json
+36
share/lexicons/com/atproto/sync/getBlob.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getBlob",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did", "cid"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the account."
16
16
+
},
17
17
+
"cid": {
18
18
+
"type": "string",
19
19
+
"format": "cid",
20
20
+
"description": "The CID of the blob to fetch"
21
21
+
}
22
22
+
}
23
23
+
},
24
24
+
"output": {
25
25
+
"encoding": "*/*"
26
26
+
},
27
27
+
"errors": [
28
28
+
{ "name": "BlobNotFound" },
29
29
+
{ "name": "RepoNotFound" },
30
30
+
{ "name": "RepoTakendown" },
31
31
+
{ "name": "RepoSuspended" },
32
32
+
{ "name": "RepoDeactivated" }
33
33
+
]
34
34
+
}
35
35
+
}
36
36
+
}
+35
share/lexicons/com/atproto/sync/getBlocks.json
+35
share/lexicons/com/atproto/sync/getBlocks.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getBlocks",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did", "cids"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the repo."
16
16
+
},
17
17
+
"cids": {
18
18
+
"type": "array",
19
19
+
"items": { "type": "string", "format": "cid" }
20
20
+
}
21
21
+
}
22
22
+
},
23
23
+
"output": {
24
24
+
"encoding": "application/vnd.ipld.car"
25
25
+
},
26
26
+
"errors": [
27
27
+
{ "name": "BlockNotFound" },
28
28
+
{ "name": "RepoNotFound" },
29
29
+
{ "name": "RepoTakendown" },
30
30
+
{ "name": "RepoSuspended" },
31
31
+
{ "name": "RepoDeactivated" }
32
32
+
]
33
33
+
}
34
34
+
}
35
35
+
}
+24
share/lexicons/com/atproto/sync/getCheckout.json
+24
share/lexicons/com/atproto/sync/getCheckout.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getCheckout",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "DEPRECATED - please use com.atproto.sync.getRepo instead",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the repo."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/vnd.ipld.car"
21
21
+
}
22
22
+
}
23
23
+
}
24
24
+
}
+32
share/lexicons/com/atproto/sync/getHead.json
+32
share/lexicons/com/atproto/sync/getHead.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getHead",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "DEPRECATED - please use com.atproto.sync.getLatestCommit instead",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the repo."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"required": ["root"],
24
24
+
"properties": {
25
25
+
"root": { "type": "string", "format": "cid" }
26
26
+
}
27
27
+
}
28
28
+
},
29
29
+
"errors": [{ "name": "HeadNotFound" }]
30
30
+
}
31
31
+
}
32
32
+
}
+43
share/lexicons/com/atproto/sync/getHostStatus.json
+43
share/lexicons/com/atproto/sync/getHostStatus.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getHostStatus",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Returns information about a specified upstream host, as consumed by the server. Implemented by relays.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["hostname"],
11
11
+
"properties": {
12
12
+
"hostname": {
13
13
+
"type": "string",
14
14
+
"description": "Hostname of the host (eg, PDS or relay) being queried."
15
15
+
}
16
16
+
}
17
17
+
},
18
18
+
"output": {
19
19
+
"encoding": "application/json",
20
20
+
"schema": {
21
21
+
"type": "object",
22
22
+
"required": ["hostname"],
23
23
+
"properties": {
24
24
+
"hostname": { "type": "string" },
25
25
+
"seq": {
26
26
+
"type": "integer",
27
27
+
"description": "Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor)."
28
28
+
},
29
29
+
"accountCount": {
30
30
+
"type": "integer",
31
31
+
"description": "Number of accounts on the server which are associated with the upstream host. Note that the upstream may actually have more accounts."
32
32
+
},
33
33
+
"status": {
34
34
+
"type": "ref",
35
35
+
"ref": "com.atproto.sync.defs#hostStatus"
36
36
+
}
37
37
+
}
38
38
+
}
39
39
+
},
40
40
+
"errors": [{ "name": "HostNotFound" }]
41
41
+
}
42
42
+
}
43
43
+
}
+38
share/lexicons/com/atproto/sync/getLatestCommit.json
+38
share/lexicons/com/atproto/sync/getLatestCommit.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getLatestCommit",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get the current commit CID & revision of the specified repo. Does not require auth.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the repo."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"required": ["cid", "rev"],
24
24
+
"properties": {
25
25
+
"cid": { "type": "string", "format": "cid" },
26
26
+
"rev": { "type": "string", "format": "tid" }
27
27
+
}
28
28
+
}
29
29
+
},
30
30
+
"errors": [
31
31
+
{ "name": "RepoNotFound" },
32
32
+
{ "name": "RepoTakendown" },
33
33
+
{ "name": "RepoSuspended" },
34
34
+
{ "name": "RepoDeactivated" }
35
35
+
]
36
36
+
}
37
37
+
}
38
38
+
}
+37
share/lexicons/com/atproto/sync/getRecord.json
+37
share/lexicons/com/atproto/sync/getRecord.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getRecord",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did", "collection", "rkey"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the repo."
16
16
+
},
17
17
+
"collection": { "type": "string", "format": "nsid" },
18
18
+
"rkey": {
19
19
+
"type": "string",
20
20
+
"description": "Record Key",
21
21
+
"format": "record-key"
22
22
+
}
23
23
+
}
24
24
+
},
25
25
+
"output": {
26
26
+
"encoding": "application/vnd.ipld.car"
27
27
+
},
28
28
+
"errors": [
29
29
+
{ "name": "RecordNotFound" },
30
30
+
{ "name": "RepoNotFound" },
31
31
+
{ "name": "RepoTakendown" },
32
32
+
{ "name": "RepoSuspended" },
33
33
+
{ "name": "RepoDeactivated" }
34
34
+
]
35
35
+
}
36
36
+
}
37
37
+
}
+35
share/lexicons/com/atproto/sync/getRepo.json
+35
share/lexicons/com/atproto/sync/getRepo.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getRepo",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the repo."
16
16
+
},
17
17
+
"since": {
18
18
+
"type": "string",
19
19
+
"format": "tid",
20
20
+
"description": "The revision ('rev') of the repo to create a diff from."
21
21
+
}
22
22
+
}
23
23
+
},
24
24
+
"output": {
25
25
+
"encoding": "application/vnd.ipld.car"
26
26
+
},
27
27
+
"errors": [
28
28
+
{ "name": "RepoNotFound" },
29
29
+
{ "name": "RepoTakendown" },
30
30
+
{ "name": "RepoSuspended" },
31
31
+
{ "name": "RepoDeactivated" }
32
32
+
]
33
33
+
}
34
34
+
}
35
35
+
}
+50
share/lexicons/com/atproto/sync/getRepoStatus.json
+50
share/lexicons/com/atproto/sync/getRepoStatus.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.getRepoStatus",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the repo."
16
16
+
}
17
17
+
}
18
18
+
},
19
19
+
"output": {
20
20
+
"encoding": "application/json",
21
21
+
"schema": {
22
22
+
"type": "object",
23
23
+
"required": ["did", "active"],
24
24
+
"properties": {
25
25
+
"did": { "type": "string", "format": "did" },
26
26
+
"active": { "type": "boolean" },
27
27
+
"status": {
28
28
+
"type": "string",
29
29
+
"description": "If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.",
30
30
+
"knownValues": [
31
31
+
"takendown",
32
32
+
"suspended",
33
33
+
"deleted",
34
34
+
"deactivated",
35
35
+
"desynchronized",
36
36
+
"throttled"
37
37
+
]
38
38
+
},
39
39
+
"rev": {
40
40
+
"type": "string",
41
41
+
"format": "tid",
42
42
+
"description": "Optional field, the current rev of the repo, if active=true"
43
43
+
}
44
44
+
}
45
45
+
}
46
46
+
},
47
47
+
"errors": [{ "name": "RepoNotFound" }]
48
48
+
}
49
49
+
}
50
50
+
}
+53
share/lexicons/com/atproto/sync/listBlobs.json
+53
share/lexicons/com/atproto/sync/listBlobs.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.listBlobs",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "List blob CIDs for an account, since some repo revision. Does not require auth; implemented by PDS.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["did"],
11
11
+
"properties": {
12
12
+
"did": {
13
13
+
"type": "string",
14
14
+
"format": "did",
15
15
+
"description": "The DID of the repo."
16
16
+
},
17
17
+
"since": {
18
18
+
"type": "string",
19
19
+
"format": "tid",
20
20
+
"description": "Optional revision of the repo to list blobs since."
21
21
+
},
22
22
+
"limit": {
23
23
+
"type": "integer",
24
24
+
"minimum": 1,
25
25
+
"maximum": 1000,
26
26
+
"default": 500
27
27
+
},
28
28
+
"cursor": { "type": "string" }
29
29
+
}
30
30
+
},
31
31
+
"output": {
32
32
+
"encoding": "application/json",
33
33
+
"schema": {
34
34
+
"type": "object",
35
35
+
"required": ["cids"],
36
36
+
"properties": {
37
37
+
"cursor": { "type": "string" },
38
38
+
"cids": {
39
39
+
"type": "array",
40
40
+
"items": { "type": "string", "format": "cid" }
41
41
+
}
42
42
+
}
43
43
+
}
44
44
+
},
45
45
+
"errors": [
46
46
+
{ "name": "RepoNotFound" },
47
47
+
{ "name": "RepoTakendown" },
48
48
+
{ "name": "RepoSuspended" },
49
49
+
{ "name": "RepoDeactivated" }
50
50
+
]
51
51
+
}
52
52
+
}
53
53
+
}
+56
share/lexicons/com/atproto/sync/listHosts.json
+56
share/lexicons/com/atproto/sync/listHosts.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.listHosts",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Enumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"limit": {
12
12
+
"type": "integer",
13
13
+
"minimum": 1,
14
14
+
"maximum": 1000,
15
15
+
"default": 200
16
16
+
},
17
17
+
"cursor": { "type": "string" }
18
18
+
}
19
19
+
},
20
20
+
"output": {
21
21
+
"encoding": "application/json",
22
22
+
"schema": {
23
23
+
"type": "object",
24
24
+
"required": ["hosts"],
25
25
+
"properties": {
26
26
+
"cursor": { "type": "string" },
27
27
+
"hosts": {
28
28
+
"type": "array",
29
29
+
"items": { "type": "ref", "ref": "#host" },
30
30
+
"description": "Sort order is not formally specified. Recommended order is by time host was first seen by the server, with oldest first."
31
31
+
}
32
32
+
}
33
33
+
}
34
34
+
}
35
35
+
},
36
36
+
"host": {
37
37
+
"type": "object",
38
38
+
"required": ["hostname"],
39
39
+
"properties": {
40
40
+
"hostname": {
41
41
+
"type": "string",
42
42
+
"description": "hostname of server; not a URL (no scheme)"
43
43
+
},
44
44
+
"seq": {
45
45
+
"type": "integer",
46
46
+
"description": "Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor)."
47
47
+
},
48
48
+
"accountCount": { "type": "integer" },
49
49
+
"status": {
50
50
+
"type": "ref",
51
51
+
"ref": "com.atproto.sync.defs#hostStatus"
52
52
+
}
53
53
+
}
54
54
+
}
55
55
+
}
56
56
+
}
+62
share/lexicons/com/atproto/sync/listRepos.json
+62
share/lexicons/com/atproto/sync/listRepos.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.listRepos",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"limit": {
12
12
+
"type": "integer",
13
13
+
"minimum": 1,
14
14
+
"maximum": 1000,
15
15
+
"default": 500
16
16
+
},
17
17
+
"cursor": { "type": "string" }
18
18
+
}
19
19
+
},
20
20
+
"output": {
21
21
+
"encoding": "application/json",
22
22
+
"schema": {
23
23
+
"type": "object",
24
24
+
"required": ["repos"],
25
25
+
"properties": {
26
26
+
"cursor": { "type": "string" },
27
27
+
"repos": {
28
28
+
"type": "array",
29
29
+
"items": { "type": "ref", "ref": "#repo" }
30
30
+
}
31
31
+
}
32
32
+
}
33
33
+
}
34
34
+
},
35
35
+
"repo": {
36
36
+
"type": "object",
37
37
+
"required": ["did", "head", "rev"],
38
38
+
"properties": {
39
39
+
"did": { "type": "string", "format": "did" },
40
40
+
"head": {
41
41
+
"type": "string",
42
42
+
"format": "cid",
43
43
+
"description": "Current repo commit CID"
44
44
+
},
45
45
+
"rev": { "type": "string", "format": "tid" },
46
46
+
"active": { "type": "boolean" },
47
47
+
"status": {
48
48
+
"type": "string",
49
49
+
"description": "If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.",
50
50
+
"knownValues": [
51
51
+
"takendown",
52
52
+
"suspended",
53
53
+
"deleted",
54
54
+
"deactivated",
55
55
+
"desynchronized",
56
56
+
"throttled"
57
57
+
]
58
58
+
}
59
59
+
}
60
60
+
}
61
61
+
}
62
62
+
}
+46
share/lexicons/com/atproto/sync/listReposByCollection.json
+46
share/lexicons/com/atproto/sync/listReposByCollection.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.listReposByCollection",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Enumerates all the DIDs which have records with the given collection NSID.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["collection"],
11
11
+
"properties": {
12
12
+
"collection": { "type": "string", "format": "nsid" },
13
13
+
"limit": {
14
14
+
"type": "integer",
15
15
+
"description": "Maximum size of response set. Recommend setting a large maximum (1000+) when enumerating large DID lists.",
16
16
+
"minimum": 1,
17
17
+
"maximum": 2000,
18
18
+
"default": 500
19
19
+
},
20
20
+
"cursor": { "type": "string" }
21
21
+
}
22
22
+
},
23
23
+
"output": {
24
24
+
"encoding": "application/json",
25
25
+
"schema": {
26
26
+
"type": "object",
27
27
+
"required": ["repos"],
28
28
+
"properties": {
29
29
+
"cursor": { "type": "string" },
30
30
+
"repos": {
31
31
+
"type": "array",
32
32
+
"items": { "type": "ref", "ref": "#repo" }
33
33
+
}
34
34
+
}
35
35
+
}
36
36
+
}
37
37
+
},
38
38
+
"repo": {
39
39
+
"type": "object",
40
40
+
"required": ["did"],
41
41
+
"properties": {
42
42
+
"did": { "type": "string", "format": "did" }
43
43
+
}
44
44
+
}
45
45
+
}
46
46
+
}
+23
share/lexicons/com/atproto/sync/notifyOfUpdate.json
+23
share/lexicons/com/atproto/sync/notifyOfUpdate.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.notifyOfUpdate",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Notify a crawling service of a recent update, and that crawling should resume. Intended use is after a gap between repo stream events caused the crawling service to disconnect. Does not require auth; implemented by Relay. DEPRECATED: just use com.atproto.sync.requestCrawl",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["hostname"],
13
13
+
"properties": {
14
14
+
"hostname": {
15
15
+
"type": "string",
16
16
+
"description": "Hostname of the current service (usually a PDS) that is notifying of update."
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
+24
share/lexicons/com/atproto/sync/requestCrawl.json
+24
share/lexicons/com/atproto/sync/requestCrawl.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.requestCrawl",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["hostname"],
13
13
+
"properties": {
14
14
+
"hostname": {
15
15
+
"type": "string",
16
16
+
"description": "Hostname of the current service (eg, PDS) that is requesting to be crawled."
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
},
21
21
+
"errors": [{ "name": "HostBanned" }]
22
22
+
}
23
23
+
}
24
24
+
}
+215
share/lexicons/com/atproto/sync/subscribeRepos.json
+215
share/lexicons/com/atproto/sync/subscribeRepos.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.sync.subscribeRepos",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "subscription",
7
7
+
"description": "Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"cursor": {
12
12
+
"type": "integer",
13
13
+
"description": "The last known event seq number to backfill from."
14
14
+
}
15
15
+
}
16
16
+
},
17
17
+
"message": {
18
18
+
"schema": {
19
19
+
"type": "union",
20
20
+
"refs": ["#commit", "#sync", "#identity", "#account", "#info"]
21
21
+
}
22
22
+
},
23
23
+
"errors": [
24
24
+
{ "name": "FutureCursor" },
25
25
+
{
26
26
+
"name": "ConsumerTooSlow",
27
27
+
"description": "If the consumer of the stream can not keep up with events, and a backlog gets too large, the server will drop the connection."
28
28
+
}
29
29
+
]
30
30
+
},
31
31
+
"commit": {
32
32
+
"type": "object",
33
33
+
"description": "Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature.",
34
34
+
"required": [
35
35
+
"seq",
36
36
+
"rebase",
37
37
+
"tooBig",
38
38
+
"repo",
39
39
+
"commit",
40
40
+
"rev",
41
41
+
"since",
42
42
+
"blocks",
43
43
+
"ops",
44
44
+
"blobs",
45
45
+
"time"
46
46
+
],
47
47
+
"nullable": ["since"],
48
48
+
"properties": {
49
49
+
"seq": {
50
50
+
"type": "integer",
51
51
+
"description": "The stream sequence number of this message."
52
52
+
},
53
53
+
"rebase": { "type": "boolean", "description": "DEPRECATED -- unused" },
54
54
+
"tooBig": {
55
55
+
"type": "boolean",
56
56
+
"description": "DEPRECATED -- replaced by #sync event and data limits. Indicates that this commit contained too many ops, or data size was too large. Consumers will need to make a separate request to get missing data."
57
57
+
},
58
58
+
"repo": {
59
59
+
"type": "string",
60
60
+
"format": "did",
61
61
+
"description": "The repo this event comes from. Note that all other message types name this field 'did'."
62
62
+
},
63
63
+
"commit": {
64
64
+
"type": "cid-link",
65
65
+
"description": "Repo commit object CID."
66
66
+
},
67
67
+
"rev": {
68
68
+
"type": "string",
69
69
+
"format": "tid",
70
70
+
"description": "The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event."
71
71
+
},
72
72
+
"since": {
73
73
+
"type": "string",
74
74
+
"format": "tid",
75
75
+
"description": "The rev of the last emitted commit from this repo (if any)."
76
76
+
},
77
77
+
"blocks": {
78
78
+
"type": "bytes",
79
79
+
"description": "CAR file containing relevant blocks, as a diff since the previous repo state. The commit must be included as a block, and the commit block CID must be the first entry in the CAR header 'roots' list.",
80
80
+
"maxLength": 2000000
81
81
+
},
82
82
+
"ops": {
83
83
+
"type": "array",
84
84
+
"items": {
85
85
+
"type": "ref",
86
86
+
"ref": "#repoOp",
87
87
+
"description": "List of repo mutation operations in this commit (eg, records created, updated, or deleted)."
88
88
+
},
89
89
+
"maxLength": 200
90
90
+
},
91
91
+
"blobs": {
92
92
+
"type": "array",
93
93
+
"items": {
94
94
+
"type": "cid-link",
95
95
+
"description": "DEPRECATED -- will soon always be empty. List of new blobs (by CID) referenced by records in this commit."
96
96
+
}
97
97
+
},
98
98
+
"prevData": {
99
99
+
"type": "cid-link",
100
100
+
"description": "The root CID of the MST tree for the previous commit from this repo (indicated by the 'since' revision field in this message). Corresponds to the 'data' field in the repo commit object. NOTE: this field is effectively required for the 'inductive' version of firehose."
101
101
+
},
102
102
+
"time": {
103
103
+
"type": "string",
104
104
+
"format": "datetime",
105
105
+
"description": "Timestamp of when this message was originally broadcast."
106
106
+
}
107
107
+
}
108
108
+
},
109
109
+
"sync": {
110
110
+
"type": "object",
111
111
+
"description": "Updates the repo to a new state, without necessarily including that state on the firehose. Used to recover from broken commit streams, data loss incidents, or in situations where upstream host does not know recent state of the repository.",
112
112
+
"required": ["seq", "did", "blocks", "rev", "time"],
113
113
+
"properties": {
114
114
+
"seq": {
115
115
+
"type": "integer",
116
116
+
"description": "The stream sequence number of this message."
117
117
+
},
118
118
+
"did": {
119
119
+
"type": "string",
120
120
+
"format": "did",
121
121
+
"description": "The account this repo event corresponds to. Must match that in the commit object."
122
122
+
},
123
123
+
"blocks": {
124
124
+
"type": "bytes",
125
125
+
"description": "CAR file containing the commit, as a block. The CAR header must include the commit block CID as the first 'root'.",
126
126
+
"maxLength": 10000
127
127
+
},
128
128
+
"rev": {
129
129
+
"type": "string",
130
130
+
"description": "The rev of the commit. This value must match that in the commit object."
131
131
+
},
132
132
+
"time": {
133
133
+
"type": "string",
134
134
+
"format": "datetime",
135
135
+
"description": "Timestamp of when this message was originally broadcast."
136
136
+
}
137
137
+
}
138
138
+
},
139
139
+
"identity": {
140
140
+
"type": "object",
141
141
+
"description": "Represents a change to an account's identity. Could be an updated handle, signing key, or pds hosting endpoint. Serves as a prod to all downstream services to refresh their identity cache.",
142
142
+
"required": ["seq", "did", "time"],
143
143
+
"properties": {
144
144
+
"seq": { "type": "integer" },
145
145
+
"did": { "type": "string", "format": "did" },
146
146
+
"time": { "type": "string", "format": "datetime" },
147
147
+
"handle": {
148
148
+
"type": "string",
149
149
+
"format": "handle",
150
150
+
"description": "The current handle for the account, or 'handle.invalid' if validation fails. This field is optional, might have been validated or passed-through from an upstream source. Semantics and behaviors for PDS vs Relay may evolve in the future; see atproto specs for more details."
151
151
+
}
152
152
+
}
153
153
+
},
154
154
+
"account": {
155
155
+
"type": "object",
156
156
+
"description": "Represents a change to an account's status on a host (eg, PDS or Relay). The semantics of this event are that the status is at the host which emitted the event, not necessarily that at the currently active PDS. Eg, a Relay takedown would emit a takedown with active=false, even if the PDS is still active.",
157
157
+
"required": ["seq", "did", "time", "active"],
158
158
+
"properties": {
159
159
+
"seq": { "type": "integer" },
160
160
+
"did": { "type": "string", "format": "did" },
161
161
+
"time": { "type": "string", "format": "datetime" },
162
162
+
"active": {
163
163
+
"type": "boolean",
164
164
+
"description": "Indicates that the account has a repository which can be fetched from the host that emitted this event."
165
165
+
},
166
166
+
"status": {
167
167
+
"type": "string",
168
168
+
"description": "If active=false, this optional field indicates a reason for why the account is not active.",
169
169
+
"knownValues": [
170
170
+
"takendown",
171
171
+
"suspended",
172
172
+
"deleted",
173
173
+
"deactivated",
174
174
+
"desynchronized",
175
175
+
"throttled"
176
176
+
]
177
177
+
}
178
178
+
}
179
179
+
},
180
180
+
"info": {
181
181
+
"type": "object",
182
182
+
"required": ["name"],
183
183
+
"properties": {
184
184
+
"name": {
185
185
+
"type": "string",
186
186
+
"knownValues": ["OutdatedCursor"]
187
187
+
},
188
188
+
"message": {
189
189
+
"type": "string"
190
190
+
}
191
191
+
}
192
192
+
},
193
193
+
"repoOp": {
194
194
+
"type": "object",
195
195
+
"description": "A repo operation, ie a mutation of a single record.",
196
196
+
"required": ["action", "path", "cid"],
197
197
+
"nullable": ["cid"],
198
198
+
"properties": {
199
199
+
"action": {
200
200
+
"type": "string",
201
201
+
"knownValues": ["create", "update", "delete"]
202
202
+
},
203
203
+
"path": { "type": "string" },
204
204
+
"cid": {
205
205
+
"type": "cid-link",
206
206
+
"description": "For creates and updates, the new record CID. For deletions, null."
207
207
+
},
208
208
+
"prev": {
209
209
+
"type": "cid-link",
210
210
+
"description": "For updates and deletes, the previous record CID (required for inductive firehose). For creations, field should not be defined."
211
211
+
}
212
212
+
}
213
213
+
}
214
214
+
}
215
215
+
}
+27
share/lexicons/com/atproto/temp/addReservedHandle.json
+27
share/lexicons/com/atproto/temp/addReservedHandle.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.temp.addReservedHandle",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Add a handle to the set of reserved handles.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["handle"],
13
13
+
"properties": {
14
14
+
"handle": { "type": "string" }
15
15
+
}
16
16
+
}
17
17
+
},
18
18
+
"output": {
19
19
+
"encoding": "application/json",
20
20
+
"schema": {
21
21
+
"type": "object",
22
22
+
"properties": {}
23
23
+
}
24
24
+
}
25
25
+
}
26
26
+
}
27
27
+
}
+88
share/lexicons/com/atproto/temp/checkHandleAvailability.json
+88
share/lexicons/com/atproto/temp/checkHandleAvailability.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.temp.checkHandleAvailability",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Checks whether the provided handle is available. If the handle is not available, available suggestions will be returned. Optional inputs will be used to generate suggestions.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["handle"],
11
11
+
"properties": {
12
12
+
"handle": {
13
13
+
"type": "string",
14
14
+
"format": "handle",
15
15
+
"description": "Tentative handle. Will be checked for availability or used to build handle suggestions."
16
16
+
},
17
17
+
"email": {
18
18
+
"type": "string",
19
19
+
"description": "User-provided email. Might be used to build handle suggestions."
20
20
+
},
21
21
+
"birthDate": {
22
22
+
"type": "string",
23
23
+
"format": "datetime",
24
24
+
"description": "User-provided birth date. Might be used to build handle suggestions."
25
25
+
}
26
26
+
}
27
27
+
},
28
28
+
"output": {
29
29
+
"encoding": "application/json",
30
30
+
"schema": {
31
31
+
"type": "object",
32
32
+
"required": ["handle", "result"],
33
33
+
"properties": {
34
34
+
"handle": {
35
35
+
"type": "string",
36
36
+
"format": "handle",
37
37
+
"description": "Echo of the input handle."
38
38
+
},
39
39
+
"result": {
40
40
+
"type": "union",
41
41
+
"refs": ["#resultAvailable", "#resultUnavailable"]
42
42
+
}
43
43
+
}
44
44
+
}
45
45
+
},
46
46
+
"errors": [
47
47
+
{
48
48
+
"name": "InvalidEmail",
49
49
+
"description": "An invalid email was provided."
50
50
+
}
51
51
+
]
52
52
+
},
53
53
+
"resultAvailable": {
54
54
+
"type": "object",
55
55
+
"description": "Indicates the provided handle is available.",
56
56
+
"properties": {}
57
57
+
},
58
58
+
"resultUnavailable": {
59
59
+
"type": "object",
60
60
+
"description": "Indicates the provided handle is unavailable and gives suggestions of available handles.",
61
61
+
"required": ["suggestions"],
62
62
+
"properties": {
63
63
+
"suggestions": {
64
64
+
"type": "array",
65
65
+
"description": "List of suggested handles based on the provided inputs.",
66
66
+
"items": {
67
67
+
"type": "ref",
68
68
+
"ref": "#suggestion"
69
69
+
}
70
70
+
}
71
71
+
}
72
72
+
},
73
73
+
"suggestion": {
74
74
+
"type": "object",
75
75
+
"required": ["handle", "method"],
76
76
+
"properties": {
77
77
+
"handle": {
78
78
+
"type": "string",
79
79
+
"format": "handle"
80
80
+
},
81
81
+
"method": {
82
82
+
"type": "string",
83
83
+
"description": "Method used to build this suggestion. Should be considered opaque to clients. Can be used for metrics."
84
84
+
}
85
85
+
}
86
86
+
}
87
87
+
}
88
88
+
}
+22
share/lexicons/com/atproto/temp/checkSignupQueue.json
+22
share/lexicons/com/atproto/temp/checkSignupQueue.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.temp.checkSignupQueue",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Check accounts location in signup queue.",
8
8
+
"output": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["activated"],
13
13
+
"properties": {
14
14
+
"activated": { "type": "boolean" },
15
15
+
"placeInQueue": { "type": "integer" },
16
16
+
"estimatedTimeMs": { "type": "integer" }
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
+39
share/lexicons/com/atproto/temp/dereferenceScope.json
+39
share/lexicons/com/atproto/temp/dereferenceScope.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.temp.dereferenceScope",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "Allows finding the oauth permission scope from a reference",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"required": ["scope"],
11
11
+
"properties": {
12
12
+
"scope": {
13
13
+
"type": "string",
14
14
+
"description": "The scope reference (starts with 'ref:')"
15
15
+
}
16
16
+
}
17
17
+
},
18
18
+
"output": {
19
19
+
"encoding": "application/json",
20
20
+
"schema": {
21
21
+
"type": "object",
22
22
+
"required": ["scope"],
23
23
+
"properties": {
24
24
+
"scope": {
25
25
+
"type": "string",
26
26
+
"description": "The full oauth permission scope"
27
27
+
}
28
28
+
}
29
29
+
}
30
30
+
},
31
31
+
"errors": [
32
32
+
{
33
33
+
"name": "InvalidScopeReference",
34
34
+
"description": "An invalid scope reference was provided."
35
35
+
}
36
36
+
]
37
37
+
}
38
38
+
}
39
39
+
}
+35
share/lexicons/com/atproto/temp/fetchLabels.json
+35
share/lexicons/com/atproto/temp/fetchLabels.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.temp.fetchLabels",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "query",
7
7
+
"description": "DEPRECATED: use queryLabels or subscribeLabels instead -- Fetch all labels from a labeler created after a certain date.",
8
8
+
"parameters": {
9
9
+
"type": "params",
10
10
+
"properties": {
11
11
+
"since": { "type": "integer" },
12
12
+
"limit": {
13
13
+
"type": "integer",
14
14
+
"minimum": 1,
15
15
+
"maximum": 250,
16
16
+
"default": 50
17
17
+
}
18
18
+
}
19
19
+
},
20
20
+
"output": {
21
21
+
"encoding": "application/json",
22
22
+
"schema": {
23
23
+
"type": "object",
24
24
+
"required": ["labels"],
25
25
+
"properties": {
26
26
+
"labels": {
27
27
+
"type": "array",
28
28
+
"items": { "type": "ref", "ref": "com.atproto.label.defs#label" }
29
29
+
}
30
30
+
}
31
31
+
}
32
32
+
}
33
33
+
}
34
34
+
}
35
35
+
}
+20
share/lexicons/com/atproto/temp/requestPhoneVerification.json
+20
share/lexicons/com/atproto/temp/requestPhoneVerification.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.temp.requestPhoneVerification",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Request a verification code to be sent to the supplied phone number",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["phoneNumber"],
13
13
+
"properties": {
14
14
+
"phoneNumber": { "type": "string" }
15
15
+
}
16
16
+
}
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
+23
share/lexicons/com/atproto/temp/revokeAccountCredentials.json
+23
share/lexicons/com/atproto/temp/revokeAccountCredentials.json
···
1
1
+
{
2
2
+
"lexicon": 1,
3
3
+
"id": "com.atproto.temp.revokeAccountCredentials",
4
4
+
"defs": {
5
5
+
"main": {
6
6
+
"type": "procedure",
7
7
+
"description": "Revoke sessions, password, and app passwords associated with account. May be resolved by a password reset.",
8
8
+
"input": {
9
9
+
"encoding": "application/json",
10
10
+
"schema": {
11
11
+
"type": "object",
12
12
+
"required": ["account"],
13
13
+
"properties": {
14
14
+
"account": {
15
15
+
"type": "string",
16
16
+
"format": "at-identifier"
17
17
+
}
18
18
+
}
19
19
+
}
20
20
+
}
21
21
+
}
22
22
+
}
23
23
+
}
+31
tools/sync_lexicons.pl
+31
tools/sync_lexicons.pl
···
1
1
+
#!/usr/bin/env perl
2
2
+
use v5.34;
3
3
+
use warnings;
4
4
+
5
5
+
use File::Copy qw(copy);
6
6
+
use File::Path qw(make_path);
7
7
+
use File::Spec;
8
8
+
9
9
+
my $source_root = '.vendor/atproto/lexicons/com/atproto';
10
10
+
my $dest_root = 'share/lexicons/com/atproto';
11
11
+
my @namespaces = qw(server identity repo sync admin moderation lexicon temp label);
12
12
+
13
13
+
for my $namespace (@namespaces) {
14
14
+
my $source_dir = File::Spec->catdir($source_root, $namespace);
15
15
+
next unless -d $source_dir;
16
16
+
17
17
+
my $dest_dir = File::Spec->catdir($dest_root, $namespace);
18
18
+
make_path($dest_dir);
19
19
+
20
20
+
opendir(my $dh, $source_dir) or die "opendir($source_dir): $!";
21
21
+
while (my $entry = readdir($dh)) {
22
22
+
next if $entry =~ /^\./;
23
23
+
next unless $entry =~ /\.json\z/;
24
24
+
25
25
+
my $from = File::Spec->catfile($source_dir, $entry);
26
26
+
my $to = File::Spec->catfile($dest_dir, $entry);
27
27
+
copy($from, $to) or die "copy($from, $to): $!";
28
28
+
say $to;
29
29
+
}
30
30
+
closedir($dh);
31
31
+
}