Skip to content

Remove osc:product, other clarifications for child and related links #12

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

Merged
merged 1 commit into from
Mar 3, 2025
Merged
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
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,24 +138,36 @@ The following types should be used as applicable `rel` types in the

| Type | Description |
| ----------- | ------------------------------------- |
| related | Links to resources that are identified in the osc: fields, e.g. a link to the project as identified in the `osc:project` field. |
| related | Links to resources that are identified in the `osc:` fields and `themes`, e.g. a link to the project as identified in the `osc:project` field. |
| environment | Links to a file that identifies the execution environment of an experiment (applicable mostly to OGC API - Records) |
| input | Links to a file that identifies any input parameters of an experiment (applicable mostly to OGC API - Records) |

## OGC API - Records
## Other entities

### Variables

Variables don't use any `osc:` fields,
but they expose `themes` and link to themes via the `related` relation type.

### Workflows and Experiments (via OGC API - Records)

Although this extension is a STAC extension, similar fields with the same `osc:` prefix
are also used in OGC API - Records that describe workflows and experiments.

The following fields occur in workflows:

- `osc:project` (string, required)
- `osc:experiments` (\[string])

Additionally, workflows add links with the relation type `child` that point to the experiments.

The following fields occur in experiments:

- `osc:workflow` (string, required)
- `osc:product` (string, required)

Additionally, experiments add links with the relation type `child` that point to the products.

For all entities referenced in `osc:project` and `osc:workflow`,
links with the `related` relation type are provided.

## Contributing

Expand Down