ADR: Add new "extensionProperties" property to legalTag properties list

Need a way to allow OSDU clients to attach their E&O attributes to the OSDU data records to utilize the new Policy service to build the dynamic policy rules.

Status

• Proposed
• Trialing
• Under review
• Approved
• Retired

Context & Scope

Shell is going to use the Policy service to enforce the E&O rules for all data records. In order to build the required dynamic policy rules, we need to attach our E&O attributes to each data record. One option is to add a new E&O attributes placeholder for all data schemas and pass these attributes into the Policy service for policy rule evaluation. We feel a better option is to reuse the existing LegalTag field in the data schemas. This is a mandatory field and is already passed into the Policy service for policy evaluation. Also this will inherit the nice features from the existing Legal service like the legal tag assignment for derivative records(https://community.opengroup.org/osdu/platform/security-and-compliance/legal/-/blob/master/docs/tutorial/ComplianceService.md).

The current list of legalTag properties is a fixed list. We would like to request to extend this list of legalTag properties so additional properties (ie, E&O attributes) can be added to this list and they can be used to build the dynamic policy rules with the Policy service.

Decision

We propose to add a new "extensionProperties" field which is the object type and is optional field. In this way, the list of legalTag properties is still fixed and each company can add its E&O attributes into the "extensionProperties" object.

Consequences

The list of legalTag properties list will include the new optional object-type field 'extensionProperties'. Users are not expected to make any changes to Storage records, hence there is no impact on Storage, Indexer or Search service.