yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-10-31 10:49:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
datahub/docs/how/add-new-aspect.md
Mars Lan adf975ee18
build: build GitHub Pages from /docs directory (#1752) 
- Move non-README top-level MD files to /docs
- Update all absolute links to files in /docs to relative links
- Add a placeholder front page for GitHub Pages
2020-07-26 10:41:32 -07:00

2.7 KiB
Raw Blame History

How to add a new metadata aspect?

Adding a new metadata aspect is one of the most common ways to extend an existing entity. We'll use the CorpUserEditableInfo as an example here.

  1. Add the aspect model to the corresponding namespace (e.g. com.linkedin.identity)

  2. Extend the entity's aspect union to include the new aspect (e.g. CorpUserAspect)

  3. Rebuild the rest.li IDL & snapshot by running the following command from the project root

./gradlew :gms:impl:build -Prest.model.compatibility=ignore

  1. To surface the new aspect at the top-level resource endpoint, extend the resource data model (e.g. CorpUser) with an optional field (e.g. editableInfo). You'll also need to extend the toValue & toSnapshot methods of the top-level resource (e.g. CorpUsers) to convert between the snapshot & value models.

  2. (Optional) If there's need to update the aspect via API (instead of/in addition to MCE), add a sub-resource endpoint for the new aspect (e.g. CorpUsersEditableInfoResource). The sub-resource endpiont also allows you to retrieve previous versions of the aspect as well as additional metadata such as the audit stamp.

  3. After rebuilding & restarting gms, mce-consumer-job & mae-consumer-job, you should be able to start emitting MCE with the new aspect and have it automatically ingested & stored in DB.