THCLab / oca-ecosystem

European Union Public License 1.2
3 stars 0 forks source link

Defining "Meta overlay"-like properties that are the same (duplicated) across all languages #11

Open swcurran opened 1 year ago

swcurran commented 1 year ago

We need a way to have a number of "Meta"-like entries that are language agnostic. As currently defined in the OCA Standard, and managed in the OCA Source spreadsheet, "Meta" entries (name/value pairs) are multilingual and thus the names are duplicated for each language. However, there are a number of values for Meta names that are the same across all languages. How can we manage that?

Two ideas for that:

I think this is a generally useful feature and belongs in the OCA Core. In the Aries community, we could address it using a custom overlay that is defined within the community.

Example use cases:

swcurran commented 1 year ago

Realizing that since the Meta Overlay is a multilingual overlay, having default language there may not be ideal, as it would be repeated for each language, but needs to have the same value across all instances.

We could put it in our Aries specific "Branding Overlay", as it applies to the entire credential but is not multilingual. However, it still feels like it is an "OCA Core" type item, so would welcome HCF guidance on this one.

swcurran commented 1 year ago

Updated the title and description (initial comment) for this issue to be more general.

swcurran commented 1 year ago

Another idea -- could such attributes go in the Capture Base. It is exactly what we're looking for -- language agnostic metadata about the data structure (credential, in our case).

Are we permitted in the spec to extend the Capture Base with additional name/value pairs?

pknowl commented 1 year ago

@swcurran My suggestion would be to drive that through the Capture Base with a "default_language" attribute. That provides an opportunity to spin a default language through the entire bundle, as all Overlays rely on a Capture Base.

I haven't discussed this potential solution with the OCA technical experts, but conceptually, it sounds reasonable.

I have another potential solution on this topic, but I want to consider it further before bringing it up in this thread.

pknowl commented 1 year ago

@swcurran I spoke to @mitfik about default language. He confirmed that it is not the responsibility of OCA to set a default language. The interface which parses the bundle is responsible for that.