ADR: The Dataset APIs should follow REST conventions
To be done after file#29 (closed) is implemented.
Decision Title
Rationalizing File and File DMS services.
Status
-
Proposed -
Trialing -
Under review -
Approved -
Retired
Context & Scope
The current APIs in Dataset Service do not follow REST convention. The current APIs should be deprecated and new APIs should be set up that are more REST convention.
Decision
Following the REST patterns established in file#29 (closed) ADR, the Dataset APIs will be RESTified with similar signature pattern as that of the DMS APIs.
Rationale
Following REST endpoints makes the integration lot easier and are easier to adopt as the expectation from the APIs will be clear.
Consequences
The DMS APIs getStorageInstructions and getRetrievalInstructions will be deprecated once the new endpoints are fully adopted.
| Functionality | New Endpoint | Existing API | Capability |
|---|---|---|---|
| Dataset Get-Storage Instructions | POST /storageInstructions?kindSubType={dmsType} | GET /getStorageInstructions?kindSubType={dmsType} | Generates the Signed URLs / temporary access tokens required to upload datasets |
| Dataset Get-Retrieval Instructions | GET /retrievalInstructions?id={dataset-id} | GET /getRetrievalInstructions?id={dataset-id} | Generates the Signed URLs / temporary access tokens required to download dataset |
| Dataset Batch Get-Retrieval Instructions | POST /retrievalInstructions | POST /getRetrievalInstructions | Generates the Signed URLs / temporary access tokens required to download multiple datasets |
Edited by Chad Leong