Add link sharing endpoint and modify community object for automatic D…

…OI creation (#21) https://ucsc-cgl.atlassian.net/browse/SEAB-6371 https://ucsc-cgl.atlassian.net/browse/SEAB-5929 * Add create link endpoint * Add delete access link endpoint * Add getAccessLink
dockstore · May 28, 2024 · 1fb0bc5 · 1fb0bc5
1 parent c119ff8
commit 1fb0bc5
Showing 1 changed file with 118 additions and 1 deletion.
diff --git a/src/main/resources/zenodo-1.0.0-swagger-2.0.yaml b/src/main/resources/zenodo-1.0.0-swagger-2.0.yaml
@@ -531,6 +531,90 @@ paths:
             type: object
         '405':
           description: Method Not Allowed
+  /records/{id}/access/links:
+    post:
+      summary: Create an access link
+      description: Create an access link
+      operationId: createAccessLink
+      tags:
+        - accessLinks
+      consumes:
+        - application/json
+      produces:
+        - application/json
+      parameters:
+        - in: path
+          name: id
+          type: string
+          required: true
+          description: Identifier of the record
+        - in: body
+          name: LinkPermissionSettings
+          description: The permission settings for the link.
+          schema:
+            $ref: '#/definitions/LinkPermissionSettings'
+      security:
+        - access_token: [ ]
+      responses:
+        '200':
+          description: OK
+          schema:
+            $ref: '#/definitions/AccessLink'
+        '400':
+          description: Method Not Allowed
+        '500':
+          description: Internal Error
+  /records/{id}/access/links/{linkId}:
+    get:
+      summary: Get an access link
+      description: ''
+      operationId: getAccessLink
+      parameters:
+        - in: path
+          name: id
+          type: string
+          required: true
+          description: Identifier of the record
+        - in: path
+          name: linkId
+          type: string
+          required: true
+          description: Identifier of the link
+      tags:
+        - accessLinks
+      produces:
+        - application/json
+      security:
+        - access_token: [ ]
+      responses:
+        '200':
+          description: OK
+          schema:
+            $ref: '#/definitions/AccessLink'
+        '405':
+          description: Method Not Allowed
+    delete:
+      summary: Delete an access link
+      description: Delete an access link
+      parameters:
+        - in: path
+          name: id
+          type: string
+          required: true
+          description: Identifier of the record
+        - in: path
+          name: linkId
+          type: string
+          required: true
+          description: Identifier of the link
+      operationId: deleteAccessLink
+      tags:
+        - accessLinks
+      security:
+        - access_token: [ ]
+      responses:
+        '204':
+          description: OK
 securityDefinitions:
   zenodo_auth:
     type: oauth2
@@ -748,7 +832,7 @@ definitions:
   Community:
     type: object
     properties:
-      id:
+      identifier:
         type: string
   RelatedIdentifier:
     type: object
@@ -827,3 +911,36 @@ definitions:
       - filename
       - filesize
       - checksum
+  LinkPermissionSettings:
+    type: object
+    properties:
+      expires_at:
+        type: string
+      permission:
+        enum:
+          - view
+          - preview
+          - edit
+    required:
+      - permission
+  AccessLink:
+    type: object
+    properties:
+      id:
+        type: string
+      created_at:
+        type: string
+      expires_at:
+        type: string
+      permission:
+        enum:
+          - view
+          - preview
+          - edit
+      token:
+        type: string
+    required:
+      - id
+      - created_at
+      - permission
+      - token