Skip to content

Use a glossary from another repository

  1. Open the atlas of your domain, for example atlas.yaml.
  2. Pick one of the two forms of reference below.
  3. For a glossary checked out next to your own files, add a relative reference under glossaries. A relative reference resolves against the directory of the atlas.
glossaries:
- sales.glossary.yaml
- ../payments/billing.glossary.yaml
  1. For a glossary that the other team publishes, add an absolute https IRI under glossaries.
glossaries:
- sales.glossary.yaml
- https://www.example.org/language/billing.glossary.yaml
  1. Read the boundedContext field of the external glossary.
  2. Write your links against that name.
links:
- from: sales:customer
to: billing:account
relation: close_match
note: Dieselbe Person, in Sales als Kunde geführt, in Billing als Konto.
  1. Validate the atlas together with every glossary it lists.

Your atlas points at the external glossary and holds no copy of it. The other team owns that file and changes it without you.

Two glossaries of one atlas must not carry the same boundedContext. If the external glossary claims the name of one of your own contexts, the invariant ABoundedContextNamesOneGlossary fires.

Written and maintained by Tobias Brennecke.tobiasbrennecke.com