Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for wget access type #109

Merged
merged 5 commits into from
Apr 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions doc/04-extensions/02-access-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ 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 |
| [`helm`](helm.md) | a Helm chart stored in a Helm Repository |
| [`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 |
50 changes: 50 additions & 0 deletions doc/04-extensions/02-access-types/wget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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.
2 changes: 1 addition & 1 deletion doc/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<a id="compconst"/>
### [Component Constructor](https://ocm.software/docs/getting-started/first-steps-with-ocm/#all-in-one)<a id="compconst"/>

a file that acts as input for the OCM CLI to construct one or multiple component version(s).

Expand Down
Loading