garden.lexicon.resolveTrace
Resolve an NSID from the network and report each step: the authority domain, the _lexicon TXT record, the DID document, the com.atproto.lexicon.schema record and validation. A lexicon that resolves is stored and indexed. Steps answered from Lexicon Garden's caches make no network request; traces that do count against a per-client rate limit.
Details · query
| Kind | query |
|---|---|
| Authority | lexicon.garden |
| Commit rev | 3mzw7lcmvmw2d |
| Indexed |
Checks
Validunlimited-stringdefs.main.output.schema.properties.outcomeNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.step.properties.idNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.step.properties.statusNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"link": {
"properties": {
"href": {
"description": "A path on this site.",
"maxLength": 512,
"type": "string"
},
"text": {
"maxLength": 300,
"type": "string"
}
},
"required": [
"href",
"text"
],
"type": "object"
},
"main": {
"description": "Resolve an NSID from the network and report each step: the authority domain, the _lexicon TXT record, the DID document, the com.atproto.lexicon.schema record and validation. A lexicon that resolves is stored and indexed. Steps answered from Lexicon Garden's caches make no network request; traces that do count against a per-client rate limit.",
"errors": [
{
"description": "The nsid parameter is not a valid NSID.",
"name": "InvalidRequest"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cid": {
"description": "The schema record's CID, computed from the record, when the outcome is found.",
"format": "cid",
"type": "string"
},
"lexiconType": {
"description": "The type of the lexicon's main def, when the outcome is found and it has one.",
"knownValues": [
"record",
"query",
"procedure",
"subscription",
"permission-set"
],
"maxLength": 32,
"type": "string"
},
"link": {
"ref": "#link",
"type": "ref"
},
"message": {
"description": "A sentence describing the outcome, for display.",
"maxLength": 300,
"type": "string"
},
"nsid": {
"format": "nsid",
"type": "string"
},
"outcome": {
"knownValues": [
"found",
"failed",
"timeout"
],
"type": "string"
},
"steps": {
"description": "The five steps in order. A failed step leaves every later step pending.",
"items": {
"ref": "#step",
"type": "ref"
},
"maxLength": 5,
"minLength": 5,
"type": "array"
},
"uri": {
"description": "The schema record's AT-URI, when the outcome is found.",
"format": "at-uri",
"type": "string"
}
},
"required": [
"nsid",
"steps",
"outcome",
"message"
],
"type": "object"
}
},
"parameters": {
"properties": {
"nsid": {
"description": "The NSID to resolve.",
"format": "nsid",
"type": "string"
}
},
"required": [
"nsid"
],
"type": "params"
},
"type": "query"
},
"step": {
"properties": {
"detail": {
"description": "What the step found, or why it failed.",
"maxLength": 2000,
"type": "string"
},
"id": {
"knownValues": [
"authority",
"dns",
"did",
"record",
"index"
],
"type": "string"
},
"label": {
"maxLength": 64,
"type": "string"
},
"status": {
"knownValues": [
"done",
"failed",
"pending"
],
"type": "string"
}
},
"required": [
"id",
"label",
"status",
"detail"
],
"type": "object"
}
},
"id": "garden.lexicon.resolveTrace",
"lexicon": 1
}