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

(docs) Documentation on Glossary source config is wrong #3844

Closed
cccs-eric opened this issue Jan 7, 2022 · 1 comment · Fixed by #3858
Closed

(docs) Documentation on Glossary source config is wrong #3844

cccs-eric opened this issue Jan 7, 2022 · 1 comment · Fixed by #3858
Labels
bug Bug report

Comments

@cccs-eric
Copy link
Contributor

Describe the bug
When reading this page (https://datahubproject.io/docs/metadata-ingestion/source_docs/business_glossary/#config-details), it says that owners and url are supposed to be optional for Glossary. But when trying to ingest a file without those fields, I get the following error:

    glossary_cfg = BusinessGlossaryConfig.parse_obj(config)
File "pydantic/main.py", line 578, in pydantic.main.BaseModel.parse_obj
File "pydantic/main.py", line 406, in pydantic.main.BaseModel.__init__

ValidationError: 2 validation errors for BusinessGlossaryConfig
url
  field required (type=value_error.missing)
owners
  field required (type=value_error.missing)

I think the documentation should be modified to state that those fields are mandatory.

@anshbansal
Copy link
Collaborator

anshbansal commented Jan 10, 2022

URL Part was fixed by #3817 which has been released in 0.8.22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bug report
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants