Allow the relation type canonical to be used generally for resources without requiring Bearer authentication. #405

Author: m-mohr

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `recovery-form` to link to the credentials recovery page.
 - `GET /me`: New Relation types `alternate` and `related` for user-specific external pages. [#404](https://github.com/Open-EO/openeo-api/issues/404)
 - Recommendation to add media types and titles to links for a better user experience.
+- Allow the relation type `canonical` to be used generally for (shared) resources (e.g. UDPs or batch jobs) without requiring Bearer authentication. [#405](https://github.com/Open-EO/openeo-api/issues/405)
 
 ### Changed
 

openapi.yaml

@@ -4286,9 +4286,15 @@ components:
             catalog service such as OGC CSW, a human-readable HTML version or a
             metadata document following another standard such as ISO 19115 or DCAT.
 
-            6. `canonical` (primarily for batch job results): A signed URL
-            which points to this STAC document. This way the STAC metadata can
-            be used by non-openEO clients without additional authentication steps.
+            6. `canonical`: This relation type points to a (permanent) URL for resources which
+            usually require authentication but can can be accessed without (Bearer) authentication.
+            This way the the exposed resources can be used by non-openEO clients without additional
+            authentication steps.
+            For example, a shared user-defined process or batch job results could be
+            exposed via a canonical link. If a URL should be publicly available to everyone,
+            it can simply a user-specific URL, e.g. `https://example.com/processes/john_doe/ndvi`.
+            For resources that should only be accessible to a certain group of user,
+            a signed URL could be given, e.g. `https://example.com/processes/81zjh1tc2pt52gbx/ndvi`.
 
             For additional relation types see also the lists of
             [common relation types in openEO](#section/API-Principles/Web-Linking)