-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Description
The Document entity documentation claims that the Document entity is available in version 1.3.0, but this entity was actually added after v1.3.0 was released and is only available in v1.4.0-preview and later builds.
This causes confusion for users who follow the documentation expecting Document entity to work on v1.3.0, only to receive the error: "Failed to find entity with name document in EntityRegistry"
To Reproduce
Steps to reproduce the behavior:
- Install DataHub v1.3.0 (released October 6, 2025)
- Follow the Document entity documentation to try ingesting a Document entity via REST API or Python SDK
- Attempt to create a Document entity using the documented approaches
- Receive error:
"Failed to find entity with name document in EntityRegistry"
Expected behavior
The documentation should clearly state that:
- Document entity was added on November 17, 2025 (commit
10ce33316a) - It's only available in v1.4.0-preview (released November 23, 2025) and later
- Users on v1.3.0 or earlier cannot use this entity and need to upgrade
- The Python SDK does not yet have high-level classes like
DocumentInfoClass(as of acryl-datahub 1.3.0)
Actual behavior
The documentation page footer states: "Current documentation covers version 1.3.0 of the metadata model" which is incorrect for the Document entity.
Suggested Fix
Update the documentation to:
- Add a prominent version notice at the top: "
⚠️ Document entity requires DataHub v1.4.0-preview or later" - Update the version footer to reflect accurate version availability
- Add a note about Python SDK limitations (no high-level Document classes yet)
- Provide upgrade guidance for users who need this feature
Additional context
This issue was discovered while helping a Slack community member who encountered this exact problem. The user was on v1.3.0 and following the docs, which led to the EntityRegistry error.
Slack Link: https://datahub.slack.com/archives/CUMUWQU66/p1765406035929859