Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ui: Migrate UI to use "properties" field of entity for descriptions #3515

Merged

Conversation

jjoyce0510
Copy link
Collaborator

This PR migrates to using the description field of the standard "properties" bag in the GraphQL API, moving away from using the deprecated "info" fields sporadically. It also addresses a few description-rendering related bugs:

  • Browse previews will correctly reflected edited descriptions
  • All entity pages will correctly reflect system-provisioned descriptions

This is part of an initiative to more toward convergence of common entity fields to make UI development a simpler proecss.

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)

@github-actions
Copy link

github-actions bot commented Nov 4, 2021

Unit Test Results

     36 files  ±0       36 suites  ±0   28m 7s ⏱️ + 1m 40s
   488 tests ±0     436 ✔️ ±0  52 💤 ±0  0 ±0 
1 162 runs  ±0  1 094 ✔️ ±0  68 💤 ±0  0 ±0 

Results for commit 324160f. ± Comparison against base commit ec406c7.

♻️ This comment has been updated with latest results.

@@ -40,7 +40,9 @@ export type EntitySidebarSection = {
export type GenericEntityProperties = {
urn?: string;
name?: Maybe<string>;
description?: Maybe<string>;
properties?: {
description?: string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should name go here too?

Copy link
Contributor

@gabe-lyons gabe-lyons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me!

Copy link
Contributor

@shirshanka shirshanka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@shirshanka shirshanka merged commit 534291d into datahub-project:master Nov 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants