docs: align access type notation to UpperCamelCase#141
Open
morri-son wants to merge 15 commits into
Open
Conversation
7 tasks
Contributor
Author
|
OCM v1 should be merged FIRST: #141 |
1 task
Member
jakobmoellerdev
left a comment
jakobmoellerdev
left a comment
There was a problem hiding this comment.
I believe we are missing some aliases here right? there are many more combinations possible no?
Contributor
Author
correct. I double-checked ocm v1 and the monorepo again and added the missing aliases. |
frewilhelm
reviewed
Apr 14, 2026
Contributor
frewilhelm
left a comment
frewilhelm
left a comment
There was a problem hiding this comment.
What about the remaining access types? https://github.com/open-component-model/ocm-spec/blob/main/doc/04-extensions/02-access-types/README.md
Rename canonical access type names to UpperCamelCase as the default: - ociArtifact → OCIImage - ociBlob → OCIImageLayer - helm → Helm The lowercase forms remain as backward-compatible aliases. localBlob is intentionally left unchanged (deferred to a later PR). Updates access type spec docs, README table, and example documents. Ref: open-component-model/ocm-project#962 On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
…ent-model#136) On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> <!-- markdownlint-disable MD041 --> #### What this PR does / why we need it pin to digests and bump versions Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: 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>
…t-model#137) <!-- markdownlint-disable MD041 --> #### What this PR does / why we need it align markdown linters with our other repositories --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: 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>
On-behalf-of: Gergely Brautigam <gergely.brautigam@sap.com> <!-- markdownlint-disable MD041 --> #### What this PR does / why we need it #### Which issue(s) this PR is related to <!-- Usage: `Related to #<issue number>`, or `Related to (paste link of issue)`. --> --------- Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com> Signed-off-by: Fabian Burth <fabian.burth@sap.com> Co-authored-by: Fabian Burth <fabian.burth@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>
…nt-model#135) On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> <!-- markdownlint-disable MD041 --> #### What this PR does / why we need it add v3 and v4alpha1 of jsonNormalization --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: 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>
- OCIImage: add ociArtifact/v1, ociRegistry(/v1), ociImage(/v1) aliases - OCIImageLayer: add ociBlob/v1 alias - Helm: add helm/v1 alias - LocalBlob: rename from localBlob, add localBlob(/v1) alias - README: update table to show LocalBlob 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>
Registers Wget, S3, GitHub, Npm as canonical type names with legacy lowercase forms retained as backward-compatible aliases, consistent with helm/ociArtifact/ociBlob/localBlob already updated in this branch. Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>
… type Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>
morri-son
force-pushed
the
align-upper-camel-case-types
branch
from
cee23d9 to
21d7754
Compare
Contributor
Author
I updated the PR and the description and now cover all available access types in the doc (I also updated open-component-model/ocm#1881 which missed some) |
Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
frewilhelm
reviewed
Apr 16, 2026
- Add S3/v2 section documenting renamed JSON fields (bucketName, objectKey) - Rename Npm type to NPM for acronym consistency with OCIImage, UTF8 - Remove explicit version suffixes from legacy alias sentences across all access type docs (version-agnostic prefix is sufficient) 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>
Co-authored-by: Frederic Wilhelm <fre.wilhelm@gmail.com> Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com>
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
morri-son
added a commit
to open-component-model/ocm
that referenced
this pull request
Apr 21, 2026
…#1920) On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> <!-- markdownlint-disable MD041 --> #### 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` → alias `GitHub` / `GitHub/v1` - `npm` → alias `NPM` / `NPM/v1` - `wget` → alias `Wget` / `Wget/v1` - `git` → alias `Git` / `Git/v1alpha1` - `maven` → alias `Maven` / `Maven/v1` **Input types (CLI):** - `git` → alias `Git` - `maven` → alias `Maven` - `npm` → alias `NPM` - `wget` → alias `Wget` No behavior change: all existing lowercase type strings continue to work. The new aliases ensure components authored with the new `open-component-model` monorepo bindings (which emit UpperCamelCase as primary) can be read by this legacy CLI. Note: `NPM` follows the acronym convention used by `OCIImage`, `UTF8`, etc. **Documentation:** UpperCamelCase aliases are registered with empty usage text, so they are excluded from `--help` output 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 - open-component-model/ocm-project#962 - open-component-model/open-component-model#2057 - ocm-spec PR: open-component-model/ocm-spec#141 - Predecessor: #1881 --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
morri-son
added a commit
to open-component-model/open-component-model
that referenced
this pull request
Apr 21, 2026
…ocalBlob so far) (#2057) On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> <!-- markdownlint-disable MD041 --> ## Summary Register UpperCamelCase forms as the primary (default) serialization type for all input types, consistent with the existing convention used by access OCIImage/v1, Helm/v1 etc. ## Changes: - Input types: File/v1 (was file/v1), Dir/v1 (was dir/v1), UTF8/v1 (was utf8/v1), Helm/v1 (was helm/v1) **The localBlob/v1 access type IS NOT touched in the PR.**, but already prepared (including updating all tests using the new types) in [this branch](https://github.com/morri-son/open-component-model/tree/align-type-notation-for-acces-and-input). Lowercase forms remain registered as backward-compatible aliases so existing component descriptors and constructors continue to work. Adds named constants (Type, LegacyType) to each spec package following the pattern already established by access type packages. Also adds Type constants for OCIImage, OCIImageLayer, and Helm access types where hardcoded strings were previously used in schema registrations. ## Which issue(s) this PR fixes Usage: Fixes open-component-model/ocm-project#962 ## Dependencies Tests for type casing have been split off to PR #2071 to get the CI test not failing. ## Related - ocm-spec: open-component-model/ocm-spec#141 - ocm v1: open-component-model/ocm#1881 - ocm-website: #2244 ## Verification - [x] I have tested the changes locally by running `ocm` --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
ocmbot2 Bot
pushed a commit
to morri-son/open-component-model
that referenced
this pull request
Apr 21, 2026
…ocalBlob so far) (open-component-model#2057) On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> <!-- markdownlint-disable MD041 --> ## Summary Register UpperCamelCase forms as the primary (default) serialization type for all input types, consistent with the existing convention used by access OCIImage/v1, Helm/v1 etc. ## Changes: - Input types: File/v1 (was file/v1), Dir/v1 (was dir/v1), UTF8/v1 (was utf8/v1), Helm/v1 (was helm/v1) **The localBlob/v1 access type IS NOT touched in the PR.**, but already prepared (including updating all tests using the new types) in [this branch](https://github.com/morri-son/open-component-model/tree/align-type-notation-for-acces-and-input). Lowercase forms remain registered as backward-compatible aliases so existing component descriptors and constructors continue to work. Adds named constants (Type, LegacyType) to each spec package following the pattern already established by access type packages. Also adds Type constants for OCIImage, OCIImageLayer, and Helm access types where hardcoded strings were previously used in schema registrations. ## Which issue(s) this PR fixes Usage: Fixes open-component-model/ocm-project#962 ## Dependencies Tests for type casing have been split off to PR open-component-model#2071 to get the CI test not failing. ## Related - ocm-spec: open-component-model/ocm-spec#141 - ocm v1: open-component-model/ocm#1881 - ocm-website: open-component-model#2244 ## Verification - [x] I have tested the changes locally by running `ocm` --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> 7756429
morri-son
added a commit
to open-component-model/open-component-model
that referenced
this pull request
Apr 24, 2026
## Summary - Update input type names (`Dir/v1`, `File/v1`, `Helm/v1`, `UTF8/v1`) and access type names (`OCIImage`, `OCIImageLayer`) across website documentation to use UpperCamelCase as the canonical form - Lowercase forms are documented as backward-compatible aliases - 13 files changed across `content/docs/` and `content_templates/` ## What's unchanged (by design) - `localBlob` references — deferred to a later PR - `helmChart` — this is an artifact type, not an access/input type - `ociArtifactDigest/v1` — algorithm name, not a type alias - `--upload-as ociArtifact` CLI flag values — CLI flag semantics unchanged - `content_versioned/version-legacy/` — historical docs left as-is ## Related - Tracks: open-component-model/ocm-project#962 - Depends on: #2057 (bindings UpperCamelCase defaults) - Companion: open-component-model/ocm-spec#141 (spec docs) Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
ocmbot Bot
pushed a commit
to open-component-model/open-component-model
that referenced
this pull request
Apr 24, 2026
## Summary - Update input type names (`Dir/v1`, `File/v1`, `Helm/v1`, `UTF8/v1`) and access type names (`OCIImage`, `OCIImageLayer`) across website documentation to use UpperCamelCase as the canonical form - Lowercase forms are documented as backward-compatible aliases - 13 files changed across `content/docs/` and `content_templates/` ## What's unchanged (by design) - `localBlob` references — deferred to a later PR - `helmChart` — this is an artifact type, not an access/input type - `ociArtifactDigest/v1` — algorithm name, not a type alias - `--upload-as ociArtifact` CLI flag values — CLI flag semantics unchanged - `content_versioned/version-legacy/` — historical docs left as-is ## Related - Tracks: open-component-model/ocm-project#962 - Depends on: #2057 (bindings UpperCamelCase defaults) - Companion: open-component-model/ocm-spec#141 (spec docs) Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> 2e601ca
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.
Summary
Aligns canonical access type names to UpperCamelCase notation as the default, with legacy forms retained as backward-compatible aliases.
Type Renames and Aliases
OCIImage/OCIImage/v1ociArtifact/ociArtifact/v1,ociRegistry/ociRegistry/v1,ociImage/ociImage/v1OCIImageLayer/OCIImageLayer/v1ociBlob/ociBlob/v1Helm/Helm/v1helm/helm/v1LocalBlob/LocalBlob/v1localBlob/localBlob/v1GitHub/GitHub/v1gitHub/gitHub/v1,github/github/v1S3/S3/v1/S3/v2s3/s3/v1/s3/v2NPM/NPM/v1npm/npm/v1Wget/Wget/v1wget/wget/v1Changes
ociartifact.md,ociblob.md,helm.md,localblob.md,github.md,s3.md,npm.md,wget.md): Updated titles, synopsis blocks, and added complete legacy alias lists02-access-types/README.md): Updated type names in the centrally defined types table01-model/04-example.md,02-processing/04-signing-examples.md): Updatedtype:fields in access blocksRelated
typenotation for access and input ocm-project#962