rapid-cdn: Start description with JSON Schemas

software/rapid-cdn/schema-rapid-cdn-frontend-shared.input.json

+{
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "properties": {
+    "url": {
+      "title": "Backend URL",
+      "description": "URL of the backend",
+      "pattern": "^(http|https|ftp)://",
+      "type": "string"
+    },
+    "domain": {
+      "title": "Custom Domain [optional] (requires validation)",
+      "description": "Custom Domain to use for the website. If provided, additional validation will be required for before the domain will be used, until the validation, automatically generated domain will be available to access the service.",
+      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$",
+      "type": "string"
+    },
+    "domain-icp-validation": {
+      "title": "ICP Validation [optional] (requires validation)",
+      "description": "Sets the domain to be validated by ICP in order to be present in China.",
+      "type": "string",
+      "default": "no",
+      "enum": [
+        "no",
+        "yes"
+      ]
+    }
+  },
+  "required": ["url"],
+  "title": "Input Parameters",
+  "type": "object"
+}

software/rapid-cdn/schema-rapid-cdn-frontend-shared.output.json

+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "properties": {
+    "rapid-url": {
+      "title": "The Rapid.CDN URL to access the frontend, automatically generated",
+      "type": "string"
+    },
+    "url": {
+      "title": "The URL to access the frontend, available in case of using own domain.",
+      "type": "string"
+    }
+  },
+  "title": "Output Parameters",
+  "type": "object"
+}

software/rapid-cdn/schema-rapid-cdn-frontend.input.json

+{
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "properties": {
+    "autogeneration-domain": {
+      "title": "Autogeneration Domain",
+      "description": "Domain, like host.example.com, which will be used to automatically generate frontend domains, which will look like xyz.host.example.com.",
+      "pattern": "^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$",
+      "type": "string"
+    }
+  },
+  "required": [],
+  "title": "Input Parameters",
+  "type": "object"
+}

software/rapid-cdn/schema-rapid-cdn-kedifa.input.json

+{
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "properties": {
+    "kedifa-port": {
+      "type": "integer"
+    },
+    "caucase-port": {
+      "type": "integer"
+    },
+    "frontend-list": {
+      "type": "list"
+    }
+  },
+  "required": [],
+  "title": "Input Parameters",
+  "type": "object"
+}

software/rapid-cdn/software.cfg.json

+{
+  "description": "Rapid.Space CDN",
+  "name": "Rapid.CDN",
+  "serialisation": "xml",
+  "software-type": {
+    "rapid-cdn-frontend": {
+      "title": "Rapid.CDN Frontend",
+      "serialisation": "json-in-xml",
+      "index": 1,
+      "shared": true,
+      "request": "schema-rapid-cdn-frontend-shared.input.json",
+      "response": "schema-rapid-cdn-frontend-shared.output.json",
+      "shared": true,
+      "software-type": "rapid-cdn-frontend"
+    },
+    "rapid-cdn-frontend-cluster": {
+      "title": "Rapid.CDN Frontend Cluster (resilient)",
+      "description": "Cluster deployment which can hold many slaves.",
+      "serialisation": "json-in-xml",
+      "index": 100,
+      "request": "schema-rapid-cdn-frontend.input.json",
+      "response": "schema-rapid-cdn-frontend.output.json",
+      "software-type": "rapid-cdn-frontend"
+    },
+    "pop": {
+      "title": "[INTERNAL] [TECHNICAL] Access point (PoP) of the cluster",
+      "index": 1002,
+      "serialisation": "json-in-xml",
+      "request": "schema-rapid-cdn-pop.input.json",
+      "response": "schema-rapid-cdn-pop.output.json",
+      "software-type": "rapid-cdn-pop"
+    },
+    "kedifa": {
+      "title": "[INTERNAL] [TECHNICAL] Kedifa server (resilient)",
+      "index": 1003,
+      "serialisation": "json-in-xml",
+      "request": "schema-rapid-cdn-kedifa.input.json",
+      "response": "schema-rapid-cdn-kedifa.output.json",
+      "software-type": "rapid-cdn-kedifa"
+    },
+    "human": {
+      "title": "[INTERNAL] [TECHNICAL] Node to automate some human maintenance of the frontend (eg. internal certificate signing) (resilient)",
+      "index": 1004,
+      "serialisation": "json-in-xml",
+      "request": "schema-rapid-cdn-human.input.json",
+      "response": "schema-rapid-cdn-human.output.json",
+      "software-type": "rapid-cdn-human"
+    },
+    "log-aggregator": {
+      "title": "[INTERNAL] [TECHNICAL] Node to aggregate and expose logs (resilient)",
+      "index": 1005,
+      "serialisation": "json-in-xml",
+      "request": "schema-rapid-cdn-log-aggregator.input.json",
+      "response": "schema-rapid-cdn-log-aggregator.output.json",
+      "software-type": "rapid-cdn-log-aggregator"
+    }
+  }
+}