Skip to content

Commit 94ddc82

Browse files
bnewboldngerakinesmatthieusieben
authored
resolveLexicon endpoint (#4227)
* Add resolveLexicon.json for lexicon resolution * Update lexicons/com/atproto/lexicon/resolveLexicon.json * chore: formatting and linting * chore: Adding changeset information * documentation: Updating descriptions for properties. * refactor: Updating com.atproto.lexicon.resolveLexicon lexicon schema from PR discussion and feedback * Update lexicons/com/atproto/lexicon/resolveLexicon.json Co-authored-by: Nick Gerakines <[email protected]> * tweak changeset * lexicon codegen --------- Co-authored-by: Nick Gerakines <[email protected]> Co-authored-by: Matthieu Sieben <[email protected]>
1 parent 1002120 commit 94ddc82

File tree

14 files changed

+510
-0
lines changed

14 files changed

+510
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@atproto/api": minor
3+
---
4+
5+
Introduce `com.atproto.lexicon.resolveLexicon` lexicon method
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"lexicon": 1,
3+
"id": "com.atproto.lexicon.resolveLexicon",
4+
"defs": {
5+
"main": {
6+
"type": "query",
7+
"description": "Resolves an atproto lexicon (NSID) to a schema.",
8+
"parameters": {
9+
"type": "params",
10+
"properties": {
11+
"nsid": {
12+
"format": "nsid",
13+
"type": "string",
14+
"description": "The lexicon NSID to resolve."
15+
}
16+
},
17+
"required": ["nsid"]
18+
},
19+
"output": {
20+
"encoding": "application/json",
21+
"schema": {
22+
"type": "object",
23+
"properties": {
24+
"cid": {
25+
"type": "string",
26+
"format": "cid",
27+
"description": "The CID of the lexicon schema record."
28+
},
29+
"schema": {
30+
"type": "ref",
31+
"ref": "com.atproto.lexicon.schema#main",
32+
"description": "The resolved lexicon schema record."
33+
},
34+
"uri": {
35+
"type": "string",
36+
"format": "at-uri",
37+
"description": "The AT-URI of the lexicon schema record."
38+
}
39+
},
40+
"required": ["uri", "cid", "schema"]
41+
}
42+
},
43+
"errors": [
44+
{
45+
"description": "No lexicon was resolved for the NSID.",
46+
"name": "LexiconNotFound"
47+
}
48+
]
49+
}
50+
}
51+
}

packages/api/src/client/index.ts

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/api/src/client/lexicons.ts

Lines changed: 52 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/api/src/client/types/com/atproto/lexicon/resolveLexicon.ts

Lines changed: 56 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/bsky/src/lexicon/index.ts

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/bsky/src/lexicon/lexicons.ts

Lines changed: 52 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/bsky/src/lexicon/types/com/atproto/lexicon/resolveLexicon.ts

Lines changed: 46 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/ozone/src/lexicon/index.ts

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)