]> git.proxmox.com Git - pmg-docs.git/commitdiff
update static schema info
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Thu, 10 Nov 2022 12:29:01 +0000 (13:29 +0100)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Thu, 10 Nov 2022 12:29:01 +0000 (13:29 +0100)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
api-viewer/apidata.js
pmgbackup.1-synopsis.adoc
pmgsubscription.1-synopsis.adoc

index 21864db1ac79474b83b8ef391c7287950468463f..db6899ba9077dc1b4be3b80b946d6df7bd85ada6 100644 (file)
@@ -5833,9 +5833,10 @@ var apiSchema = [
                                        "properties" : {
                                           "email" : {
                                              "description" : "Email address.",
-                                             "format" : "email",
-                                             "type" : "string",
-                                             "typetext" : "<string>"
+                                             "maxLength" : 512,
+                                             "minLength" : 3,
+                                             "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
+                                             "type" : "string"
                                           },
                                           "profile" : {
                                              "description" : "Profile ID.",
@@ -8571,8 +8572,8 @@ var apiSchema = [
                               "datastore" : {
                                  "description" : "Proxmox Backup Server datastore name.",
                                  "optional" : 1,
-                                 "type" : "string",
-                                 "typetext" : "<string>"
+                                 "pattern" : "(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)",
+                                 "type" : "string"
                               },
                               "delete" : {
                                  "description" : "A list of settings you want to delete.",
@@ -8655,6 +8656,13 @@ var apiSchema = [
                                  "type" : "integer",
                                  "typetext" : "<N>"
                               },
+                              "namespace" : {
+                                 "description" : "Proxmox Backup Server namespace in the datastore, defaults to the root NS.",
+                                 "maxLength" : 256,
+                                 "optional" : 1,
+                                 "pattern" : "(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*))?",
+                                 "type" : "string"
+                              },
                               "notify" : {
                                  "description" : "Specify when to notify via e-mail",
                                  "enum" : [
@@ -8737,6 +8745,7 @@ var apiSchema = [
                            "datastore" : {
                               "description" : "Proxmox Backup Server datastore name.",
                               "optional" : 0,
+                              "pattern" : "(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)",
                               "type" : "string"
                            },
                            "disable" : {
@@ -8797,6 +8806,13 @@ var apiSchema = [
                               "optional" : 1,
                               "type" : "integer"
                            },
+                           "namespace" : {
+                              "description" : "Proxmox Backup Server namespace in the datastore, defaults to the root NS.",
+                              "maxLength" : 256,
+                              "optional" : 1,
+                              "pattern" : "(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*))?",
+                              "type" : "string"
+                           },
                            "notify" : {
                               "description" : "Specify when to notify via e-mail",
                               "enum" : [
@@ -8855,8 +8871,8 @@ var apiSchema = [
                         "datastore" : {
                            "description" : "Proxmox Backup Server datastore name.",
                            "optional" : 0,
-                           "type" : "string",
-                           "typetext" : "<string>"
+                           "pattern" : "(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)",
+                           "type" : "string"
                         },
                         "disable" : {
                            "description" : "Flag to disable (deactivate) the entry.",
@@ -8924,6 +8940,13 @@ var apiSchema = [
                            "type" : "integer",
                            "typetext" : "<N>"
                         },
+                        "namespace" : {
+                           "description" : "Proxmox Backup Server namespace in the datastore, defaults to the root NS.",
+                           "maxLength" : 256,
+                           "optional" : 1,
+                           "pattern" : "(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*))?",
+                           "type" : "string"
+                        },
                         "notify" : {
                            "description" : "Specify when to notify via e-mail",
                            "enum" : [
@@ -9869,6 +9892,12 @@ var apiSchema = [
                         "returns" : {
                            "optional" : 1,
                            "properties" : {
+                              "allow-subdomains" : {
+                                 "default" : 1,
+                                 "description" : "Whether to allow the origin to be a subdomain, rather than the exact URL.",
+                                 "optional" : 1,
+                                 "type" : "boolean"
+                              },
                               "id" : {
                                  "description" : "Relying part ID. Must be the domain name without protocol, port or location.\nChanging this *will* break existing credentials.",
                                  "optional" : 1,
@@ -9896,11 +9925,19 @@ var apiSchema = [
                         "parameters" : {
                            "additionalProperties" : 0,
                            "properties" : {
+                              "allow-subdomains" : {
+                                 "default" : 1,
+                                 "description" : "Whether to allow the origin to be a subdomain, rather than the exact URL.",
+                                 "optional" : 1,
+                                 "type" : "boolean",
+                                 "typetext" : "<boolean>"
+                              },
                               "delete" : {
                                  "description" : "A list of settings you want to delete.",
                                  "enum" : [
-                                    "origin",
                                     "id",
+                                    "origin",
+                                    "allow-subdomains",
                                     "rp"
                                  ],
                                  "optional" : 1,
@@ -14897,6 +14934,7 @@ var apiSchema = [
                                  "datastore" : {
                                     "description" : "Proxmox Backup Server datastore name.",
                                     "optional" : 0,
+                                    "pattern" : "(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)",
                                     "type" : "string"
                                  },
                                  "disable" : {
@@ -14957,6 +14995,13 @@ var apiSchema = [
                                     "optional" : 1,
                                     "type" : "integer"
                                  },
+                                 "namespace" : {
+                                    "description" : "Proxmox Backup Server namespace in the datastore, defaults to the root NS.",
+                                    "maxLength" : 256,
+                                    "optional" : 1,
+                                    "pattern" : "(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*))?",
+                                    "type" : "string"
+                                 },
                                  "notify" : {
                                     "description" : "Specify when to notify via e-mail",
                                     "enum" : [
index c90d6668bec2616bb722f557bb67b82a69d9c632..a00499587bfa21dfbcfaa7bc837a83dfe9f36ba0 100644 (file)
@@ -108,7 +108,7 @@ Add Proxmox Backup Server remote instance.
 
 Proxmox Backup Server ID.
 
-`--datastore` `<string>` ::
+`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
 
 Proxmox Backup Server datastore name.
 
@@ -148,6 +148,10 @@ Keep backups for the last <N> different weeks. If there ismore than one backup f
 
 Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
 
+`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::
+
+Proxmox Backup Server namespace in the datastore, defaults to the root NS.
+
 `--notify` `<always | error | never>` ::
 
 Specify when to notify via e-mail
@@ -184,7 +188,7 @@ Update PBS remote settings.
 
 Proxmox Backup Server ID.
 
-`--datastore` `<string>` ::
+`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
 
 Proxmox Backup Server datastore name.
 
@@ -232,6 +236,10 @@ Keep backups for the last <N> different weeks. If there ismore than one backup f
 
 Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
 
+`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::
+
+Proxmox Backup Server namespace in the datastore, defaults to the root NS.
+
 `--notify` `<always | error | never>` ::
 
 Specify when to notify via e-mail
index a78c5ff9aa076ce26253d237a8c4b0bf6beeeba8..ba84134e3827f09c20b0308db6bcc853fa19a257 100644 (file)
@@ -28,6 +28,14 @@ Set subscription key.
 
 Proxmox Mail Gateway subscription key
 
+*pmgsubscription set-offline-key* `<data>`
+
+(Internal use only!) Set a signed subscription info blob as offline key
+
+`<data>`: `<string>` ::
+
+no description available
+
 *pmgsubscription update* `[OPTIONS]`
 
 Update subscription info.