ADR: File Service Support for R3 Data Definitions
File Service Support for R3 Data Definitions
Status
-
Proposed -
Trialing -
Under review -
Approved -
Retired
Context & Scope
The File Service must be updated to support R3 Data Definitions. The metadata routes for the File API currently use custom Definitions, and cannot be used as-is to create storage records for R3. There are 2 options identified to implement R3 Data Definition support for the File Service.
Option 1:
Move directly to the new Data Definitions and break API calls relying on R2 definitions. Change File Metadata APIs to reflect the R3 Data Definitions
Option 2:
Maintain backwards compatibility with the existing File Metadata APIs Create a mapper behind the API to convert the existing File API parameters into the R3 Data Definition.
Decision
Option 1 was voted for during the Daily Dev Standup on 1/21/21
Rationale
Either Option 1 or 2 must be selected in order for the File Service to continue working once the R3 Data Definitions are integrated in OSDU Core.
Consequences
Callers of the File API might need to change the way they call the service depending on which option is selected