From 42ef4707403eb8a896dd6ef28c90e02b8bfcf97b Mon Sep 17 00:00:00 2001
From: Christian Kellner <christian@kellner.me>
Date: Fri, 29 May 2020 15:50:59 +0200
Subject: [PATCH] sources/files: add documentation and schema

Add a brief documentation text and its JSON schema so that osbuild
can verify options org.osbuild.files source entries.
---
 sources/org.osbuild.files | 54 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/sources/org.osbuild.files b/sources/org.osbuild.files
index 99c5dbd5..cf9eec57 100755
--- a/sources/org.osbuild.files
+++ b/sources/org.osbuild.files
@@ -1,4 +1,17 @@
 #!/usr/bin/python3
+"""
+Source for downloading files from URLs.
+
+The files are indexed by their content hash. Can download files
+that require secrets. The only secret provider currently supported
+is `org.osbuild.rhsm` for downloading Red Hat content that requires
+a subscriptions.
+
+Internally use curl to download the files; the files are cached in
+an internal cache. Multiple parallel connections are used to speed
+up the download.
+"""
+
 
 import concurrent.futures
 import glob
@@ -10,6 +23,47 @@ import sys
 import tempfile
 
 
+SCHEMA = """
+"additionalProperties": false,
+"properties": {
+  "urls": {
+    "description": "The files to fetch indexed their content checksum",
+    "type": "object",
+    "additionalProperties": false,
+    "patternProperties": {
+      "(md5|sha1|sha256|sha384|sha512):[0-9a-f]{5,64}": {
+        "oneOf": [{
+          "type": "string",
+          "description": "URL to download the file from."
+        }, {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["url"],
+          "properties": {
+            "url": {
+              "type": "string",
+              "description": "URL to download the file from."
+            },
+            "secrets": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["name"],
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "Name of the secrets provider."
+                }
+              }
+            }
+          }
+        }]
+      }
+    }
+  }
+}
+"""
+
+
 def verify_checksum(filename, checksum):
     algorithm, checksum = checksum.split(":", 1)
     if algorithm not in ("md5", "sha1", "sha256", "sha384", "sha512"):