search

awslabs / frontend-discovery

The aim of this project is to define and drive adoption of a frontend discovery pattern, with a primary focus on client-side rendered (CSR), server-side rendered (SSR) and edge-side rendered (ESR) micro-frontends
MIT No Attribution
148 stars 4 forks source link

Metadata open for extension #2

Open gareth-bird opened 1 year ago

gareth-bird commented 1 year ago

Hi Luca and friends of MFEs. I'll jump right in.

Question Would you consider enabling the metadata object in the schema so it's open for extension. i.e. by removing or setting to true?

"additionalProperties": false

Rational In the organisation that I work for, a MFE is identified using a convention; this looks something like {org}:{bc}:{mfename} ; reading from right to left mfename is the MFE name {bc} is the owning bounded context and {org} is the serving organisation.

Ideally it would be logical to place this meta information in the metadata section to make it easy to read from a human and machine perspective; adding this to another meta object in the extras section simply looks odd and kind of wrong.

If you look at another json schema CloudEvents (https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md), it is designed open to extension; meaning additional attributes can be added at the top level without impact to the convention; this enables an architecture to build upon a great standard but yet add additional characteristics as fits need.

Thank you kindly for considering. Gareth.

lucamezzalira commented 1 year ago

Hey Gareth thanks a lot for the request.

it's a fair comment, let me share back with the team and have a thought