Revoke signed URLs #341

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - `GET /processes` and `GET` / `PUT` for `/process_graphs/{process_graph_id}`: Allow specifying the return values processes receive from child processes. [#350](https://github.com/Open-EO/openeo-api/issues/350)
+- `PATCH /jobs/{job_id}/results` to revoke signed URLs generated for batch job results. [#341](https://github.com/Open-EO/openeo-api/issues/341)
 - `GET /credentials/oidc` can provide a set of default client ids for OpenID Connect. [#366](https://github.com/Open-EO/openeo-api/pull/366)
 - `experimental` and `deprecated` flags added for file formats, service types, udf runtimes, udf runtime versions, udf runtime libraries and all related parameters and schemas. [#354](https://github.com/Open-EO/openeo-api/issues/354)
 - `GET /jobs/{job_id}/logs` and `GET /services/{service_id}/logs`: `time` property added. [#330](https://github.com/Open-EO/openeo-api/issues/330)

openapi.yaml

@@ -3118,6 +3118,41 @@ paths:
           $ref: '#/components/responses/client_error_auth'
         5XX:
           $ref: '#/components/responses/server_error'
+    patch:
+      summary: Revoke signed URLs in batch job results
+      operationId: update-job-results
+      description: |-
+        Revoke access to all previously generated signed URLs for batch job
+        results.
+
+        Note: The functionality may be extended in the future.
+      tags:
+        - Batch Jobs
+      security:
+        - Bearer: []
+      responses:
+        '204':
+          description: Changes to the batch job results were applied successfully.
+        4XX:
+          $ref: '#/components/responses/client_error_auth'
+        5XX:
+          $ref: '#/components/responses/server_error'
+      requestBody:
+        description: Changes requested for the specified batch job results.
+        required: true
+        content:
+          application/json:
+            schema:
+              title: Update Batch Job Results
+              type: object
+              properties:
+                assets:
+                  description: >-
+                    Send the value `null` to revoke all previously
+                    generated signed URLs for batch job results.
+                  nullable: true
+                  enum:
+                    - null
   '/files':
     get:
       summary: List all files in the workspace