Skip to content

Commit

Permalink
First draft
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Oct 11, 2023
1 parent e40ad4a commit 84f3134
Show file tree
Hide file tree
Showing 5 changed files with 478 additions and 12 deletions.
12 changes: 12 additions & 0 deletions extensions/workspaces/.spectral.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
extends: "spectral:oas"
rules:
contact-properties: true
tag-description: true
oas3-parameter-description: true
oas3-unused-component: true
operation-id-kebab-case:
given: "$..operationId"
then:
function: pattern
functionOptions:
match: ^[a-z][a-z0-9\-]*$
16 changes: 16 additions & 0 deletions extensions/workspaces/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Workspaces Extension

The Workspace Extension to the openEO API provides an interface for connecting external file storage such as cloud buckets to openEO back-end implementations.

This opens the possibility to register such a file storage system as a data source for new collections, so-called "User Collections".
Additionally, batch job results can be stored on such file storage systems.

- Version: **0.1.0**
- Stability: **experimental**
- [OpenAPI document](openapi.yaml)
- Conformance class: `https://api.openeo.org/extensions/workspaces/0.1.0`

**Note:** This document only documents the additions to the specification.
Extensions can not change or break existing behavior of the openEO API.

The Workspace API is inspired by the [EOEPCA Workspace API](https://github.com/EOEPCA/rm-workspace-api) with regards to workspace management. The User Collections are not aligned with EOEPCA.
Loading

0 comments on commit 84f3134

Please sign in to comment.