We are useing Datahub and have a number of OpenAPI contracts ingested in it. Our next step is to link those specifications with Terms in glossary. I'd appreciate hearing any best practice or advice on how your are managing linking API Specifications with the terms.
Here are two of the ways we've came up so far:
- link terms and API methods/fields in UI after ingestion of API specification;
- make an additional development in Datahub in order to parse term urn from the specification during ingestion and turn it to relation within Datahub.
Seems that the second way is the one we are considering to implement. But would appreciate if anyone could share any experience for this type of task.
05/25/2023, 5:10 PM
the second way would be super aligned with how we'd like to do it
please let us know if you need any help / guidance on this
05/25/2023, 5:41 PM
Hi Shirshanka, thanks for your feedback. At the moment we're considering two options for the second way:
• include terms' urns to description in specification (with some prefix, like "__") of the contract and parse the description to "extract" terms from it
...and the second one - is to make an additional field in specification and take the urns from it
Definitely - the second one is more reliable, but will take some efforts from the teams who creates the specifications (as the field seems to be mandatory).
If you have any reccomendation or advice on the details of that way - I would really appreciate it
05/30/2023, 1:21 PM
Does OpenAPI contract have any extension mechanism like a map of properties you can assign?