Renamed the provider's resource id as shareId

This better represents the fact that a per resource and per share unique ID is needed, both sending a new share and receiving an accepted/rejected notification about it
cs3org · Feb 15, 2023 · a59b273 · a59b273
1 parent 81d536c
commit a59b273
Showing 1 changed file with 6 additions and 13 deletions.
diff --git a/spec.yaml b/spec.yaml
@@ -214,8 +214,7 @@ definitions:
     required:
       - shareWith
       - name
-      - providerId
-      - resourceId
+      - shareId
       - owner
       - sender
       - protocols
@@ -241,17 +240,11 @@ definitions:
         example: >-
           This is the Open API Specification file (in YAML format) of the Open
           Cloud Mesh API.
-      resourceId:
+      shareId:
         type: string
         description: >
-          Identifier to identify the resource at the provider side. This is
-          unique per provider.
-        example: 7c084226-d9a1-11e6-bf26-cec0c932ce01
-      providerId:
-        type: string
-        description: >
-          Identifier to identify the resource at the provider side. This is
-          unique per provider (deprecated).
+          Identifier to identify the shared resource at the provider side. This is
+          unique per provider and per share.
         example: 7c084226-d9a1-11e6-bf26-cec0c932ce01
       owner:
         description: |
@@ -371,9 +364,9 @@ definitions:
         description: |
           A resource type (e.g. file, calendar, contact)
         example: file
-      providerId:
+      shareId:
         type: string
-        description: ID of the resource on the provider side
+        description: ID of the shared resource on the provider side
         example: 7c084226-d9a1-11e6-bf26-cec0c932ce01
       notification:
         type: object