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.

Sign up for GitHub

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

Jump to bottom

fix(changeEvents): add description-parameter to the change-event of a schemaField-description #10414

Merged
merged 8 commits into from
May 7, 2024
Merged

fix(changeEvents): add description-parameter to the change-event of a schemaField-description #10414

merged 8 commits into from
May 7, 2024

Conversation

ksrinath
Copy link
Contributor

@ksrinath ksrinath commented May 2, 2024

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

@github-actions github-actions bot added docs Issues and Improvements to docs product PR or Issue related to the DataHub UI/UX community-contribution PR or Issue raised by member(s) of DataHub Community labels May 2, 2024
eboneil
eboneil reviewed May 3, 2024
View reviewed changes
docs/managed-datahub/datahub-api/entity-events-api.md Outdated
Comment on lines 381 to 383
### Modify Description Event

This event is emitted when an existing description of an entity has been modified on DataHub.
Copy link
Contributor

Choose a reason for hiding this comment

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

Since we already have "Add Description Event" (from this PR), can you make this a bit more clear that this is just for schema fields and not entities? Maybe something like "Modify Schema Description Event".

If that means combining these events that works as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reverted this addition to the docs to avoid confusion (this addition also isn't strictly necessary for this PR).

Copy link
Contributor

Choose a reason for hiding this comment

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

Great! LGTM, let me know when you're ready for review

@ksrinath ksrinath marked this pull request as ready for review May 6, 2024 16:26
@anshbansal anshbansal merged commit 28e97dd into datahub-project:master May 7, 2024
42 checks passed
sleeperdeep pushed a commit to sleeperdeep/datahub that referenced this pull request Jun 25, 2024
@ksrinath @sleeperdeep
fix(changeEvents): add description-parameter to the change-event of a…
0983404 
… schemaField-description (datahub-project#10414)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eboneil eboneil eboneil approved these changes

Assignees
No one assigned
Labels
community-contribution PR or Issue raised by member(s) of DataHub Community docs Issues and Improvements to docs product PR or Issue related to the DataHub UI/UX
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ksrinath @eboneil @anshbansal