Lexicon Garden

com.getorbyt.community.createReport

Creates a private Community-moderator report for a linked post. Requires authenticated service authorization.

Repository @getorbyt.com did:plc:2xrqztnmzlckb3xfuuukupso namespace authority
Details · procedure
Kindprocedure
Authoritycommunity.getorbyt.com
Indexed
Compare Edit in builder → Fork →
cid bafyreibyzyfahaycn3pvfvucxvxop7e5ljfpfvietn7kn52a2fzhiidfzu

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.reasonTypeNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Creates a private Community-moderator report for a linked post. Requires authenticated service authorization.",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "CommunityNotFound"
        },
        {
          "name": "PostNotFound"
        },
        {
          "name": "RateLimitExceeded"
        },
        {
          "name": "InvalidRequest"
        },
        {
          "name": "RuleNotFound"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "community": {
              "format": "at-uri",
              "type": "string"
            },
            "details": {
              "description": "Anything the reporter wants moderators to know.",
              "maxLength": 2000,
              "type": "string"
            },
            "post": {
              "format": "at-uri",
              "type": "string"
            },
            "reason": {
              "description": "Human-readable reason, shown by builds that do not read reasonType.",
              "maxLength": 2000,
              "minLength": 1,
              "type": "string"
            },
            "reasonType": {
              "knownValues": [
                "rule",
                "spam",
                "harassment",
                "unsafe",
                "other"
              ],
              "type": "string"
            },
            "ruleIndex": {
              "description": "With reasonType rule: the position of the broken rule in the Community's rules.",
              "minimum": 0,
              "type": "integer"
            }
          },
          "required": [
            "community",
            "post",
            "reason"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "created": {
              "type": "boolean"
            },
            "report": {
              "ref": "com.getorbyt.community.defs#reportView",
              "type": "ref"
            }
          },
          "required": [
            "report",
            "created"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "com.getorbyt.community.createReport",
  "lexicon": 1
}