caddy-frontend: Add json autodocumentation

software/caddy-frontend/instance-caddy-input-schema.json

+{
+    "$schema": "http://json-schema.org/draft-04/schema",
+    "properties": {
+        "-frontend-authorized-slave-string": {
+            "description": "List of SOFTINST-XXX of Slaves, separated by space which is allowed to use custom configuration.",
+            "title": "Authorized Slave String",
+            "type": "string"
+        },
+        "-frontend-quantity": {
+            "description": "Quantity of Frontends Replicate.",
+            "title": "Frontend Replication Quantity",
+            "type": "integer"
+        },
+        "apache-ca-certificate": {
+            "description": "[NOT IMPLEMENTED] SSL CA Certificate used by the server.",
+            "textarea": true,
+            "title": "[NOT IMPLEMENTED] SSL CA Certificate",
+            "type": "string"
+        },
+        "apache-certificate": {
+            "description": "SSL Certificate used by the server.",
+            "textarea": true,
+            "title": "SSL Certificate",
+            "type": "string"
+        },
+        "apache-key": {
+            "description": "SSL Key used by the server.",
+            "textarea": true,
+            "title": "SSL Key",
+            "type": "string"
+        },
+        "domain": {
+            "description": "Base Domain for create subdomains (ie.: example.com).",
+            "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$",
+            "title": "Domain",
+            "type": "string"
+        },
+        "enable-http2-by-default": {
+            "default": "true",
+            "description": "Use HTTP2 as default Protocol",
+            "enum": [
+                "true",
+                "false"
+            ],
+            "title": "Enable HTTP2 by Default",
+            "type": "string"
+        },
+        "mpm-graceful-shutdown-timeout": {
+            "default": 5,
+            "description": "Value passed to -grace parameter of Caddy, see https://caddyserver.com/docs/cli .",
+            "title": "Duration of the graceful shutdown period",
+            "type": "integer"
+        },
+        "nginx-domain": {
+            "description": "Base Domain for create subdomains (ie.: example2.com) for websocket, notebook and eventsource.",
+            "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$",
+            "title": "Nginx Domain",
+            "type": "string"
+        },
+        "public-ipv4": {
+            "description": "Public ipv4 of the frontend (the one Caddy will be indirectly listening to).",
+            "title": "Public IPv4",
+            "type": "string"
+        },
+        "re6st-verification-url": {
+            "description": "Url to verify if the internet and/or re6stnet is working.",
+            "title": "Test Verification URL",
+            "type": "string"
+        }
+    },
+    "title": "Input Parameters",
+    "type": "object"
+}

software/caddy-frontend/instance-output-schema.json

+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "Values returned by Caddy Frontend instanciation",
+    "properties": {
+        "accepted-slave-amount": {
+            "description": "Amount of Slaves allocated to the Instance which are deployed",
+            "type": "integer"
+        },
+        "domain": {
+            "description": "Base domain used by the instance",
+            "type": "string"
+        },
+        "monitor-base-url": {
+            "description": "Base url for monitor",
+            "type": "string"
+        },
+        "monitor-password": {
+            "description": "Password to access the monitor",
+            "type": "string"
+        },
+        "monitor-url": {
+            "description": "Url of Monitor (opml)",
+            "type": "string"
+        },
+        "monitor-user": {
+            "description": "User to access the monitor",
+            "type": "string"
+        },
+        "reject-slave-amount": {
+            "description": "Rejected Amount of Slaves allocated to the Instance which are not deployed",
+            "type": "integer"
+        },
+        "rejected-slave-list": {
+            "description": "List of slave instances references which are rejected",
+            "type": "array"
+        },
+        "slave-amount": {
+            "description": "Total amount of Slaves allocated to the Instance (include blocked ones)",
+            "type": "integer"
+        }
+    },
+    "type": "object"
+}

software/caddy-frontend/instance-slave-caddy-input-schema.json

+{
+    "$schema": "http://json-schema.org/draft-04/schema",
+    "properties": {
+        "apache_custom_http": {
+            "default": "",
+            "description": "Raw http configuration in python template format. Your site will be rejected if you use it without notification and approval of frontend administrators",
+            "textarea": true,
+            "title": "HTTP configuration",
+            "type": "string"
+        },
+        "apache_custom_https": {
+            "default": "",
+            "description": "Raw https configuration in python template format. Your site will be rejected if you use it without notification and approval of frontend administrators",
+            "textarea": true,
+            "title": "HTTPS configuration",
+            "type": "string"
+        },
+        "custom_domain": {
+            "description": "Custom Domain to use for the website",
+            "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$",
+            "title": "Custom Domain",
+            "type": "string"
+        },
+        "default-path": {
+            "default": "",
+            "description": "Provide default path to redirect user to when user access / (the site root)",
+            "title": "type:zope Default Path",
+            "type": "string"
+        },
+        "disable-no-cache-request": {
+            "default": "false",
+            "description": "If set to true, Cache-Control and Pragma requests headers will not be sent to cache and backend servers. This prevents clients from bypassing cache when enable_cache is true",
+            "enum": [
+                "false",
+                "true"
+            ],
+            "title": "enable_cache: Disable 'no-cache' requests",
+            "type": "string"
+        },
+        "disable-via-header": {
+            "default": "false",
+            "description": "If set to true, Via response headers will not be sent to client",
+            "enum": [
+                "false",
+                "true"
+            ],
+            "title": "enable_cache: Disable 'Via' headers from cache",
+            "type": "string"
+        },
+        "disabled-cookie-list": {
+            "default": "",
+            "description": "[NOT Implemented] List of Cookies separated by space that will not be sent to cache and backend servers. This is especially useful to discard analytics tracking cookies when using Vary: Cookie cache headers",
+            "title": "[NOT Implemented] Disabled Cookies",
+            "type": "string"
+        },
+        "enable-http2": {
+            "default": "true",
+            "description": "Use HTTP2 Protocol for the site",
+            "enum": [
+                "true",
+                "false"
+            ],
+            "title": "Enable HTTP2 Protocol",
+            "type": "string"
+        },
+        "enable_cache": {
+            "default": "false",
+            "description": "If set to true, http caching server (Apache Traffic Server) will be used between frontend Caddy and backend",
+            "enum": [
+                "false",
+                "true"
+            ],
+            "title": "Enable Cache",
+            "type": "string"
+        },
+        "https-only": {
+            "default": "false",
+            "description": "If set to true, http requests will be redirected to https",
+            "enum": [
+                "false",
+                "true"
+            ],
+            "title": "HTTPS Only",
+            "type": "string"
+        },
+        "https-url": {
+            "description": "HTTPS Url of the backend if it is diferent from url parameter",
+            "pattern": "^(http|https|ftp)://",
+            "title": "HTTPS Backend URL",
+            "type": "string"
+        },
+        "monitor-ipv4-test": {
+            "default": "",
+            "description": "IPv4 Address for the frontend keep monitoring with ping",
+            "title": "IPv4 Address to Monitor Packet Lost",
+            "type": "string"
+        },
+        "monitor-ipv6-test": {
+            "default": "",
+            "description": "IPv6 Address for the frontend keep monitoring with ping6 (without brackets)",
+            "title": "IPv6 Address to Monitor Packet Lost",
+            "type": "string"
+        },
+        "path": {
+            "default": "",
+            "description": "Path to proxy to in the backend",
+            "title": "type:zope Backend Path",
+            "type": "string"
+        },
+        "prefer-gzip-encoding-to-backend": {
+            "default": "false",
+            "description": "[NOT Implemented] If set to true, frontend will rewrite Accept-Encoding request header to simply 'gzip' for all variants of Accept-Encoding containing 'gzip', in order to maximize cache hits for resources cached with Vary: Accept-Encoding when enable_cache is used",
+            "enum": [
+                "false",
+                "true"
+            ],
+            "title": "[NOT Implemented] Prefer gzip Encoding for Backend",
+            "type": "string"
+        },
+        "re6st-optimal-test": {
+            "default": "",
+            "description": "IPv6 and IPv6 Address for the frontend test if re6st is on the optimal status (use ipv6,ipv4)",
+            "title": "IPv6 and IPv4 Address to test Re6st",
+            "type": "string"
+        },
+        "server-alias": {
+            "default": "",
+            "description": "Server Alias List separated by space",
+            "title": "Server Alias",
+            "type": "string"
+        },
+        "ssl-proxy-verify": {
+            "default": "false",
+            "description": "[NOT Implemented] If set to true, Backend SSL Certificates will be checked and frontend will refuse to proxy if certificate is invalid",
+            "enum": [
+                "false",
+                "true"
+            ],
+            "title": "[NOT Implemented] Verify Backend Certificates",
+            "type": "string"
+        },
+        "ssl_ca_crt": {
+            "default": "",
+            "description": "[NOT Implemented] Content of the CA certificate file",
+            "textarea": true,
+            "title": "[NOT Implemented] SSL Certificate Authority's Certificate",
+            "type": "string"
+        },
+        "ssl_crt": {
+            "default": "",
+            "description": "Content of the SSL Certificate file",
+            "textarea": true,
+            "title": "SSL Certificate",
+            "type": "string"
+        },
+        "ssl_key": {
+            "default": "",
+            "description": "Content of the SSL Key file",
+            "textarea": true,
+            "title": "SSL Key",
+            "type": "string"
+        },
+        "ssl_proxy_ca_crt": {
+            "default": "",
+            "description": "[NOT Implemented] Content of the SSL Certificate Authority file of the backend (to be used with ssl-proxy-verify)",
+            "title": "[NOT Implemented] SSL Backend Authority's Certificate",
+            "type": "string"
+        },
+        "type": {
+            "default": "",
+            "description": "Type of slave. If redirect, the slave will redirect to the given url. If zope, the rewrite rules will be compatible with Virtual Host Monster. Implemented are default, zope and redirect, not implemneted are notebook and eventsource.",
+            "enum": [
+                "",
+                "zope",
+                "redirect",
+                "notebook",
+                "eventsource"
+            ],
+            "title": "Backend Type",
+            "type": "string"
+        },
+        "url": {
+            "description": "Url of the backend",
+            "pattern": "^(http|https|ftp)://",
+            "title": "Backend URL",
+            "type": "string"
+        },
+        "virtualhostroot-http-port": {
+            "default": 80,
+            "description": "Port where http requests to frontend will be redirected.",
+            "title": "type:zope virtualhostroot-http-port",
+            "type": "integer"
+        },
+        "virtualhostroot-https-port": {
+            "default": 443,
+            "description": "Port where https requests to frontend will be redirected.",
+            "title": "type:zope virtualhostroot-https-port",
+            "type": "integer"
+        }
+    },
+    "title": "Input Parameters",
+    "type": "object"
+}

software/caddy-frontend/instance-slave-output-schema.json

+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "Values returned by Caddy Frontend instanciation",
+    "properties": {
+        "domain": {
+            "description": "Base domain used by the instance",
+            "type": "string"
+        },
+        "log-access-url": {
+            "description": "List of URLs to access logs",
+            "type": "array"
+        },
+        "public-ipv4": {
+            "description": "Public IPv4 to be included on DNS",
+            "type": "string"
+        },
+        "replication_number": {
+            "description": "Number of nodes the slave is replicated",
+            "type": "integer"
+        },
+        "secure_access": {
+            "description": "URL for HTTP access",
+            "type": "string"
+        },
+        "site_url": {
+            "description": "URL for HTTP access",
+            "type": "string"
+        },
+        "url": {
+            "description": "Default URL provided",
+            "type": "string"
+        }
+    },
+    "type": "object"
+}

software/caddy-frontend/software.cfg.json

+{
+    "description": "Caddy Frontend",
+    "name": "Caddy Frontend",
+    "serialisation": "xml",
+    "software-type": {
+        "custom-personal": {
+            "description": "",
+            "index": 2,
+            "request": "instance-caddy-input-schema.json",
+            "response": "instance-output-schema.json",
+            "title": "Custom Personal"
+        },
+        "custom-personal-slave": {
+            "description": "Custom Personal",
+            "index": 1,
+            "request": "instance-slave-caddy-input-schema.json",
+            "response": "instance-output-schema.json",
+            "shared": true,
+            "software-type": "custom-personal",
+            "title": "Custom Personal (Slave)"
+        },
+        "default": {
+            "description": "Default",
+            "index": 3,
+            "request": "instance-caddy-input-schema.json",
+            "response": "instance-output-schema.json",
+            "software-type": "default",
+            "title": "Default"
+        },
+        "default-slave": {
+            "description": "Default",
+            "index": 4,
+            "request": "instance-slave-caddy-input-schema.json",
+            "response": "instance-output-schema.json",
+            "shared": true,
+            "software-type": "default",
+            "title": "Default (slave)"
+        }
+    }
+}