Skip to content

Commit d6368f0

Browse files
committed
Further documented how the URIs may be used for the different share protocols
1 parent 2fd38fc commit d6368f0

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

spec.yaml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -452,15 +452,20 @@ definitions:
452452
description: |
453453
An URI to access the remote resource. The URI MAY be relative,
454454
in which case the prefix exposed by the `/ocm-provider` endpoint MUST
455-
be used, or it may be absolute (recommended).
455+
be used, or it may be absolute (recommended). Additionally, the URI
456+
MAY include a secret hash in the path, in which case there MAY be
457+
no associated `sharedSecret`.
456458
webapp:
457459
type: object
458460
properties:
459461
uriTemplate:
460462
type: string
461463
description: |
462464
A templated URI to a client-browsable view of the shared resource,
463-
such that users may use the web applications available at the site
465+
such that users may use the web applications available at the site.
466+
The URI MAY include a secret hash in the path. If the path includes
467+
a `{relative-path-to-shared-resource}` placeholder, implementations
468+
MAY replace it with the actual path to ease user interaction.
464469
viewMode:
465470
type: string
466471
description: |
@@ -487,7 +492,8 @@ definitions:
487492
description: |
488493
An URI to access the remote resource. The URI MAY be relative,
489494
in which case the prefix exposed by the `/ocm-provider` endpoint MUST
490-
be used, or it may be absolute (recommended).
495+
be used, or it may be absolute (recommended). Additionally, the
496+
URI MAY include a secret hash in the path.
491497
size:
492498
type: integer
493499
example:
@@ -499,9 +505,8 @@ definitions:
499505
singleProtocolNew:
500506
name: "multi"
501507
webdav:
502-
sharedSecret: "hfiuhworzwnur98d3wjiwhr"
503508
permissions: ["read"]
504-
uri: "https://open-cloud-mesh.org/remote.php/webdav/path/to/spec.yaml"
509+
uri: "https://open-cloud-mesh.org/remote.php/webdav/share-hash/path/to/spec.yaml"
505510
multipleProtocols:
506511
name: "multi"
507512
options:

0 commit comments

Comments
 (0)