git.files.highlighted

One file as lines with syntax highlighting

GET /git/api/repositories/{repoId}/highlightedIAM git:PullRepositoryReadSensitive read, audited

`lines` is the text split into lines; `html` one highlighted HTML fragment per line (both themes as CSS variables), or null when the file is over 512 KiB or has no known language.

Request syntax

GET /git/api/repositories/{repoId}/highlighted

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Query parameters

  • refOptional

    string

    Branch, tag or commit id; the default branch when absent

    Constraints: 1-255 chars

  • pathRequired

    string

    The file's path from the repository root, e.g. src/index.ts

    Constraints: 1-1000 chars

Response

200 with { lines, html }: the file’s text split into lines, and one highlighted HTML fragment per line or null. 404 when the file does not exist or is binary.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • linesAlways

    array of string

    The file's text split into lines
  • htmlAlways

    array of string, may be null

    One highlighted HTML fragment per line; null when the file is over 512 KiB or its language is unknown

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:PullRepository on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git files highlighted repoId --path example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_files_highlighted.