update api readme

neicnordic · Dec 13, 2024 · c674e33 · c674e33
1 parent 661dd63
commit c674e33
Showing 1 changed file with 7 additions and 10 deletions.
diff --git a/sda-download/api/api.md b/sda-download/api/api.md
@@ -1,12 +1,9 @@
 # API
 
-
 The Download API service provides functionality for downloading files from the Archive.
-It implements the [Data Out API](https://neic-sda.readthedocs.io/en/latest/dataout/#rest-api-endpoints).
-
-Further, it enables the endpoints `/s3` and `/s3-encrypted`, used for htsget.
+It implements the [Data Out API](https://neic-sda.readthedocs.io/en/latest/dataout/#rest-api-endpoints). Further, it enables the endpoint `/s3` used for htsget and other services that need to interface with an s3-backend storage.
 
-The response can be restricted to only contain a given range of a file, and the files can be returned encrypted or unencrypted.
+The response can be restricted to only contain a given range of a file, and the files can be returned encrypted or unencrypted, depending on the configuration of the service.
 
 All endpoints require an `Authorization` header with an access token in the `Bearer` scheme.
 ```
@@ -25,10 +22,9 @@ The client can establish a session to bypass time-costly visa validations for fu
 - `/metadata/datasets/*dataset`
 - `/files/:fileid`
 
-**[File download requests, for htsget](#file-download-requests)**
+**[File download requests, for s3 endpoint](#file-download-requests)**
 
 - `/s3/*datasetid/*filepath`
-- `/s3-encrypted/*datasetid/*filepath`
 
 ### Data out API
 #### Datasets
@@ -100,10 +96,11 @@ Parts of a file can be requested with specific byte ranges using `startCoordinat
 ```
 
 ### File download requests
-These endpoints are designed for usage with [htsget](https://samtools.github.io/hts-specs/htsget.html).
+This endpoint is designed for usage with [htsget](https://samtools.github.io/hts-specs/htsget.html) or other external applications that interface with s3-storage backends.
+
+The `/s3` endpoint accepts the parameters described below. Note that depending on the configuration of the download service, `/s3` may either serve only encrypted or decrypted files.
 
-The `/s3` and `/s3-encrypted` endpoints accept the same parameters, described below.
-Note that the download service may be configured to only allow encrypted file downloads.
+By default,
 
 **Parameters**: