From 1103fe7ef3cb118ead0f9ff4e9ebc3a2a544dc18 Mon Sep 17 00:00:00 2001 From: Fabian Burth Date: Mon, 22 Apr 2024 08:13:11 +0200 Subject: [PATCH 1/5] Add documentation for wget access type --- doc/04-extensions/02-access-types/README.md | 6 ++- doc/04-extensions/02-access-types/wget.md | 51 +++++++++++++++++++++ 2 files changed, 55 insertions(+), 2 deletions(-) create mode 100644 doc/04-extensions/02-access-types/wget.md diff --git a/doc/04-extensions/02-access-types/README.md b/doc/04-extensions/02-access-types/README.md index 9635d85..21176bc 100644 --- a/doc/04-extensions/02-access-types/README.md +++ b/doc/04-extensions/02-access-types/README.md @@ -8,8 +8,8 @@ required to identify the blob and its location. The following access method types are centrally defined: -| TYPE NAME | DESCRIPTION | -|-----------|-------------| +| TYPE NAME | DESCRIPTION | +|---------------------------------|-----------------------------------------------------| | [`localBlob`](localblob.md) | an artifact stored along with the component version | | [`ociArtifact`](ociartifact.md) | an artifact in a repository of an OCI registry | | [`ociBlob`](ociblob.md) | a blob in a repository of an OCI registry | @@ -17,3 +17,5 @@ The following access method types are centrally defined: | [`gitHub`](github.md) | a commit in a GitHub-based Git repository | | [`s3`](s3.md) | a blob stored in an AWS S3 bucket | | [`npm`](npm.md) | a NodeJS package stored in an NPM repository | +| [`wget`](wget.md) | a blob stored on an HTTP server | + diff --git a/doc/04-extensions/02-access-types/wget.md b/doc/04-extensions/02-access-types/wget.md new file mode 100644 index 0000000..336d9cc --- /dev/null +++ b/doc/04-extensions/02-access-types/wget.md @@ -0,0 +1,51 @@ +# wget — Blob hosted on an HTTP server + +## Synopsis + +```text +type: wget[/VERSION] +[ATTRIBUTES] +``` + +## Description + +Access to a blob stored on an HTTP server. + +## Supported Media Types + +The provided media type is taken from the specification attribute `mediaType`. + +## Specification Version + +The following versions are supported + +### v1 + +Attributes: + +- **`url`** *string* + + The url describes from which http server endpoint the resource is downloaded + +- **`mediaType`** (optional) *string* + + The media type of the blob used to store the resource. It may add + format information like `+tar` or `+gzip`. + +- **`header`** (optional) *map[string][]string* + + The header describes the http headers to be set in the http request to the server. + +- **`verb`** (optional) *string* + + The verb describes the http verb (also known as http request method) for the http + request. + +- **`body`** (optional) *[]byte* + + The body describes the http body to be included in the request. + +- **`noredirect`** (optional) *bool* + + The noredirect describes whether http redirects should be disabled. + From 1febc5f2785bce6ce7a540f71d0a4970b14e53b5 Mon Sep 17 00:00:00 2001 From: Fabian Burth Date: Mon, 22 Apr 2024 08:22:24 +0200 Subject: [PATCH 2/5] fix markdownlint errors --- doc/04-extensions/02-access-types/wget.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/04-extensions/02-access-types/wget.md b/doc/04-extensions/02-access-types/wget.md index 336d9cc..b8c099a 100644 --- a/doc/04-extensions/02-access-types/wget.md +++ b/doc/04-extensions/02-access-types/wget.md @@ -32,7 +32,7 @@ Attributes: The media type of the blob used to store the resource. It may add format information like `+tar` or `+gzip`. -- **`header`** (optional) *map[string][]string* +- **`header`** (optional) *map\[string\][]string* The header describes the http headers to be set in the http request to the server. @@ -48,4 +48,3 @@ Attributes: - **`noredirect`** (optional) *bool* The noredirect describes whether http redirects should be disabled. - From be083197472411800e3321b9cc211df98a7ad90c Mon Sep 17 00:00:00 2001 From: Fabian Burth Date: Mon, 22 Apr 2024 08:24:58 +0200 Subject: [PATCH 3/5] fix markdownlint errors --- doc/04-extensions/02-access-types/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/04-extensions/02-access-types/README.md b/doc/04-extensions/02-access-types/README.md index 21176bc..617f4b0 100644 --- a/doc/04-extensions/02-access-types/README.md +++ b/doc/04-extensions/02-access-types/README.md @@ -18,4 +18,3 @@ The following access method types are centrally defined: | [`s3`](s3.md) | a blob stored in an AWS S3 bucket | | [`npm`](npm.md) | a NodeJS package stored in an NPM repository | | [`wget`](wget.md) | a blob stored on an HTTP server | - From 760b8c31b132dc011265cc2ffdfee9b2a05fe8ef Mon Sep 17 00:00:00 2001 From: Fabian Burth Date: Mon, 22 Apr 2024 08:33:59 +0200 Subject: [PATCH 4/5] fix markdown link errors --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 25c41c4..e7606e6 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ The following chapters provide a formal description of the format to describe so ## Central OCM project web page -Check out the main project [web page](https://ocm.software) to find out more about OCM. It is your central entry point to all kinds of ocm related [docs and guides](https://ocm.software/docs/overview/context/), this [spec](https://ocm.software/spec/) and all project-related [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/guides/getting-started-with-ocm) to quickly make your hands dirty with ocm, its toolset and concepts :-) +Check out the main project [web page](https://ocm.software) to find out more about OCM. It is your central entry point to all kinds of ocm related [docs and guides](https://ocm.software/docs/overview/context/), this [spec](https://ocm.software/docs/overview/specification/) and all project-related [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started/first-steps-with-ocm/) to quickly make your hands dirty with ocm, its toolset and concepts :-) ## Contributing From 021645f1594a2e5fc472dc433f3b0d05d78fd706 Mon Sep 17 00:00:00 2001 From: Fabian Burth Date: Mon, 22 Apr 2024 08:41:48 +0200 Subject: [PATCH 5/5] fix markdown link errors --- doc/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/glossary.md b/doc/glossary.md index db93717..2f39bd5 100644 --- a/doc/glossary.md +++ b/doc/glossary.md @@ -58,7 +58,7 @@ the artifact blob. an abstract entity describing a dedicated usage context or meaning for a provided piece of software. -### [Component Constructor](https://github.com/open-component-model/ocm-website/blob/main/content/en/docs/guides/getting-started-with-ocm.md#all-in-one) +### [Component Constructor](https://ocm.software/docs/getting-started/first-steps-with-ocm/#all-in-one) a file that acts as input for the OCM CLI to construct one or multiple component version(s).