Skip to content

Commit

Permalink
docs(ingest/mode): update mode workspace docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hsheth2 committed Mar 4, 2025
1 parent 3b4f383 commit b4e5f65
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion metadata-ingestion/src/datahub/ingestion/source/mode.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,12 @@ class ModeConfig(
)

workspace: str = Field(
description="The Mode workspace name. Find it in Settings > Workspace > Details."
description="The Mode workspace username. If you navigate to Workspace Settings > Details, "
"the url will be `https://app.mode.com/organizations/<workspace-username>`. "
# The lowercase comment is derived from a comment in a Mode API example.
# https://mode.com/developer/api-cookbook/management/get-all-reports/
# > "Note: workspace_name value should be all lowercase"
"This is distinct from the workspace's display name, and should be all lowercase."
)
_default_schema = pydantic_removed_field("default_schema")

Expand Down

0 comments on commit b4e5f65

Please sign in to comment.