Skip to content

Commit

Permalink
feat: add missing python sdk guides based on DatahubGraph (datahub-pr…
Browse files Browse the repository at this point in the history 
…oject#7875)

Co-authored-by: socar-dini <[email protected]>
Co-authored-by: Shirshanka Das <[email protected]>
  • Loading branch information
@yoonhyejin @socar-dini @shirshanka
3 people authored May 2, 2023
1 parent 3c04b1b commit 8a7aeac
Show file tree
Hide file tree
Showing 31 changed files with 792 additions and 295 deletions.
20 changes: 10 additions & 10 deletions docs-website/sidebars.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -308,16 +308,16 @@ module.exports = {
},
"metadata-integration/java/as-a-library",
{
"Getting Started: APIs & SDKs": [
"docs/api/tutorials/modifying-dataset-tags",
"docs/api/tutorials/modifying-dataset-terms",
"docs/api/tutorials/modifying-dataset-owners",
"docs/api/tutorials/modifying-dataset-domains",
"docs/api/tutorials/modifying-datasets",
"docs/api/tutorials/modifying-dataset-lineage",
"docs/api/tutorials/modifying-dataset-deprecation",
"docs/api/tutorials/modifying-dataset-descriptions",
"docs/api/tutorials/modifying-dataset-custom-properties",
"API and SDK Guides": [
"docs/api/tutorials/datasets",
"docs/api/tutorials/lineage",
"docs/api/tutorials/tags",
"docs/api/tutorials/terms",
"docs/api/tutorials/owners",
"docs/api/tutorials/domains",
"docs/api/tutorials/deprecation",
"docs/api/tutorials/descriptions",
"docs/api/tutorials/custom-properties",
],
},
{
Expand Down
57 changes: 28 additions & 29 deletions docs/api/datahub-apis.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,32 +61,31 @@ Here's an overview of what each API can do.

> Last Updated : Apr 8 2023
| Feature | GraphQL | Python SDK | OpenAPI |
|---------------------------------------------------------|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| ------- |
| Create a dataset | 🚫 | ✅ [[Guide]](/docs/api/tutorials/modifying-datasets.md) | ✅ |
| Delete a dataset (Soft delete) | ✅ [[Guide]](/docs/api/tutorials/modifying-datasets.md#delete-dataset) | ✅ [[Guide]](/docs/api/tutorials/modifying-datasets.md#delete-dataset) | ✅ |
| Delete a dataset (Hard delele) | 🚫 | ✅ [[Guide]](/docs/api/tutorials/modifying-datasets.md#delete-dataset) | ✅ |
| Search a dataset | ✅ | ✅ | ✅ |
| Create a tag | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md) | ✅ |
| Read a tag | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md) | ✅ | ✅ |
| Add tags to a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ | ✅ |
| Add tags to a column of a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ |
| Remove tags from a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ |
| Create glossary terms | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-terms.md) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-terms.md) | ✅ |
| Read terms from a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ | ✅ |
| Add terms to a column of a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-terms.md#add-temrms) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-terms.md#add-temrms) | ✅ |
| Add terms to a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-terms.md#add-temrms) | ✅ | ✅ |
| Create domains | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md) | ✅ |
| Read domains | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md) | ✅ | ✅ |
| Add domains to a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ |
| Remove domains from a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-tags.md#add-tags) | ✅ |
| Crate users and groups | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-owners.md#add-owners) | ✅ | ✅ |
| Read owners of a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-owners.md#add-owners) | ✅ | ✅ |
| Add owner to a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-owners.md#add-owners) | ✅ | ✅ |
| Add owner to a column of a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-owners.md#add-owners) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-owners.md#add-owners) | ✅ |
| Remove owner from a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-owners.md#add-owners) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-owners.md#add-owners) | ✅ |
| Add lineage | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-lineage.md#add-lineage) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-lineage.md#add-lineage) | ✅ |
| Add column level(Fine Grained) lineage | 🚫 | ✅ | ✅ |
| Add documentation(description) to a column of a dataset | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-descriptions.md#add-description-on-column) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-descriptions.md#add-description-on-column) | ✅ |
| Add documentation(description) to a dataset | 🚫 | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-descriptions.md#add-description-on-dataset) | ✅ |
| Add / Remove / Replace custom properties on a dataset | 🚫 [[Guide]](/docs/api/tutorials/modifying-dataset-custom-properties.md) | ✅ [[Guide]](/docs/api/tutorials/modifying-dataset-custom-properties.md) | ✅ |
| Feature | GraphQL | Python SDK | OpenAPI |
| ------------------------------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------- |
| Create a dataset | 🚫 | ✅ [[Guide]](/docs/api/tutorials/datasets.md) | ✅ |
| Delete a dataset (Soft delete) | ✅ [[Guide]](/docs/api/tutorials/datasets.md#delete-dataset) | ✅ [[Guide]](/docs/api/tutorials/datasets.md#delete-dataset) | ✅ |
| Delete a dataset (Hard delele) | 🚫 | ✅ [[Guide]](/docs/api/tutorials/datasets.md#delete-dataset) | ✅ |
| Search a dataset | ✅ | ✅ | ✅ |
| Create a tag | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ |
| Read a tag | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ |
| Add tags to a dataset | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ |
| Add tags to a column of a dataset | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ |
| Remove tags from a dataset | ✅ [[Guide]](/docs/api/tutorials/tags.md) | ✅ [[Guide]](/docs/api/tutorials/tags.md#add-tags) | ✅ |
| Create glossary terms | ✅ [[Guide]](/docs/api/tutorials/terms.md) | ✅ [[Guide]](/docs/api/tutorials/terms.md) | ✅ |
| Read terms from a dataset | ✅ [[Guide]](/docs/api/tutorials/terms.md) | ✅ [[Guide]](/docs/api/tutorials/terms.md) | ✅ |
| Add terms to a column of a dataset | ✅ [[Guide]](/docs/api/tutorials/terms.md) | ✅ [[Guide]](/docs/api/tutorials/terms.md) | ✅ |
| Add terms to a dataset | ✅ [[Guide]](/docs/api/tutorials/terms.md) | ✅ [[Guide]](/docs/api/tutorials/terms.md) | ✅ |
| Create domains | ✅ [[Guide]](/docs/api/tutorials/domains.md) | ✅ [[Guide]](/docs/api/tutorials/domains.md) | ✅ |
| Read domains | ✅ [[Guide]](/docs/api/tutorials/domains.md) | ✅ [[Guide]](/docs/api/tutorials/domains.md) | ✅ |
| Add domains to a dataset | ✅ [[Guide]](/docs/api/tutorials/domains.md) | ✅ [[Guide]](/docs/api/tutorials/domains.md) | ✅ |
| Remove domains from a dataset | ✅ [[Guide]](/docs/api/tutorials/domains.md) | ✅ [[Guide]](/docs/api/tutorials/domains.md) | ✅ |
| Crate users and groups | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ |
| Read owners of a dataset | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ |
| Add owner to a dataset | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ |
| Remove owner from a dataset | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ |
| Add lineage | ✅ [[Guide]](/docs/api/tutorials/lineage.md) | ✅ [[Guide]](/docs/api/tutorials/lineage.md) | ✅ |
| Add column level(Fine Grained) lineage | 🚫 | ✅ | ✅ |
| Add documentation(description) to a column of a dataset | ✅ [[Guide]](/docs/api/tutorials/descriptions.md#add-description-on-column) | ✅ [[Guide]](/docs/api/tutorials/descriptions.md#add-description-on-column) | ✅ |
| Add documentation(description) to a dataset | 🚫 | ✅ [[Guide]](/docs/api/tutorials/descriptions.md#add-description-on-dataset) | ✅ |
| Add / Remove / Replace custom properties on a dataset | 🚫 [[Guide]](/docs/api/tutorials/custom-properties.md) | ✅ [[Guide]](/docs/api/tutorials/custom-properties.md) | ✅ |
34 changes: 17 additions & 17 deletions docs/api/graphql/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ The following `graphql` query retrieves the `urn` and `name` of the `properties`
In addition to the URN and properties, you can also fetch other types of metadata for an asset, such as owners, tags, domains, and terms of an entity.
For more information on, please refer to the following links."

- [Querying for Owners of a Dataset](/docs/api/tutorials/modifying-dataset-owners.md#read-owners)
- [Querying for Tags of a Dataset](/docs/api/tutorials/modifying-dataset-tags.md#read-tags)
- [Querying for Domain of a Dataset](/docs/api/tutorials/modifying-dataset-domains.md#read-domains)
- [Querying for Glossary Terms of a Dataset](/docs/api/tutorials/modifying-dataset-terms.md#read-terms)
- [Querying for Deprecation of a dataset](/docs/api/tutorials/modifying-dataset-deprecation.md#read-deprecation)
- [Querying for Owners of a Dataset](/docs/api/tutorials/owners.md#read-owners)
- [Querying for Tags of a Dataset](/docs/api/tutorials/tags.md#read-tags)
- [Querying for Domain of a Dataset](/docs/api/tutorials/domains.md#read-domains)
- [Querying for Glossary Terms of a Dataset](/docs/api/tutorials/terms.md#read-terms)
- [Querying for Deprecation of a dataset](/docs/api/tutorials/deprecation.md#read-deprecation)

### Search

Expand Down Expand Up @@ -96,18 +96,18 @@ mutation updateDashboard {

For more information, please refer to following links.

- [Adding Tags](/docs/api/tutorials/modifying-dataset-tags.md#add-tags)
- [Adding Glossary Terms](/docs/api/tutorials/modifying-dataset-terms.md#add-terms)
- [Adding Domain](/docs/api/tutorials/modifying-dataset-domains.md#add-domains)
- [Adding Owners](/docs/api/tutorials/modifying-dataset-owners.md#add-owners)
- [Removing Tags](/docs/api/tutorials/modifying-dataset-tags.md#remove-tags)
- [Removing Glossary Terms](/docs/api/tutorials/modifying-dataset-terms.md#remove-terms)
- [Removing Domain](/docs/api/tutorials/modifying-dataset-domains.md#remove-domains)
- [Removing Owners](/docs/api/tutorials/modifying-dataset-owners.md#remove-owners)
- [Updating Deprecation](/docs/api/tutorials/modifying-dataset-deprecation.md#update-deprecation)
- [Editing Description (i.e. Documentation) on Datasets](/docs/api/tutorials/modifying-dataset-descriptions.md#add-description-on-dataset)
- [Editing Description (i.e. Documentation) on Columns](/docs/api/tutorials/modifying-dataset-descriptions.md#add-description-on-column)
- [Soft Deleting](/docs/api/tutorials/modifying-datasets.md#delete-dataset)
- [Adding Tags](/docs/api/tutorials/tags.md#add-tags)
- [Adding Glossary Terms](/docs/api/tutorials/terms.md#add-terms)
- [Adding Domain](/docs/api/tutorials/domains.md#add-domains)
- [Adding Owners](/docs/api/tutorials/owners.md#add-owners)
- [Removing Tags](/docs/api/tutorials/tags.md#remove-tags)
- [Removing Glossary Terms](/docs/api/tutorials/terms.md#remove-terms)
- [Removing Domain](/docs/api/tutorials/domains.md#remove-domains)
- [Removing Owners](/docs/api/tutorials/owners.md#remove-owners)
- [Updating Deprecation](/docs/api/tutorials/deprecation.md#update-deprecation)
- [Editing Description (i.e. Documentation) on Datasets](/docs/api/tutorials/descriptions.md#add-description-on-dataset)
- [Editing Description (i.e. Documentation) on Columns](/docs/api/tutorials/descriptions.md#add-description-on-column)
- [Soft Deleting](/docs/api/tutorials/datasets.md#delete-dataset)

Please refer to [Datahub API Comparison](/docs/api/datahub-apis.md#datahub-api-comparison) to navigate to the use-case oriented guide.

Expand Down
Loading

0 comments on commit 8a7aeac

Please sign in to comment.