Hanzo
OpenapiGit

Returns the README at the tree root as plain text — unrendered, so the caller…

Returns the README at the tree root as plain text — unrendered, so the caller decides how to present it.

GET /v1/git/repos/{name}/readme

Addresshttps://api.hanzo.ai/v1/git/repos/{name}/readme
MethodGET
Operationget_git_repos_by_name_readme
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the README at the tree root as plain text — unrendered, so the caller decides how to present it. A repo with no README is not found.

Request

2 fields.

FieldInTypeRequiredDescription
namepathstringyesName is the repo to read, from the :name path segment.
refquerystringRef is a branch, tag or commit; empty means the repo's HEAD.

Response

StatusBodyMeaning
200readmeJSONok

200 body — 3 fields.

FieldInTypeAlwaysDescription
contentbodystringContent is the file's text, verbatim and unrendered.
encodingbodystringEncoding is always "utf8" — a README is text by definition.
pathbodystringPath is the file the README was found at (README.md, README, …).

Failure carries the platform error shape — see Errors.

Examples

hanzo git repos readme <name>

Git API · All Hanzo APIs · Interactive reference

How is this guide?

On this page