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

fix(docs): Updating Tag, Glossary Term docs to point to correct GraphQL methods #6965

Merged
merged 5 commits into from
Jan 9, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions datahub-graphql-core/src/main/resources/entity.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -1541,7 +1541,7 @@ type GlossaryTerm implements Entity {
type: EntityType!

"""
Name / id of the glossary term
A unique identifier for the Glossary Term. Deprecated - Use properties.name field instead instead.
jjoyce0510 marked this conversation as resolved.
Show resolved Hide resolved
"""
name: String! @deprecated

Expand Down Expand Up @@ -3571,7 +3571,7 @@ type Tag implements Entity {
type: EntityType!

"""
The name / id of the tag. Use properties.name instead.
A unique identifier for the Tag. Deprecated - Use properties.name field instead instead.
jjoyce0510 marked this conversation as resolved.
Show resolved Hide resolved
"""
name: String! @deprecated

Expand Down
12 changes: 12 additions & 0 deletions docs/glossary/business-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,18 @@ In the modal that pops up you can select the Term you care about in one of two w

Check out [our demo site](https://demo.datahubproject.io/glossary) to see an example Glossary and how it works!

### GraphQL

* [addTerm](../../graphql/mutations.md#addterm)
* [addTerms](../../graphql/mutations.md#addterms)
* [batchAddTerms](../../graphql/mutations.md#batchaddterms)
* [removeTerm](../../graphql/mutations.md#removeterm)
* [batchRemoveTerms](../../graphql/mutations.md#batchremoveterms)
* [createGlossaryTerm](../../graphql/mutations.md#createglossaryterm)
* [createGlossaryNode](../../graphql/mutations.md#createglossarynode) (Term Group)

You can easily fetch the Glossary Terms for an entity with a given its URN using the "glossaryTerms" property. Check out [Working with Metadata Entities](../api/graphql/querying-entities.md#querying-for-glossary-terms-of-an-asset) for an example.
jjoyce0510 marked this conversation as resolved.
Show resolved Hide resolved

## Resources
- [Creating a Business Glossary and Putting it to use in DataHub](https://blog.datahubproject.io/creating-a-business-glossary-and-putting-it-to-use-in-datahub-43a088323c12)
- [Tags and Terms: Two Powerful DataHub Features, Used in Two Different Scenarios](https://medium.com/datahub-project/tags-and-terms-two-powerful-datahub-features-used-in-two-different-scenarios-b5b4791e892e)
Expand Down
14 changes: 10 additions & 4 deletions docs/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,16 @@ You can search for a tag in the search bar, and even filter entities by the pres

### GraphQL

* [Tag](../graphql/queries.md#tag)
* [AddTagsInput](../graphql/inputObjects.md#addtagsinput)
* [BatchAddTagsInput](../graphql/inputObjects.md#batchaddtagsinput)
* [BatchRemoveTagsInput](../graphql/inputObjects.md#batchremovetagsinput)
* [addTag](../graphql/mutations.md#addtag)
* [addTags](../graphql/mutations.md#addtags)
* [batchAddTags](../graphql/mutations.md#batchaddtags)
* [removeTag](../graphql/mutations.md#removetag)
* [batchRemoveTags](../graphql/mutations.md#batchremovetags)
* [createTag](../graphql/mutations.md#createtag)
* [updateTag](../graphql/mutations.md#updatetag)
* [deleteTag](../graphql/mutations.md#deletetag)

You can easily fetch the Tags for an entity with a given its URN using the "tags" property. Check out [Working with Metadata Entities](./api/graphql/querying-entities.md#querying-for-tags-of-an-asset) for an example.
jjoyce0510 marked this conversation as resolved.
Show resolved Hide resolved

### DataHub Blog

Expand Down