Changes by create-pull-request action (#167)

Author: nanjiangshu

docs/dictionary/wordlist.txt

@@ -269,6 +269,7 @@ pem
 pgvolume
 phenome
 pkcs
+playload
 png
 podSelector
 podman

docs/services/api.md

@@ -49,37 +49,57 @@ Endpoints:
 Admin endpoints are only available to a set of whitelisted users specified in the application config.
 
 - `/file/ingest`
-  - accepts `POST` requests with JSON data with the format: `{"filepath": "</PATH/TO/FILE/IN/INBOX>", "user": "<USERNAME>"}`
+  - accepts `POST` requests with either:
+    - A JSON payload: `{"filepath": "</PATH/TO/FILE/IN/INBOX>", "user": "<USERNAME>"}`
+    - OR a `fileid` query parameter: `/file/ingest?fileid=<FILE_UUID>`
   - triggers the ingestion of the file.
 
+  - If both a JSON payload and a `fileid` query parameter are provided in the same request, a `400 Bad Request` is returned.
+
   - Error codes
-    - `200` Query execute ok.
-    - `400` Error due to bad payload i.e. wrong `user` + `filepath` combination.
+    - `200` Query executed successfully.
+    - `400` Bad request (e.g. wrong `user` + `filepath` combination, both payload and fileid provided, invalid fileid, or invalid JSON).
     - `401` Token user is not in the list of admins.
     - `500` Internal error due to DB or MQ failures.
 
-    Example:
+    Example (JSON payload):
 
     ```bash
     curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" -X POST -d '{"filepath": "/uploads/file.c4gh", "user": "testuser"}' https://HOSTNAME/file/ingest
     ```
 
+    Example (fileid query parameter):
+
+    ```bash
+    curl -H "Authorization: Bearer $token" -X POST "https://HOSTNAME/file/ingest?fileid=<FILE_UUID>"
+
 - `/file/accession`
-  - accepts `POST` requests with JSON data with the format: `{"accession_id": "<FILE_ACCESSION>", "filepath": "</PATH/TO/FILE/IN/INBOX>", "user": "<USERNAME>"}`
+  - accepts `POST` requests with either:
+    - A JSON playload: `{"accession_id": "<FILE_ACCESSION>", "filepath": "</PATH/TO/FILE/IN/INBOX>", "user": "<USERNAME>"}`
+    - OR query parameters: `/file/accession?fileid=<FILE_UUID>&accessionid=<ACCESSION_ID>`
   - assigns accession ID to the file.
 
+  - If both a JSON payload and query parameters are provided in the same request, a `400 Bad Request` is returned.
+
   - Error codes
-    - `200` Query execute ok.
-    - `400` Error due to bad payload i.e. wrong `user` + `filepath` combination.
+    - `200` Query executed successfully.
+    - `400` Bad request (e.g. wrong `user` + `filepath` combination, both payload and parameters provided, invalid fileid, or invalid JSON).
     - `401` Token user is not in the list of admins.
+    - `404` Decrypted checksum not found.
     - `500` Internal error due to DB or MQ failures.
 
-    Example:
+    Example (JSON payload):
 
     ```bash
     curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" -X POST -d '{"accession_id": "my-id-01", "filepath": "/uploads/file.c4gh", "user": "testuser"}' https://HOSTNAME/file/accession
     ```
 
+    Example (query parameters):
+
+    ```bash
+    curl -H "Authorization: Bearer $token" -X POST "https://HOSTNAME/file/accession?fileid=<FILE_UUID>&accessionid=<ACCESSION_ID>"
+    ```
+
 - `/file/verify/:accession`
   - accepts `PUT` requests with an accession ID as the last element in the query
   - triggers re-verification of the file with the specific accession ID.