pub.oysters.getPostThread

{
  "lexicon": 1,
  "id": "pub.oysters.getPostThread",
  "defs": {
    "main": {
      "type": "query",
      "description": "A submission and its discussion.",
      "parameters": {
        "type": "params",
        "required": [
          "uri"
        ],
        "properties": {
          "uri": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of the submission."
          },
          "depth": {
            "type": "integer",
            "description": "How many levels of replies to include. Beyond this, a comment's replies come back empty.",
            "minimum": 0,
            "maximum": 12,
            "default": 12
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "thread"
          ],
          "properties": {
            "thread": {
              "type": "ref",
              "ref": "pub.oysters.defs#threadViewPost",
              "description": "The submission and its replies."
            }
          }
        }
      },
      "errors": [
        {
          "name": "NotFound",
          "description": "No submission at that URI, or it has been deleted."
        },
        {
          "name": "InvalidRequest",
          "description": "The URI is not an AT-URI in one of this board's collections."
        }
      ]
    }
  }
}