From: Thomas Lamprecht <t.lamprecht@proxmox.com>
Date: Tue, 29 Nov 2022 14:55:00 +0000 (+0100)
Subject: update static schema info
X-Git-Url: https://git.proxmox.com/?p=pmg-docs.git;a=commitdiff_plain;h=f4831d949fc53c0c6589241acdcd5f39442d94bd

update static schema info

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
---

diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js
index db6899b..a1662b0 100644
--- a/api-viewer/apidata.js
+++ b/api-viewer/apidata.js
@@ -12547,7 +12547,14 @@ var apiSchema = [
                                     "parameters" : {
                                        "additionalProperties" : 0,
                                        "properties" : {
+                                          "download" : {
+                                             "description" : "Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters",
+                                             "optional" : 1,
+                                             "type" : "boolean",
+                                             "typetext" : "<boolean>"
+                                          },
                                           "limit" : {
+                                             "description" : "The amount of lines to read from the tasklog.",
                                              "minimum" : 0,
                                              "optional" : 1,
                                              "type" : "integer",
@@ -12560,6 +12567,7 @@ var apiSchema = [
                                              "typetext" : "<string>"
                                           },
                                           "start" : {
+                                             "description" : "Start at this line when reading the tasklog",
                                              "minimum" : 0,
                                              "optional" : 1,
                                              "type" : "integer",
@@ -17632,6 +17640,17 @@ var apiSchema = [
                            "type" : "integer",
                            "typetext" : "<integer> (1 - N)"
                         },
+                        "quarantine-type" : {
+                           "default" : "spam",
+                           "description" : "Query this type of quarantine for users.",
+                           "enum" : [
+                              "attachment",
+                              "virus",
+                              "spam"
+                           ],
+                           "optional" : 1,
+                           "type" : "string"
+                        },
                         "starttime" : {
                            "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
                            "minimum" : 0,
@@ -17866,6 +17885,14 @@ var apiSchema = [
                            "type" : "integer",
                            "typetext" : "<integer> (1 - N)"
                         },
+                        "pmail" : {
+                           "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
+                           "maxLength" : 512,
+                           "minLength" : 3,
+                           "optional" : 1,
+                           "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
+                           "type" : "string"
+                        },
                         "starttime" : {
                            "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
                            "minimum" : 0,
@@ -17950,6 +17977,14 @@ var apiSchema = [
                            "type" : "integer",
                            "typetext" : "<integer> (1 - N)"
                         },
+                        "pmail" : {
+                           "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
+                           "maxLength" : 512,
+                           "minLength" : 3,
+                           "optional" : 1,
+                           "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
+                           "type" : "string"
+                        },
                         "starttime" : {
                            "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
                            "minimum" : 0,
@@ -18205,7 +18240,8 @@ var apiSchema = [
                      "check" : [
                         "admin",
                         "qmanager",
-                        "audit"
+                        "audit",
+                        "quser"
                      ]
                   },
                   "returns" : {
diff --git a/pmgqm.1-synopsis.adoc b/pmgqm.1-synopsis.adoc
index 9400f94..373b55b 100644
--- a/pmgqm.1-synopsis.adoc
+++ b/pmgqm.1-synopsis.adoc
@@ -29,11 +29,11 @@ Generate and send spam report emails.
 
 Debug mode. Print raw email to stdout instead of sending them.
 
-`--receiver` `<string>` ::
+`--receiver` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
 
 Generate report for a single email address. If not specified, generate reports for all users.
 
-`--redirect` `<string>` ::
+`--redirect` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
 
 Redirect spam report email to this address.