fix: address review feedback — revert Is() changes, deduplicate input type docs

morrison-sap · morrison-sap · commit c2b1b9fa4e2e · 2026-04-21T13:21:55.000+02:00
- Revert Is() changes in github/method.go and wget/method.go to match open-component-model#1881 pattern (don't touch existing functions) - Register UPPER_TYPE input types without usage text to avoid duplicate entries in generated reference docs (all 8: dir, file, git, helm, maven, npm, utf8, wget) - Regenerate docs/reference/ — removes ~1000 lines of duplicated content On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
diff --git a/api/ocm/extensions/accessmethods/github/method.go b/api/ocm/extensions/accessmethods/github/method.go
@@ -53,7 +53,7 @@ func init() {
 }
 
 func Is(spec accspeccpi.AccessSpec) bool {
-	return spec != nil && (spec.GetKind() == Type || spec.GetKind() == LegacyType || spec.GetKind() == UpperType)
+	return spec != nil && spec.GetKind() == Type || spec.GetKind() == LegacyType
 }
 
 // AccessSpec describes the access for a GitHub registry.
diff --git a/api/ocm/extensions/accessmethods/wget/method.go b/api/ocm/extensions/accessmethods/wget/method.go
@@ -34,7 +34,7 @@ func init() {
 }
 
 func Is(spec accspeccpi.AccessSpec) bool {
-	return spec != nil && (spec.GetKind() == Type || spec.GetKind() == UpperType)
+	return spec != nil && spec.GetKind() == Type
 }
 
 // New creates a new WGET accessor for http resources.
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/directory/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/directory/type.go
@@ -12,7 +12,7 @@ const (
 
 func init() {
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{}, usage, ConfigHandler()))
-	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, usage, ConfigHandler()))
+	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, "", ConfigHandler()))
 }
 
 const usage = `
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/file/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/file/type.go
@@ -13,5 +13,5 @@ func init() {
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{},
 		Usage("The path must denote a file relative the resources file. "), ConfigHandler()))
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{},
-		Usage("The path must denote a file relative the resources file. "), ConfigHandler()))
+		"", ConfigHandler()))
 }
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/git/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/git/type.go
@@ -12,7 +12,7 @@ const (
 
 func init() {
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{}, usage, ConfigHandler()))
-	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, usage, ConfigHandler()))
+	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, "", ConfigHandler()))
 }
 
 const usage = `
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/helm/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/helm/type.go
@@ -11,7 +11,7 @@ const (
 
 func init() {
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{}, usage, ConfigHandler()))
-	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, usage, ConfigHandler()))
+	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, "", ConfigHandler()))
 }
 
 const usage = `
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/maven/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/maven/type.go
@@ -11,7 +11,7 @@ const (
 
 func init() {
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{}, usage, ConfigHandler()))
-	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, usage, ConfigHandler()))
+	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, "", ConfigHandler()))
 }
 
 const usage = `
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/npm/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/npm/type.go
@@ -11,7 +11,7 @@ const (
 
 func init() {
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{}, usage, ConfigHandler()))
-	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, usage, ConfigHandler()))
+	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, "", ConfigHandler()))
 }
 
 const usage = `
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/utf8/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/utf8/type.go
@@ -14,7 +14,7 @@ func init() {
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{},
 		usage, ConfigHandler()))
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{},
-		usage, ConfigHandler()))
+		"", ConfigHandler()))
 }
 
 const usage = `
diff --git a/cmds/ocm/commands/ocmcmds/common/inputs/types/wget/type.go b/cmds/ocm/commands/ocmcmds/common/inputs/types/wget/type.go
@@ -12,7 +12,7 @@ const (
 
 func init() {
 	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{}, usage, ConfigHandler()))
-	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, usage, ConfigHandler()))
+	inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, "", ConfigHandler()))
 }
 
 const usage = `
diff --git a/docs/reference/ocm_add_resource-configuration.md b/docs/reference/ocm_add_resource-configuration.md
@@ -184,283 +184,34 @@ with the field <code>type</code> in the <code>input</code> field:
 
 - Input type <code>Dir</code>
 
-  The path must denote a directory relative to the resources file, which is packed
-  with tar and optionally compressed
-  if the <code>compress</code> field is set to <code>true</code>. If the field
-  <code>preserveDir</code> is set to true the directory itself is added to the tar.
-  If the field <code>followSymLinks</code> is set to <code>true</code>, symbolic
-  links are not packed but their targets files or folders.
-  With the list fields <code>includeFiles</code> and <code>excludeFiles</code> it is
-  possible to specify which files should be included or excluded. The values are
-  regular expression used to match relative file paths. If no includes are specified
-  all file not explicitly excluded are used.
-
-  This blob type specification supports the following fields:
-  - **<code>path</code>** *string*
-
-    This REQUIRED property describes the file path to directory relative to the
-    resource file location.
-
-  - **<code>mediaType</code>** *string*
-
-    This OPTIONAL property describes the media type to store with the local blob.
-    The default media type is application/x-tar and
-    application/gzip if compression is enabled.
-
-  - **<code>compress</code>** *bool*
-
-    This OPTIONAL property describes whether the file content should be stored
-    compressed or not.
-
-  - **<code>preserveDir</code>** *bool*
-
-    This OPTIONAL property describes whether the specified directory with its
-    basename should be included as top level folder.
-
-  - **<code>followSymlinks</code>** *bool*
-
-    This OPTIONAL property describes whether symbolic links should be followed or
-    included as links.
-
-  - **<code>excludeFiles</code>** *list of regex*
-
-    This OPTIONAL property describes regular expressions used to match files
-    that should NOT be included in the tar file. It takes precedence over
-    the include match.
-
-  - **<code>includeFiles</code>** *list of regex*
-
-    This OPTIONAL property describes regular expressions used to match files
-    that should be included in the tar file. If this option is not given
-    all files not explicitly excluded are used.
-
   Options used to configure fields: <code>--inputCompress</code>, <code>--inputExcludes</code>, <code>--inputFollowSymlinks</code>, <code>--inputIncludes</code>, <code>--inputPath</code>, <code>--inputPreserveDir</code>, <code>--mediaType</code>
 
 - Input type <code>File</code>
 
-  The path must denote a file relative the resources file.
-  The content is compressed if the <code>compress</code> field
-  is set to <code>true</code>.
-
-  This blob type specification supports the following fields:
-  - **<code>path</code>** *string*
-
-    This REQUIRED property describes the path to the file relative to the
-    resource file location.
-
-  - **<code>mediaType</code>** *string*
-
-    This OPTIONAL property describes the media type to store with the local blob.
-    The default media type is application/octet-stream and
-    application/gzip if compression is enabled.
-
-  - **<code>compress</code>** *bool*
-
-    This OPTIONAL property describes whether the content should be stored
-    compressed or not.
-
   Options used to configure fields: <code>--inputCompress</code>, <code>--inputPath</code>, <code>--mediaType</code>
 
 - Input type <code>Git</code>
 
-  The repository type allows accessing an arbitrary git repository
-  using the manifest annotation <code>software.ocm/component-version</code>.
-  The ref can be used to further specify the branch or tag to checkout, otherwise the remote HEAD is used.
-
-  This blob type specification supports the following fields:
-  - **<code>repository</code>** *string*
-
-    This REQUIRED property describes the URL of the git repository to access. All git URL formats are supported.
-
-  - **<code>ref</code>** *string*
-
-    This OPTIONAL property can be used to specify the remote branch or tag to checkout (commonly called ref).
-    If not set, the default HEAD (remotes/origin/HEAD) of the remote is used.
-
-  - **<code>commit</code>** *string*
-
-    This OPTIONAL property can be used to specify the commit hash to checkout.
-    If not set, the default HEAD of the ref is used.
-
   Options used to configure fields: <code>--inputRepository</code>, <code>--inputVersion</code>
 
 - Input type <code>Helm</code>
 
-  The path must denote an helm chart archive or directory
-  relative to the resources file or a chart name in a helm chart repository.
-  The denoted chart is packed as an OCI artifact set.
-  For the filesystem version additional provider info is taken from a file with
-  the same name and the suffix <code>.prov</code>.
-
-  If the chart should just be stored as plain archive, please use the
-  type <code>file</code> or <code>dir</code>, instead.
-
-  This blob type specification supports the following fields:
-  - **<code>path</code>** *string*
-
-    This REQUIRED property describes the file path to the helm chart relative to the
-    resource file location.
-
-  - **<code>version</code>** *string*
-
-    This OPTIONAL property can be set to configure an explicit version hint.
-    If not specified the version from the chart will be used.
-    Basically, it is a good practice to use the component version for local resources
-    This can be achieved by using templating for this attribute in the resource file.
-
-  - **<code>helmRepository</code>** *string*
-
-    This OPTIONAL property can be set, if the helm chart should be loaded from
-    a helm repository instead of the local filesystem. It describes
-    the base URL of the chart repository. If specified, the <code>path</code> field
-    must describe the name of the chart in the chart repository, and <code>version</code>
-    must describe the version of the chart imported from the chart repository
-
-  - **<code>repository</code>** *string*
-
-    This OPTIONAL property can be used to specify the repository hint for the
-    generated local artifact access. It is prefixed by the component name if
-    it does not start with slash "/".
-
-  - **<code>caCertFile</code>** *string*
-
-    This OPTIONAL property can be used to specify a relative filename for
-    the TLS root certificate used to access a helm repository.
-
-  - **<code>caCert</code>** *string*
-
-    This OPTIONAL property can be used to specify a TLS root certificate used to
-    access a helm repository.
-
   Options used to configure fields: <code>--hint</code>, <code>--inputCompress</code>, <code>--inputHelmRepository</code>, <code>--inputPath</code>, <code>--inputVersion</code>, <code>--mediaType</code>
 
 - Input type <code>Maven</code>
 
-  The <code>repoUrl</code> is the url pointing either to the http endpoint of a maven
-  repository (e.g. https://repo.maven.apache.org/maven2/) or to a file system based
-  maven repository (e.g. file://local/directory).
-
-  This blob type specification supports the following fields:
-  - **<code>repoUrl</code>** *string*
-
-    This REQUIRED property describes the url from which the resource is to be
-    accessed.
-
-  - **<code>groupId</code>** *string*
-
-    This REQUIRED property describes the groupId of a maven artifact.
-
-  - **<code>artifactId</code>** *string*
-  	
-    This REQUIRED property describes artifactId of a maven artifact.
-
-  - **<code>version</code>** *string*
-
-    This REQUIRED property describes the version of a maven artifact.
-
-  - **<code>classifier</code>** *string*
-
-    This OPTIONAL property describes the classifier of a maven artifact.
-
-  - **<code>extension</code>** *string*
-
-    This OPTIONAL property describes the extension of a maven artifact.
-
   Options used to configure fields: <code>--artifactId</code>, <code>--classifier</code>, <code>--extension</code>, <code>--groupId</code>, <code>--inputPath</code>, <code>--inputVersion</code>, <code>--url</code>
 
 - Input type <code>NPM</code>
 
-  The <code>registry</code> is the url pointing to the npm registry from which a resource is
-  downloaded.
-
-  This blob type specification supports the following fields:
-  - **<code>registry</code>** *string*
-
-    This REQUIRED property describes the url from which the resource is to be
-    downloaded.
-
-  - **<code>package</code>** *string*
-  	
-    This REQUIRED property describes the name of the package to download.
-
-  - **<code>version</code>** *string*
-
-    This is an OPTIONAL property describing the version of the package to download. If
-    not defined, latest will be used automatically.
-
   Options used to configure fields: <code>--inputRepository</code>, <code>--inputVersion</code>, <code>--package</code>
 
 - Input type <code>UTF8</code>
 
-  This blob type is used to provide inline text based content (UTF8). The
-  specification supports the following fields:
-  - **<code>text</code>** *string*
-
-    The utf8 string content to provide.
-
-  - **<code>json</code>** *JSON or JSON string interpreted as JSON*
-
-    The content emitted as JSON.
-
-  - **<code>formattedJson</code>** *YAML/JSON or JSON/YAML string interpreted as JSON*
-
-    The content emitted as formatted JSON.
-
-  - **<code>yaml</code>** *AML/JSON or JSON/YAML string interpreted as YAML*
-
-    The content emitted as YAML.
-
-  - **<code>mediaType</code>** *string*
-
-    This OPTIONAL property describes the media type to store with the local blob.
-    The default media type is application/octet-stream and
-    application/gzip if compression is enabled.
-
-  - **<code>compress</code>** *bool*
-
-    This OPTIONAL property describes whether the content should be stored
-    compressed or not.
-
   Options used to configure fields: <code>--inputCompress</code>, <code>--inputFormattedJson</code>, <code>--inputJson</code>, <code>--inputText</code>, <code>--inputYaml</code>, <code>--mediaType</code>
 
 - Input type <code>Wget</code>
 
-  The <code>url</code> is the url pointing to the http endpoint from which a resource is
-  downloaded. The <code>mimeType</code> can be used to specify the MIME type of the
-  resource.
-
-  This blob type specification supports the following fields:
-  - **<code>url</code>** *string*
-
-    This REQUIRED property describes the url from which the resource is to be
-    downloaded.
-
-  - **<code>mediaType</code>** *string*
-
-    This OPTIONAL property describes the media type of the resource to be
-    downloaded. If omitted, ocm tries to read the mediaType from the Content-Type header
-    of the http response. If the mediaType cannot be set from the Content-Type header as well,
-    ocm tries to deduct the mediaType from the URL. If that is not possible either, the default
-    media type is defaulted to application/octet-stream.
-
-  - **<code>header</code>** *map[string][]string*
-  	
-    This OPTIONAL property describes the http headers to be set in the http request to the server.
-
-  - **<code>verb</code>** *string*
-
-    This OPTIONAL property describes the http verb (also known as http request method) for the http
-    request. If omitted, the http verb is defaulted to GET.
-
-  - **<code>body</code>** *[]byte*
-
-    This OPTIONAL property describes the http body to be included in the request.
-
-  - **<code>noredirect</code>** *bool*
-
-    This OPTIONAL property describes whether http redirects should be disabled. If omitted,
-    it is defaulted to false (so, per default, redirects are enabled).
-
   Options used to configure fields: <code>--body</code>, <code>--header</code>, <code>--mediaType</code>, <code>--noredirect</code>, <code>--url</code>, <code>--verb</code>
 
 - Input type <code>binary</code>
diff --git a/docs/reference/ocm_add_resources.md b/docs/reference/ocm_add_resources.md
diff --git a/docs/reference/ocm_add_source-configuration.md b/docs/reference/ocm_add_source-configuration.md
diff --git a/docs/reference/ocm_add_sources.md b/docs/reference/ocm_add_sources.md

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func init() {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`func Is(spec accspeccpi.AccessSpec) bool {`
`56`		`- return spec != nil && (spec.GetKind() == Type \|\| spec.GetKind() == LegacyType \|\| spec.GetKind() == UpperType)`
	`56`	`+ return spec != nil && spec.GetKind() == Type \|\| spec.GetKind() == LegacyType`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`// AccessSpec describes the access for a GitHub registry.`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ func init() {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`func Is(spec accspeccpi.AccessSpec) bool {`
`37`		`- return spec != nil && (spec.GetKind() == Type \|\| spec.GetKind() == UpperType)`
	`37`	`+ return spec != nil && spec.GetKind() == Type`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`// New creates a new WGET accessor for http resources.`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ const (`
`12`	`12`
`13`	`13`	`func init() {`
`14`	`14`	`inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{}, usage, ConfigHandler()))`
`15`		`- inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, usage, ConfigHandler()))`
	`15`	`+ inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, "", ConfigHandler()))`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	const usage = `
Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,5 @@ func init() {`
`13`	`13`	`inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{},`
`14`	`14`	`Usage("The path must denote a file relative the resources file. "), ConfigHandler()))`
`15`	`15`	`inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{},`
`16`		`- Usage("The path must denote a file relative the resources file. "), ConfigHandler()))`
	`16`	`+ "", ConfigHandler()))`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ const (`
`11`	`11`
`12`	`12`	`func init() {`
`13`	`13`	`inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{}, usage, ConfigHandler()))`
`14`		`- inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, usage, ConfigHandler()))`
	`14`	`+ inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{}, "", ConfigHandler()))`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	const usage = `
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ func init() {`
`14`	`14`	`inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(TYPE, &Spec{},`
`15`	`15`	`usage, ConfigHandler()))`
`16`	`16`	`inputs.DefaultInputTypeScheme.Register(inputs.NewInputType(UPPER_TYPE, &Spec{},`
`17`		`- usage, ConfigHandler()))`
	`17`	`+ "", ConfigHandler()))`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	const usage = `