diff --git a/Makefile b/Makefile index fb60def..c14ce76 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ GEN_PACKAGE=pmg-doc-generator DOC_PACKAGE=pmg-docs # also update debian/changelog -PKGREL=5 +PKGREL=6 ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index d56e4f4..01b6fd8 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -4171,6 +4171,7 @@ var pmgapi = [ "admin" ] }, + "protected" : 1, "proxyto" : "master", "returns" : { "type" : "null" @@ -6683,7 +6684,9 @@ var pmgapi = [ }, "permissions" : { "check" : [ - "admin" + "admin", + "qmanager", + "audit" ] }, "returns" : { @@ -6713,12 +6716,6 @@ var pmgapi = [ }, "type" : "object" }, - "links" : [ - { - "href" : "{cid}", - "rel" : "child" - } - ], "type" : "array" } }, @@ -6798,11 +6795,22 @@ var pmgapi = [ "method" : "GET", "name" : "status", "parameters" : { - "additionalProperties" : 0 + "additionalProperties" : 0, + "properties" : { + "list_single_node" : { + "default" : 0, + "description" : "List local node if there is no cluster defined. Please note that RSA keys and fingerprint are not valid in that case.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } }, "permissions" : { "check" : [ - "admin" + "admin", + "qmanager", + "audit" ] }, "returns" : { @@ -8368,6 +8376,13 @@ var pmgapi = [ } } }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "proxyto" : "node", "returns" : { "items" : { "properties" : { @@ -8405,7 +8420,13 @@ var pmgapi = [ } } }, + "permissions" : { + "check" : [ + "admin" + ] + }, "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" } @@ -8432,8 +8453,12 @@ var pmgapi = [ } } }, - "protected" : 1, - "proxyto" : "node", + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, "returns" : { "items" : { "properties" : {}, @@ -8453,6 +8478,132 @@ var pmgapi = [ "path" : "/nodes/{node}/clamav", "text" : "clamav" }, + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "SpamAssassin rules status.", + "method" : "GET", + "name" : "rules_status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "channel" : { + "type" : "string" + }, + "last_updated" : { + "optional" : 1, + "type" : "integer" + }, + "update_avail" : { + "type" : "boolean" + }, + "update_version" : { + "optional" : 1, + "type" : "string" + }, + "version" : { + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + }, + "POST" : { + "description" : "Update SpamAssassin rules.", + "method" : "POST", + "name" : "update_rules", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/spamassassin/rules", + "text" : "rules" + } + ], + "info" : { + "GET" : { + "description" : "Directory index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/spamassassin", + "text" : "spamassassin" + }, { "children" : [ { @@ -10243,6 +10394,229 @@ var pmgapi = [ "path" : "/nodes/{node}/tracker", "text" : "tracker" }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Delete a backup file.", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "filename" : { + "description" : "The backup file name.", + "maxLength" : 256, + "minLength" : 4, + "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Download a backup file.", + "download" : 1, + "method" : "GET", + "name" : "download", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "filename" : { + "description" : "The backup file name.", + "maxLength" : 256, + "minLength" : 4, + "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + }, + "POST" : { + "description" : "Restore the system configuration.", + "method" : "POST", + "name" : "restore", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "config" : { + "default" : 0, + "description" : "Restore system configuration.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "database" : { + "default" : 1, + "description" : "Restore the rule database. This is the default.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "filename" : { + "description" : "The backup file name.", + "maxLength" : 256, + "minLength" : 4, + "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "statistic" : { + "default" : 0, + "description" : "Restore statistic databases. Only considered when you restore the 'database'.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/backup/{filename}", + "text" : "{filename}" + } + ], + "info" : { + "GET" : { + "description" : "List all stored backups (files named proxmox-backup_{DATE}.tgz).", + "method" : "GET", + "name" : "list", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "filename" : { + "description" : "The backup file name.", + "maxLength" : 256, + "minLength" : 4, + "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz", + "type" : "string" + }, + "size" : { + "description" : "Size of backup file in bytes.", + "type" : "integer" + }, + "timestamp" : { + "description" : "Backup timestamp (Unix epoch).", + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{filename}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Backup the system configuration.", + "method" : "POST", + "name" : "backup", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "statistic" : { + "default" : 1, + "description" : "Backup statistic databases.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/backup", + "text" : "backup" + }, { "info" : { "GET" : { diff --git a/debian/changelog b/debian/changelog index e30516a..d91c983 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,11 @@ +pmg-docs (5.0-6) unstable; urgency=medium + + * add manual page for pmgbackup (dummy) + + * update generated API schema + + -- Proxmox Support Team Tue, 14 Nov 2017 08:17:15 +0100 + pmg-docs (5.0-5) unstable; urgency=medium * update generated API schema