Specify minimum required functionality for an OCM endpoint

cs3org · Mar 29, 2023 · b139c1e · b139c1e
1 parent 2ca6ac6
commit b139c1e
Showing 1 changed file with 11 additions and 6 deletions.
diff --git a/spec.yaml b/spec.yaml
@@ -263,34 +263,39 @@ definitions:
             name:
               type: string
               description: |
-                A supported resource type (file, folder, calendar, contact, ...)
+                A supported resource type (file, folder, calendar, contact, ...).
+                Implementations MUST support `file` at a minimum.
               example: file
             shareTypes:
               type: array
-              description: The supported recipient share types
+              description: |
+                The supported recipient share types.
+                Implementations MUST support `user` at a minimum.
               items:
                 type: string
                 enum: ["user", "group", "federation"]
+              example: ["user"]
             protocols:
               type: object
               description: |
-                The supported protocols to access shares at this endpoint
+                The supported protocols to access shares at this endpoint.
+                Implementations MUST support `webdav` at a minimum.
               anyOf:
                 - properties:
                     webdav:
                       type: string
                       description: The top-level WebDAV endpoint
-                      example: https://my-cloud-storage.org/ocm
+                      example: https://my-cloud-storage.org/remote.php/dav/ocm
                 - properties:
                     webapp:
                       type: string
                       description: The top-level endpoint for web apps
-                      example: https://my-cloud-storage.org
+                      example: https://my-cloud-storage.org/external/ocm
                 - properties:
                     datatx:
                       type: string
                       description: The top-level endpoint for data transfers
-                      example: https://my-cloud-storage.org
+                      example: https://my-cloud-storage.org/remote.php/dav/ocm
   NewShare:
     type: object
     required: