feat(propagation): Add models for schema field docs, tags, terms (#2959)

[shirshanka]

This PR adds model extensions to support documentation and other forms of propagation to schema fields (columns).

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Introduced a new Documentation entity for enhanced metadata management.
  • Added attribution tracking for tags and glossary terms, improving data governance and usability.

• Bug Fixes

  • Resolved inconsistencies in metadata attribution fields across different records.

• Documentation

  • Updated entity registry to include the new documentation entity, enhancing organizational structure for documentation-related information.

• Chores

  • Minor formatting adjustments in configuration files for improved readability.

[coderabbitai]

Walkthrough

The recent changes introduce a new documentation management feature within the metadata model, enhancing how documentation is stored and attributed across various assets. This includes the creation of new records for documentation and attribution, ensuring efficient tracking and retrieval of metadata. Additional fields were added to existing records for better attribution handling, improving overall metadata governance and search capabilities.

Changes

Files	Change Summary
.../Documentation.pdl, .../DocumentationAssociation.pdl	New records for documentation and documentation association, establishing rules for source attribution and searchability.
.../GlossaryTermAssociation.pdl, .../TagAssociation.pdl	Added optional attribution fields with searchable metadata for glossary terms and tags, enhancing metadata tracking.
.../MetadataAttribution.pdl	Introduced a new record to encapsulate metadata attribution details, including fields for time, actor, source, and details.
.../EditableSchemaFieldInfo.pdl, .../SchemaField.pdl	Added new attribution fields for tags and glossary terms to track changes effectively.
.../entity-registry.yml	Introduced a new documentation entity, enhancing the metadata structure for better organization of documentation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocumentationService
    participant MetadataStore

    User->>DocumentationService: Add Documentation
    DocumentationService->>MetadataStore: Store Documentation Entry
    MetadataStore->>DocumentationService: Acknowledge Storage
    DocumentationService->>User: Confirmation of Addition

Loading

🐰 "In fields of data, bright and new,
A world of docs now comes in view.
With tags and terms all tracked with care,
Our metadata's rich, beyond compare!
Hops of joy as changes bloom,
A rabbit's cheer to chase the gloom!" 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d85da39 and afda3fd.

Files selected for processing (8)

• metadata-models/src/main/pegasus/com/linkedin/common/Documentation.pdl (1 hunks)
• metadata-models/src/main/pegasus/com/linkedin/common/DocumentationAssociation.pdl (1 hunks)
• metadata-models/src/main/pegasus/com/linkedin/common/GlossaryTermAssociation.pdl (1 hunks)
• metadata-models/src/main/pegasus/com/linkedin/common/MetadataAttribution.pdl (1 hunks)
• metadata-models/src/main/pegasus/com/linkedin/common/TagAssociation.pdl (1 hunks)
• metadata-models/src/main/pegasus/com/linkedin/schema/EditableSchemaFieldInfo.pdl (2 hunks)
• metadata-models/src/main/pegasus/com/linkedin/schema/SchemaField.pdl (2 hunks)
• metadata-models/src/main/resources/entity-registry.yml (2 hunks)

Additional comments not posted (22)

metadata-models/src/main/pegasus/com/linkedin/common/DocumentationAssociation.pdl (4)

1-2: Namespace declaration is correct.

The namespace com.linkedin.common is appropriately defined.

---

3-5: Comment block is well-defined.

The comment block clearly describes the properties of the DocumentationAssociation record.

---

6-10: Field documentation is correctly defined.

The documentation field is appropriately defined as a string.

---

11-29: Field attribution and @Searchable annotation are correctly defined.

The attribution field is appropriately defined as an optional MetadataAttribution. The @Searchable annotation is well-defined and includes relevant metadata attributes.

metadata-models/src/main/pegasus/com/linkedin/common/TagAssociation.pdl (3)

Line range hint 1-2:
Namespace declaration is correct.

The namespace com.linkedin.common is appropriately defined.

---

Line range hint 3-16:
Comment block and fields tag and context are well-defined.

The comment block clearly describes the properties of the TagAssociation record. The tag and context fields are appropriately defined.

---

17-35: Field attribution and @Searchable annotation are correctly defined.

The attribution field is appropriately defined as an optional MetadataAttribution. The @Searchable annotation is well-defined and includes relevant metadata attributes.

metadata-models/src/main/pegasus/com/linkedin/common/MetadataAttribution.pdl (4)

1-2: Namespace declaration is correct.

The namespace com.linkedin.common is appropriately defined.

---

3-6: Comment block is well-defined.

The comment block clearly describes the properties of the MetadataAttribution record.

---

7-10: Field time is correctly defined.

The time field is appropriately defined as a Time.

---

11-29: Fields actor, source, and sourceDetail are correctly defined.

The actor field is appropriately defined as a Urn. The source field is correctly defined as an optional Urn. The sourceDetail field is correctly defined as a map of strings with a default empty map.

metadata-models/src/main/pegasus/com/linkedin/common/GlossaryTermAssociation.pdl (1)

33-50: Addition of attribution field is approved.

The attribution field enhances the tracking of metadata attribution and the @Searchable annotation is correctly specified.

However, ensure that the MetadataAttribution type is correctly defined and used throughout the codebase.

Verification successful

---

The MetadataAttribution type is correctly defined.

The MetadataAttribution record includes fields for time, actor, source, and sourceDetail, which are essential for tracking metadata attribution. The definition is thorough and aligns with the intended use in the GlossaryTermAssociation.pdl file.

• time: When the metadata was updated.
• actor: The entity responsible for applying the metadata.
• source: The DataHub source responsible for applying the metadata.
• sourceDetail: Additional details about why the metadata was applied.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the definition and usage of `MetadataAttribution`.

# Test: Search for the definition of `MetadataAttribution`. Expect: It should be defined and used correctly.
rg --type pdl 'record MetadataAttribution'

Length of output: 72

---

Script:

#!/bin/bash
# Description: Locate files containing `MetadataAttribution` and verify its definition and usage.

# Locate files containing `MetadataAttribution`
fd . -e pdl -x rg 'MetadataAttribution' {}

Length of output: 205

---

Script:

#!/bin/bash
# Description: Search for the definition of `MetadataAttribution`.

# Search for the definition of `MetadataAttribution`
rg 'record MetadataAttribution'

Length of output: 139

---

Script:

#!/bin/bash
# Description: Display the contents of MetadataAttribution.pdl to verify its definition.

# Display the contents of MetadataAttribution.pdl
cat metadata-models/src/main/pegasus/com/linkedin/common/MetadataAttribution.pdl

Length of output: 951

metadata-models/src/main/pegasus/com/linkedin/common/Documentation.pdl (1)

1-32: Introduction of Documentation record is approved.

The Documentation record is well-defined and includes considerations for future evolution.

However, ensure that the DocumentationAssociation type is correctly defined and used throughout the codebase.

Verification successful

---

The DocumentationAssociation type is correctly defined and used in the codebase.

• The DocumentationAssociation record is defined in metadata-models/src/main/pegasus/com/linkedin/common/DocumentationAssociation.pdl.
• It is used within the Documentation record in metadata-models/src/main/pegasus/com/linkedin/common/Documentation.pdl.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the definition and usage of `DocumentationAssociation`.

# Test: Search for the definition of `DocumentationAssociation`. Expect: It should be defined and used correctly.
rg --type pdl 'record DocumentationAssociation'

Length of output: 77

---

Script:

#!/bin/bash
# Description: Verify the definition and usage of `DocumentationAssociation`.

# Step 1: Locate all .pdl files in the repository.
fd --extension pdl > pdl_files.txt

# Step 2: Search for the definition of `DocumentationAssociation` within these .pdl files.
rg 'record DocumentationAssociation' $(cat pdl_files.txt)

Length of output: 50750

---

Script:

#!/bin/bash
# Description: Verify the usage of `DocumentationAssociation`.

# Step 1: Search for the usage of `DocumentationAssociation` in the codebase.
rg 'DocumentationAssociation' --context 5

Length of output: 2797

metadata-models/src/main/pegasus/com/linkedin/schema/EditableSchemaFieldInfo.pdl (2)

70-81: Addition of glossary terms attribution fields is approved.

The new fields enhance the tracking of metadata attribution for glossary terms and the @Searchable annotations are correctly specified.

However, ensure that the new fields are correctly used throughout the codebase.

---

39-51: Addition of tags attribution fields is approved.

The new fields enhance the tracking of metadata attribution for tags and the @Searchable annotations are correctly specified.

However, ensure that the new fields are correctly used throughout the codebase.

metadata-models/src/main/pegasus/com/linkedin/schema/SchemaField.pdl (6)

99-103: Addition of fieldTagAttributionDates field approved.

The fieldTagAttributionDates field is correctly defined as DATETIME and follows existing conventions.

---

104-107: Addition of fieldTagAttributionActors field approved.

The fieldTagAttributionActors field is correctly defined as URN and follows existing conventions.

---

108-111: Addition of fieldTagAttributionSources field approved.

The fieldTagAttributionSources field is correctly defined as URN and follows existing conventions.

---

130-133: Addition of fieldTermAttributionDates field approved.

The fieldTermAttributionDates field is correctly defined as DATETIME and follows existing conventions.

---

134-137: Addition of fieldTermAttributionActors field approved.

The fieldTermAttributionActors field is correctly defined as URN and follows existing conventions.

---

138-141: Addition of fieldTermAttributionSources field approved.

The fieldTermAttributionSources field is correctly defined as URN and follows existing conventions.

metadata-models/src/main/resources/entity-registry.yml (1)

457-457: Addition of documentation entry approved.

The documentation entry is correctly defined under the entities section and follows existing conventions.

[chriscollins3456]

cool beans