Skip to content

Commit 6c4af9d

Browse files
morri-sonmorrison-sapSkarlsofabianburthfrewilhelm
authored
docs: align access type notation to UpperCamelCase (#141)
## Summary Aligns canonical access type names to UpperCamelCase notation as the default, with legacy forms retained as backward-compatible aliases. ### Type Renames and Aliases | Canonical Name | Legacy Aliases | |---|---| | `OCIImage` / `OCIImage/v1` | `ociArtifact` / `ociArtifact/v1`, `ociRegistry` / `ociRegistry/v1`, `ociImage` / `ociImage/v1` | | `OCIImageLayer` / `OCIImageLayer/v1` | `ociBlob` / `ociBlob/v1` | | `Helm` / `Helm/v1` | `helm` / `helm/v1` | | `LocalBlob` / `LocalBlob/v1` | `localBlob` / `localBlob/v1` | | `GitHub` / `GitHub/v1` | `gitHub` / `gitHub/v1`, `github` / `github/v1` | | `S3` / `S3/v1` / `S3/v2` | `s3` / `s3/v1` / `s3/v2` | | `NPM` / `NPM/v1` | `npm` / `npm/v1` | | `Wget` / `Wget/v1` | `wget` / `wget/v1` | ## Changes - **Access type spec docs** (`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 lists - **README table** (`02-access-types/README.md`): Updated type names in the centrally defined types table - **Example docs** (`01-model/04-example.md`, `02-processing/04-signing-examples.md`): Updated `type:` fields in access blocks ## Related - ocm v1 legacy support: open-component-model/ocm#1881 - Ref: open-component-model/ocm-project#962 - Implementation PR: open-component-model/open-component-model#2057 --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com> Signed-off-by: Fabian Burth <fabian.burth@sap.com> Signed-off-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gergely Bräutigam <skarlso777@gmail.com> Co-authored-by: Fabian Burth <fabian.burth@sap.com> Co-authored-by: Frederic Wilhelm <fre.wilhelm@gmail.com>
1 parent 39c4b70 commit 6c4af9d

12 files changed

Lines changed: 76 additions & 34 deletions

File tree

‎.github/config/wordlist.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ wget
144144
whitespace
145145
whitespaces
146146
yaml
147+
OCIImageLayer
147148
SIG
148149
SIGs
149150
TSC

‎doc/01-model/04-example.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ component:
3030
relation: external # resource is provided by a different entity than the component
3131
access: # access information how to locate this resource
3232
imageReference: gcr.io/google_containers/echoserver:1.10
33-
type: ociArtifact
33+
type: OCIImage
3434
digest: # digest of this resource used for signing
3535
hashAlgorithm: sha256
3636
normalisationAlgorithm: ociArtifactDigest/v1
@@ -41,7 +41,7 @@ component:
4141
relation: local # resource is provided by the same entity as the component
4242
access: # access information how to locate this resource
4343
imageReference: ghcr.io/jensh007/ctf/github.com/open-component-model/ocmechoserver/echoserver:0.1.0
44-
type: ociArtifact
44+
type: OCIImage
4545
digest: # digest of this resource used for signing
4646
hashAlgorithm: sha256
4747
normalisationAlgorithm: ociArtifactDigest/v1
@@ -56,7 +56,7 @@ component:
5656
mediaType: application/vnd.toi.ocm.software.package.v1+yaml
5757
ref: ghcr.io/jensh007/ctf/component-descriptors/github.com/open-component-model/ocmechoserver
5858
size: 615
59-
type: ociBlob
59+
type: OCIImageLayer
6060
localReference: sha256:57563cb451bb79eb1c4bf0e71c66fdad1daf44fe55e128f12eae5f7e5496a188
6161
mediaType: application/vnd.toi.ocm.software.package.v1+yaml
6262
type: localBlob

‎doc/02-processing/04-signing-examples.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ spec:
2626
version: 0.1.0
2727
- access:
2828
imageReference: gcr.io/google_containers/echoserver:1.10
29-
type: ociArtifact
29+
type: OCIImage
3030
name: image
3131
relation: external
3232
type: ociImage
@@ -87,7 +87,7 @@ spec:
8787
version: 0.1.0
8888
- access:
8989
imageReference: gcr.io/google_containers/echoserver:1.10
90-
type: ociArtifact
90+
type: OCIImage
9191
digest:
9292
hashAlgorithm: SHA-256
9393
normalisationAlgorithm: ociArtifactDigest/v1
@@ -127,7 +127,7 @@ spec:
127127
resources:
128128
- access:
129129
imageReference: gcr.io/google_containers/pause:3.2
130-
type: ociArtifact
130+
type: OCIImage
131131
name: image
132132
relation: external
133133
type: ociImage
@@ -175,7 +175,7 @@ spec:
175175
resources:
176176
- access:
177177
imageReference: gcr.io/google_containers/pause:3.2
178-
type: ociArtifact
178+
type: OCIImage
179179
digest:
180180
hashAlgorithm: SHA-256
181181
normalisationAlgorithm: ociArtifactDigest/v1

‎doc/04-extensions/02-access-types/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ required to identify the blob and its location.
88

99
The following access method types are centrally defined:
1010

11-
| TYPE NAME | DESCRIPTION |
12-
|---------------------------------|-----------------------------------------------------|
13-
| [`localBlob`](localblob.md) | an artifact stored along with the component version |
14-
| [`ociArtifact`](ociartifact.md) | an artifact in a repository of an OCI registry |
15-
| [`ociBlob`](ociblob.md) | a blob in a repository of an OCI registry |
16-
| [`helm`](helm.md) | a Helm chart stored in a Helm Repository |
17-
| [`gitHub`](github.md) | a commit in a GitHub-based Git repository |
18-
| [`s3`](s3.md) | a blob stored in an AWS S3 bucket |
19-
| [`npm`](npm.md) | a NodeJS package stored in an NPM repository |
20-
| [`wget`](wget.md) | a blob stored on an HTTP server |
11+
| TYPE NAME | DESCRIPTION |
12+
|:---------------------------------|-----------------------------------------------------|
13+
| [`LocalBlob`](localblob.md) | an artifact stored along with the component version |
14+
| [`OCIImage`](ociartifact.md) | an artifact in a repository of an OCI registry |
15+
| [`OCIImageLayer`](ociblob.md) | a blob in a repository of an OCI registry |
16+
| [`Helm`](helm.md) | a Helm chart stored in a Helm Repository |
17+
| [`GitHub`](github.md) | a commit in a GitHub-based Git repository |
18+
| [`S3`](s3.md) | a blob stored in an AWS S3 bucket |
19+
| [`NPM`](npm.md) | a NodeJS package stored in an NPM repository |
20+
| [`Wget`](wget.md) | a blob stored on an HTTP server |

‎doc/04-extensions/02-access-types/github.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# gitHub — Git Commit hosted by GitHub
1+
# GitHub — Git Commit hosted by GitHub
22

33
## Synopsis
44

55
```text
6-
type: gitHub/v1
6+
type: GitHub[/VERSION]
77
```
88

9+
Legacy type names `gitHub` and `github` are supported as backward-compatible aliases.
10+
911
## Description
1012

1113
Access to a commit in a Git repository.

‎doc/04-extensions/02-access-types/helm.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# helm — Helm Package in Helm Repository
1+
# Helm — Helm Package in Helm Repository
22

3-
*Synopsis:*
3+
## Synopsis
44

55
```text
6-
type: helm[/VERSION]
6+
type: Helm[/VERSION]
77
[ATTRIBUTES]
88
```
99

10+
Legacy type name `helm` is supported as a backward-compatible alias.
11+
1012
## Description
1113

1214
Access to a Helm chart in a Helm repository.

‎doc/04-extensions/02-access-types/localblob.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# localBlob — Blob Hosted in OCM Repository
1+
# LocalBlob — Blob Hosted in OCM Repository
22

33
## Synopsis
44

55
```text
6-
type: localBlob/[VERSION]
6+
type: LocalBlob[/VERSION]
77
[ATTRIBUTES]
88
```
99

10+
Legacy type name `localBlob` is supported as a backward-compatible alias.
11+
1012
## Description
1113

1214
Access to a resource blob stored along with the component descriptor.

‎doc/04-extensions/02-access-types/npm.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# npm — Node Package Manager archive
1+
# NPM — Node Package Manager archive
22

33
## Synopsis
44

55
```text
6-
type: npm[/VERSION]
6+
type: NPM[/VERSION]
77
[ATTRIBUTES]
88
```
99

10+
Legacy type name `npm` is supported as a backward-compatible alias.
11+
1012
## Description
1113

1214
Access to an NodeJS package in an NPM registry.

‎doc/04-extensions/02-access-types/ociartifact.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1-
# ociArtifact — Artifact hosted in OCI Repository
1+
# OCIImage — Image hosted in OCI Repository
22

33
## Synopsis
44

55
```text
6-
type: ociArtifact[/VERSION]
6+
type: OCIImage[/VERSION]
77
[ATTRIBUTES]
88
```
99

10+
The following legacy type names are supported as backward-compatible aliases:
11+
12+
- `ociArtifact`
13+
- `ociRegistry`
14+
- `ociImage`
15+
1016
## Description
1117

1218
Access of an OCI artifact stored in an OCI registry.

‎doc/04-extensions/02-access-types/ociblob.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# ociBlob — Blob hosted in OCI Repository
1+
# OCIImageLayer — Blob hosted in OCI Repository
22

33
## Synopsis
44

55
```text
6-
type: ociBlob[/VERSION]
6+
type: OCIImageLayer[/VERSION]
77
[ATTRIBUTES]
88
```
99

10+
Legacy type name `ociBlob` is supported as a backward-compatible alias.
11+
1012
## Description
1113

1214
Access of an OCI blob stored in an OCI repository.

0 commit comments

Comments
 (0)