From ac8c3da9a3bc3807268ecb3db79878914a29a81a Mon Sep 17 00:00:00 2001 From: Giuseppe Lo Presti Date: Wed, 29 Mar 2023 10:56:37 +0200 Subject: [PATCH] Further spelled out how the top-level URIs are being currently used --- spec.yaml | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/spec.yaml b/spec.yaml index 8989773..713f25d 100644 --- a/spec.yaml +++ b/spec.yaml @@ -284,17 +284,30 @@ definitions: - properties: webdav: type: string - description: The top-level WebDAV endpoint + description: | + The top-level WebDAV endpoint URI. In order to access a + remote shared resource, implementations MAY use this + URI as a prefix: e.g. if in a new share request's payload + a `protocol.options.sharedSecret` property is defined, + it should be appended to this URI to access the resource. example: https://my-cloud-storage.org/remote.php/dav/ocm - properties: webapp: type: string - description: The top-level endpoint for web apps + description: | + The top-level endpoint URI for web apps. This value is + provided for documentation purposes, and it SHALL NOT + be intended as a prefix for share requests. example: https://my-cloud-storage.org/external/ocm - properties: datatx: type: string - description: The top-level endpoint for data transfers + description: | + The top-level endpoint URI for data transfers. This value + is provided for documentation purposes, and it SHALL NOT + be intended as a prefix. Furthermore, implementations + are expected to execute the transfer using WebDAV as + the wire protocol. example: https://my-cloud-storage.org/remote.php/dav/ocm capabilities: type: array