toolsOzoneSafelinkRemoveRule top-level constant

Implementation

const toolsOzoneSafelinkRemoveRule = <String, dynamic>{
  "lexicon": 1,
  "id": "tools.ozone.safelink.removeRule",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Remove an existing URL safety rule",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": ["url", "pattern"],
          "properties": {
            "url": {
              "type": "string",
              "description": "The URL or domain to remove the rule for",
            },
            "pattern": {
              "type": "ref",
              "ref": "tools.ozone.safelink.defs#patternType",
            },
            "comment": {
              "type": "string",
              "description":
                  "Optional comment about why the rule is being removed",
            },
            "createdBy": {
              "type": "string",
              "format": "did",
              "description":
                  "Optional DID of the user. Only respected when using admin auth.",
            },
          },
        },
      },
      "output": {
        "encoding": "application/json",
        "schema": {"type": "ref", "ref": "tools.ozone.safelink.defs#event"},
      },
      "errors": [
        {
          "name": "RuleNotFound",
          "description": "No active rule found for this URL/domain",
        },
      ],
    },
  },
};