Skip to content

Commit 2fd38fc

Browse files
committed
Added multiple examples for the share.protocol parameters
1 parent 24909ca commit 2fd38fc

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

spec.yaml

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -420,9 +420,9 @@ definitions:
420420
The name of the protocol. If `multi` is given, one or more protocol
421421
endpoints are expected to be defined according to the optional
422422
properties specified below.
423-
Otherwise, at least `webdav` is expected to be supported,
424-
and its options MAY be given in the opaque `options` payload
425-
for backwards compatibility with v1.0 implementations.
423+
Otherwise, at least `webdav` is expected to be supported, and
424+
its options MAY be given in the opaque `options` payload for
425+
compatibility with v1.0 implementations (see examples).
426426
options:
427427
type: object
428428
description: |
@@ -491,19 +491,31 @@ definitions:
491491
size:
492492
type: integer
493493
example:
494-
name: 'multi'
495-
options:
496-
webdav:
497-
sharedSecret: secret
498-
permissions: ["read"]
499-
uri: "https://open-cloud-mesh.org/remote.php/webdav/path/to/spec.yaml"
500-
webapp:
501-
uriTemplate: "https://open-cloud-mesh.org/s/share-hash/{relative-path-to-shared-resource}"
502-
viewMode: "write"
503-
datatx:
504-
sharedSecret: secret
505-
srcUri: "https://open-cloud-mesh.org/remote.php/webdav/path/to/spec.yaml"
506-
size: 100000
494+
singleProtocolLegacy:
495+
name: "webdav"
496+
options:
497+
sharedSecret: "hfiuhworzwnur98d3wjiwhr"
498+
permissions: "some permissions scheme"
499+
singleProtocolNew:
500+
name: "multi"
501+
webdav:
502+
sharedSecret: "hfiuhworzwnur98d3wjiwhr"
503+
permissions: ["read"]
504+
uri: "https://open-cloud-mesh.org/remote.php/webdav/path/to/spec.yaml"
505+
multipleProtocols:
506+
name: "multi"
507+
options:
508+
webdav:
509+
sharedSecret: "hfiuhworzwnur98d3wjiwhr"
510+
permissions: ["read"]
511+
uri: "https://open-cloud-mesh.org/remote.php/webdav/path/to/spec.yaml"
512+
webapp:
513+
uriTemplate: "https://open-cloud-mesh.org/s/share-hash/{relative-path-to-shared-resource}"
514+
viewMode: "read"
515+
datatx:
516+
sharedSecret: "hfiuhworzwnur98d3wjiwhr"
517+
srcUri: "https://open-cloud-mesh.org/remote.php/webdav/path/to/spec.yaml"
518+
size: 100000
507519
NewNotification:
508520
type: object
509521
required:

0 commit comments

Comments
 (0)