read
Options
str
required
Repository name.
str | None
Organization override.
str | None
Change ID to read from. Defaults to the current change at the repository’s default bookmark tip.
str | None
Repository-relative path. Omit for the repository root.
int | None
Directory traversal depth.
0 returns directory metadata only, 1 returns direct children, and the server maximum is 10.Response
The method returns one generated model variant. The generatedtype_ field
remains available, and type is exposed as a read-only alias.
bool
Returns
True when the response is a regular file.bool
Returns
True when the response is a directory.bool
Returns
True when the response is a symlink.ContentFile
Regular file content.
ContentSymlink
Symbolic link content.
ContentDirectory
Directory listing.
ContentFile
'file'
Content variant discriminator.
str
Base name of the file.
str
Repository-relative path.
str
Git object SHA.
bool | None
Whether this path is conflicted when known.
int
Size in bytes.
'base64'
Encoding used for
content.str
Base64-encoded file bytes.
'100644' | '100755'
POSIX file mode.
dict[str, str] | None
Extended attributes for this path. Values are base64-encoded.
ContentSymlink
'symlink'
Content variant discriminator.
str
Base name of the symlink.
str
Repository-relative path.
str
Git object SHA.
bool | None
Whether this path is conflicted when known.
int
Size in bytes.
'base64'
Encoding used for
content.str
Base64-encoded symlink target bytes.
'120000'
POSIX symlink mode.
dict[str, str] | None
Extended attributes for this path. Values are base64-encoded.
ContentDirectory
'dir'
Content variant discriminator.
str
Base name of the directory.
str
Repository-relative path.
str
Git object SHA.
int
Number of direct children in this directory.
list[ContentDirectoryEntry]
Directory entries returned for the requested depth.
dict[str, str] | None
Extended attributes attached to this directory. Values are base64-encoded.
ContentDirectoryEntry
'file' | 'symlink' | 'dir'
Entry variant discriminator.
str
Base name of the entry.
str
Repository-relative path.
str
Git object SHA.
int | None
Size in bytes for file and symlink entries.
'100644' | '100755' | '120000' | None
POSIX mode for file and symlink entries.