search

THCLab / oca-ecosystem

European Union Public License 1.2
3 stars 0 forks source link

Recommendation on the type of a "non-OCA core" overlay? #12

Closed swcurran closed 1 year ago

swcurran commented 1 year ago

In the [OCA for Aries RFC (currently a PR)](), we are planning to have an Aries-specific overlay. Is there any guidance on what the overlay type should be? We are thinking of using the following type:

{
  "capture_base": "EPMaG1h2hVxKCZ5_3KoNNwgAyd4Eq8zrxK3xgaaRsz2M",
  "type": "aries/overlays/branding/1.0",
  "logo": "data:image/png;base64,iVBORw...",
.
.
.

Any guidance would be appreciated.

mitfik commented 1 year ago

The detail information how type is defined you can read here

Basically type is simple namespace which allows to identify a specific implementation what to do with the object. In case of the core specification needs to follow the official specification supported types.

For customization as you are suggesting choosing namespace which would not collide with the official specification should do the job. The namespace mentioned above seems reasonable.

swcurran commented 1 year ago

Sounds good -- thanks. I suggest an update to the spec. to say that the ABNF is <namespace>/overlay, define the ABNF rules for namespace (what characters) and that the spec namespace is reserved for overlays defined in the OCA Specification.