docs(ingest/mode): update mode workspace docs (#12774)

This commit is contained in:
Harshal Sheth 2025-03-07 15:41:11 -08:00 committed by GitHub
parent 47f59e62dd
commit c8347a72ee
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -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")