Describe the schema of the oci-copy.yaml input file

konflux-ci · Jun 18, 2024 · f074edf · f074edf
1 parent cfecf08
commit f074edf
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 0 deletions.
diff --git a/task/oci-copy-oci-ta/0.1/README.md b/task/oci-copy-oci-ta/0.1/README.md
@@ -19,3 +19,39 @@ It is not to be considered safe for general use as it cannot provide a high degr
 |IMAGE_DIGEST|Digest of the image just built|
 |IMAGE_URL|Image repository where the built image was pushed|
 
+## oci-copy.yaml schema
+JSON schema for the `oci-copy.yaml` file.
+
+```json
+{
+    "type": "object",
+    "required": ["artifacts"],
+    "properties": {
+        "artifacts": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["source", "filename", "type", "sha256sum"],
+                "properties": {
+                    "source": {
+                        "description": "URL of the artifact to copy",
+                        "type": "string"
+                    },
+                    "filename": {
+                        "description": "Filename that should be applied to the artifact in the OCI registry",
+                        "type": "string"
+                    },
+                    "type": {
+                        "description": "Media type that should be applied to the artifact in the OCI registry",
+                        "type": "string"
+                    },
+                    "sha256sum": {
+                        "description": "Digest of the artifact to be checked before copy",
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    }
+}
+```
diff --git a/task/oci-copy/0.1/README.md b/task/oci-copy/0.1/README.md
@@ -22,3 +22,40 @@ It is not to be considered safe for general use as it cannot provide a high degr
 |name|description|optional|
 |---|---|---|
 |source|Workspace containing the source code to copy.|false|
+
+## oci-copy.yaml schema
+JSON schema for the `oci-copy.yaml` file.
+
+```json
+{
+    "type": "object",
+    "required": ["artifacts"],
+    "properties": {
+        "artifacts": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["source", "filename", "type", "sha256sum"],
+                "properties": {
+                    "source": {
+                        "description": "URL of the artifact to copy",
+                        "type": "string"
+                    },
+                    "filename": {
+                        "description": "Filename that should be applied to the artifact in the OCI registry",
+                        "type": "string"
+                    },
+                    "type": {
+                        "description": "Media type that should be applied to the artifact in the OCI registry",
+                        "type": "string"
+                    },
+                    "sha256sum": {
+                        "description": "Digest of the artifact to be checked before copy",
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    }
+}
+```