feat: add UpperCamelCase aliases for remaining access and input types#1920
Merged
morri-son merged 4 commits intoopen-component-model:mainfrom Apr 21, 2026
Merged
Conversation
github-actions
Bot
added
kind/feature
morri-son
force-pushed
the
add-upper-camel-case-types-v2
branch
2 times, most recently
from
da019a7 to
ec8e323
Compare
frewilhelm
reviewed
Apr 17, 2026
fabianburth
reviewed
Apr 17, 2026
7 tasks
github-actions
Bot
added
the
component/github-actions
matthiasbruns
approved these changes
Apr 20, 2026
frewilhelm
reviewed
Apr 21, 2026
Contributor
frewilhelm
left a comment
frewilhelm
left a comment
There was a problem hiding this comment.
Why is there so much documentation removed?
Add UpperCamelCase type aliases for all access methods and input types that were missing after open-component-model#1881. This completes the type notation alignment per ocm-project#962 and ocm-spec#141. Access methods: GitHub/v1, NPM/v1, Wget/v1, Git/v1alpha1, Maven/v1 Input types: Git, Maven, NPM, Wget, Binary, Docker, DockerMulti, Spiff, OCIArtifact On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
… type docs - 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>
Usage() checked the computed usage string which always includes options text even for alias types. Check the raw usage field on DefaultInputType instead, so UpperCamelCase aliases with empty usage are excluded from --help and generated reference docs. Add preamble note explaining the aliases. On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
morri-son
force-pushed
the
add-upper-camel-case-types-v2
branch
from
dd8464c to
eb95505
Compare
Contributor
Author
The removed entries (Dir, File, Helm, UTF8) were UpperCamelCase aliases that were previously duplicating the full documentation already present under their lowercase counterparts (dir, file, helm, utf8). The aliases are now registered with empty usage text so the doc generator skips them, and a preamble note was added explaining that UpperCamelCase names are aliases — refer to the lowercase entry for full docs. No content is lost. |
frewilhelm
approved these changes
Apr 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On-behalf-of: Gerald Morrison (SAP) gerald.morrison@sap.com
What this PR does / why we need it
Completes the UpperCamelCase type alias registration started in #1881. That PR covered helm, localBlob, ociBlob (access) and dir, file, helm, utf8 (input) but missed several access methods and input types.
This PR adds UpperCamelCase aliases for all remaining types:
Access methods:
gitHub→ aliasGitHub/GitHub/v1npm→ aliasNPM/NPM/v1wget→ aliasWget/Wget/v1git→ aliasGit/Git/v1alpha1maven→ aliasMaven/Maven/v1Input types (CLI):
git→ aliasGitmaven→ aliasMavennpm→ aliasNPMwget→ aliasWgetNo behavior change: all existing lowercase type strings continue to work. The new aliases ensure components authored with the new
open-component-modelmonorepo bindings (which emit UpperCamelCase as primary) can be read by this legacy CLI.Note:
NPMfollows the acronym convention used byOCIImage,UTF8, etc.Documentation:
UpperCamelCase aliases are registered with empty usage text, so they are excluded from
--helpoutput and generated reference docs. A preamble note was added to the input type documentation stating that UpperCamelCase type names are aliases — check the corresponding lowercase entry for full documentation.Related
typenotation for access and input ocm-project#962