From 76b86b61cea338c1f82b07b9f081dc9277c3928d Mon Sep 17 00:00:00 2001 From: Hilmar Falkenberg Date: Mon, 21 Oct 2024 12:04:43 +0200 Subject: [PATCH] just fix uploader documentation (#991) Just doing the documentation fix, without any renaning. NOTHING more! This is now a replacement of: https://github.com/open-component-model/ocm/pull/944 renaming might happen with implementation of: https://github.com/open-component-model/ocm-project/issues/286 --- api/ocm/extensions/blobhandler/config/type.go | 8 ++++---- docs/reference/ocm_configfile.md | 9 +++++---- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/api/ocm/extensions/blobhandler/config/type.go b/api/ocm/extensions/blobhandler/config/type.go index 64c8d1431..7d36e228b 100644 --- a/api/ocm/extensions/blobhandler/config/type.go +++ b/api/ocm/extensions/blobhandler/config/type.go @@ -77,16 +77,16 @@ func (a *Config) ApplyTo(ctx cfgcpi.Context, target interface{}) error { const usage = ` The config type ` + ConfigType + ` can be used to define a list -of preconfigured download handler registrations (see ocm ocm-downloadhandlers): +of preconfigured upload handler registrations (see ocm ocm-uploadhandlers):
     type: ` + ConfigType + `
-    description: "my standard download handler configuration"
+    description: "my standard upload handler configuration"
     handlers:
       - name: oci/artifact
         artifactType: ociImage
-        mimeType:
-        config: ...
+        config:
+          ociRef: ghcr.io/open-component-model/...
       ...
 
` diff --git a/docs/reference/ocm_configfile.md b/docs/reference/ocm_configfile.md index f7b6c2f35..4cccc01e1 100644 --- a/docs/reference/ocm_configfile.md +++ b/docs/reference/ocm_configfile.md @@ -312,16 +312,16 @@ The following configuration types are supported: - uploader.ocm.config.ocm.software The config type uploader.ocm.config.ocm.software can be used to define a list - of preconfigured download handler registrations (see [ocm ocm-downloadhandlers](ocm_ocm-downloadhandlers.md)): + of preconfigured upload handler registrations (see [ocm ocm-uploadhandlers](ocm_ocm-uploadhandlers.md)):
       type: uploader.ocm.config.ocm.software
-      description: "my standard download handler configuration"
+      description: "my standard upload handler configuration"
       handlers:
         - name: oci/artifact
           artifactType: ociImage
-          mimeType:
-          config: ...
+          config:
+            ociRef: ghcr.io/open-component-model/...
         ...
   
@@ -357,4 +357,5 @@ configurations: ##### Additional Links * [ocm ocm-downloadhandlers](ocm_ocm-downloadhandlers.md) — List of all available download handlers +* [ocm ocm-uploadhandlers](ocm_ocm-uploadhandlers.md) — List of all available upload handlers