diff --git a/docs/how/entity-onboarding.md b/docs/how/entity-onboarding.md index d168efa567..fd9a6f4386 100644 --- a/docs/how/entity-onboarding.md +++ b/docs/how/entity-onboarding.md @@ -12,10 +12,9 @@ Refer to [here](../what/urn.md) for URN definition. Refer to [metadata modelling](metadata-modelling.md) section. Make sure to do the following: 1. Define [Aspect] models. -2. Define aspect union model. Refer to [DatasetAspect] as an example. -3. Define [Snapshot] model. Refer to [DatasetSnapshot] as an example. +2. Define aspect union model. Refer to [`DatasetAspect`] as an example. +3. Define [Snapshot] model. Refer to [`DatasetSnapshot`] as an example. 4. Add your newly defined snapshot to [Snapshot Union] model. -5. Define [Entity] model. Refer to [DatasetEntity] as an example. ## 3. GMA search onboarding Refer to [search onboarding](search-onboarding.md). @@ -23,17 +22,19 @@ Refer to [search onboarding](search-onboarding.md). ## 4. GMA graph onboarding Refer to [graph onboarding](graph-onboarding.md). -## 5. Add rest.li resource endpoint -See [CorpUsers] for an example of top-level [resource endpoint] +## 5. Add rest.li resource endpoints +See [`CorpUsers`] for an example of top-level [resource endpoint]. Optionally add aspect-specific [sub-resource endpoint] such as [`CorpUsersEditableInfoResource`]. ## 6. UI for entity onboarding [WIP] [Aspect]: ../what/aspect.md -[DatasetAspect]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/aspect/DatasetAspect.pdsc +[`DatasetAspect`]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/aspect/DatasetAspect.pdsc [Snapshot]: ../what/snapshot.md -[DatasetSnapshot]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/snapshot/DatasetSnapshot.pdsc +[`DatasetSnapshot`]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/snapshot/DatasetSnapshot.pdsc [Snapshot Union]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/snapshot/Snapshot.pdsc [Entity]: ../what/entity.md [DatasetEntity]: ../../metadata-models/src/main/pegasus/com/linkedin/metadata/entity/DatasetEntity.pdsc -[CorpUsers]: ../../gms/impl/src/main/java/com/linkedin/identity/rest/resources/CorpUsers.java +[`CorpUsers`]: ../../gms/impl/src/main/java/com/linkedin/identity/rest/resources/CorpUsers.java [resource endpoint]: https://linkedin.github.io/rest.li/user_guide/restli_server#writing-resources +[sub-resource endpoint]: https://linkedin.github.io/rest.li/user_guide/restli_server#sub-resources +[`CorpUsersEditableInfoResource`]: ../../gms/impl/src/main/java/com/linkedin/identity/rest/resources/CorpUsersEditableInfoResource.java