chat.yakka.resolveChannel

yakka.chat

Documentation

Resolve a URL's channel segment, which may be a name or a TID. Called by the client's route guard before anything renders. The five outcomes are distinct on purpose. Collapsing them would either lie about deleted channels or hide gated ones, and both are facts a reader is entitled to. `forbidden` deliberately reveals that a channel exists — which is safe only because channels are whole spaces and the credential mint has already made the same disclosure (ADR 0007).

main query

Resolve a URL's channel segment, which may be a name or a TID. Called by the client's route guard before anything renders. The five outcomes are distinct on purpose. Collapsing them would either lie about deleted channels or hide gated ones, and both are facts a reader is entitled to. `forbidden` deliberately reveals that a channel exists — which is safe only because channels are whole spaces and the credential mint has already made the same disclosure (ADR 0007).

Parameters

ref string Required

A channel name or a channel TID.

server string did Required

The server's DID.

Output

Encodingapplication/json
Schema#output
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
A channel name or a channel TID.
The server's DID.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "ref": "#output",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "server",
      "ref"
    ],
    "properties": {
      "ref": {
        "type": "string",
        "description": "A channel name or a channel TID."
      },
      "server": {
        "type": "string",
        "format": "did",
        "description": "The server's DID."
      }
    }
  },
  "description": "Resolve a URL's channel segment, which may be a name or a TID. Called by the client's route guard before anything renders.\n\nThe five outcomes are distinct on purpose. Collapsing them would either lie about deleted channels or hide gated ones, and both are facts a reader is entitled to. `forbidden` deliberately reveals that a channel exists — which is safe only because channels are whole spaces and the credential mint has already made the same disclosure (ADR 0007)."
}
output object

No description available.

Properties

kind string Required

`renamed` means the ref matched by TID rather than by name — the caller should redirect to the name it now has.

Known values: ok, renamed, forbidden, gone, notFound
name string Optional

The name a `gone` channel had, so a tombstone can say what it was.

View raw schema 
{
  "type": "object",
  "required": [
    "kind"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "description": "`renamed` means the ref matched by TID rather than by name — the caller should redirect to the name it now has.",
      "knownValues": [
        "ok",
        "renamed",
        "forbidden",
        "gone",
        "notFound"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name a `gone` channel had, so a tombstone can say what it was."
    },
    "channel": {
      "ref": "chat.yakka.defs#channelView",
      "type": "ref"
    }
  }
}

Lexicon Garden

@