WIP: publishing metadata document schema

schema/deploy.toml

@@ -0,0 +1,67 @@
+"$schema" = "./posit-publishing-schema-v3.json"
+type = "quarto"
+entrypoint = "report.qmd"
+title = "Regional Quarterly Sales Report"
+description = "This is the quarterly sales report, broken down by region."
+thumbnail = "images/thumbnail.jpg"
+tags = [ "sales", "quarterly", "regional" ]
+
+secrets = ["API_KEY"]
+
+[python]
+version = "3.11.3"
+package-file = "requirements.txt"
+package-manager = "pip"
+
+[r]
+version = "4.3.1"
+package-file = "renv.lock"
+package-manager = "renv"
+
+[quarto]
+version = "1.4"
+
+[environment]
+API_URL = "https://example.com/api"
+
+[[schedules]]
+start = "2023-10-25T08:00:00Z"
+recurrence = "FREQ=MONTHLY;INTERVAL=3"
+
+[[access.users]]
+id = "jqpublic"
+guid = "536b456e-0311-4f92-ba10-dbf1db8a468e"
+name = "John Q. Public"
+permissions = "editor"
+
+[[access.groups]]
+id = "Data Science Team"
+guid = "8b4fde3e-f995-4894-bc02-ae47538262ff"
+name = "Data Science Team"
+permissions = "editor"
+
+[connect.access]
+run-as = "rstudio-connect"
+run-as-current-user = false
+
+[connect.runtime]
+connection-timeout = 5
+read-timeout = 30
+init-timeout = 60
+idle-timeout = 120
+max-processes = 5
+min-processes = 1
+max-connections = 50
+load-factor = 0.5
+
+[connect.kubernetes]
+amd-gpu-limit = 0
+cpu-limit = 1
+cpu-request = 0.5
+image-name = "posit/connect-runtime-python3.11-r4.3"
+memory-limit = "100000000"
+memory-request = "20000000"
+nvidia-gpu-limit = 0
+service-account-name = "posit-connect-content"
+r-environment-management = true
+py-environment-management = true

schema/posit-publishing-record-schema-v3.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/rstudio/publishing-client/posit-publishing-record-schema-v3.json",
+  "type": "object",
+  "additionalProperties": false,
+  "description": "Posit Publishing Record",
+  "required": [
+    "$schema",
+    "server-url",
+    "id",
+    "configuration"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "url",
+      "description": "URL of the json-schema definition for this file. Must be 'https://cdn.posit.co/connect/posit-publishing-record-schema-v3.json'.",
+      "enum": [
+        "./posit-publishing-record-schema-v3.json"
+      ],
+      "examples": [
+        "https://cdn.posit.co/connect/posit-publishing-record-schema-v3.json"
+      ]
+    },
+    "server-url": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL of the server where this content was deployed.",
+      "examples": [
+        "https://connect.example.com"
+      ]
+    },
+    "id": {
+      "type": "string",
+      "description": "Unique ID of this deployment.",
+      "examples": [
+        "de2e7bdb-b085-401e-a65c-443e40009749"
+      ]
+    },
+    "configuration-file": {
+      "type": "string",
+      "description": "Name of the configuration file that was used during deployment.",
+      "examples": [
+        "production.toml"
+      ]
+    },
+    "configuration": {
+      "$ref": "./posit-publishing-schema-v3.json"
+    },
+    "files": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string"
+        ]
+      },
+      "description": "Project-relative paths of the files that were included in the deployment.",
+      "examples": [
+        "app.py",
+        "model/weights.csv"
+      ]
+
+    }
+  }
+}