[DG-573] Add description field to entities/relationships #7600
+111
−87
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for segment-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
stayseesong
requested changes
May 2, 2025
Comment on lines
+5
to
+6
| - "/unify/linked-profiles/data-graph" | ||
| - "/unify/data-graph/data-graph" |
There was a problem hiding this comment.
Suggested change
| - "/unify/linked-profiles/data-graph" | |
| - "/unify/data-graph/data-graph" | |
| - '/unify/linked-profiles/data-graph' | |
| - '/unify/data-graph/data-graph' |
| | Parameters | Definition | | ||
| | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `entity` | An immutable slug for the entity, and will be treated as a delete if you make changes. The slug must be in all lowercase, and supports dashes or underscores (e.g `account-entity` or `account_entity`). | | ||
| | (Optional) `description` | An optional descriptor used to add additional context to the entity | |
There was a problem hiding this comment.
Suggested change
| | (Optional) `description` | An optional descriptor used to add additional context to the entity | | |
| | `description` (*Optional*) | An optional descriptor used to add additional context to the entity. | |
| | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `relationship` | An immutable slug for the relationship, and will be treated as a delete if you make changes. The slug must be in all lowercase, and supports dashes or underscores (like `user-account` or `user_account`) | | ||
| | `name` | A label displayed throughout your Segment space for Linked Events, Linked Audiences, etc. This name can be modified at any time | | ||
| | (Optional) `description` | An optional descriptor used to add additional context to the relationship | |
There was a problem hiding this comment.
Suggested change
| | (Optional) `description` | An optional descriptor used to add additional context to the relationship | | |
| | `description` (*Optional*) | An optional descriptor used to add additional context to the relationship. | |
| | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `relationship` | An immutable slug for the relationship, and will be treated as a delete if you make changes. The slug must be in all lowercase, and supports dashes or underscores (like `user-account` or `user_account`) | | ||
| | `name` | A label displayed throughout your Segment space for Linked Events, Linked Audiences, and so on. This name can be modified at any time | | ||
| | (Optional) `description` | An optional descriptor used to add additional context to the relationship | |
There was a problem hiding this comment.
Suggested change
| | (Optional) `description` | An optional descriptor used to add additional context to the relationship | | |
| | `description` (*Optional*) | An optional descriptor used to add additional context to the relationship. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This PR implements DG-573
In it we add a new
descriptionfield toentities&relationshipsand update HCL examples in Data Graph docs.Merge timing
When should this get merged/published?
Related issues (optional)