Skip to content

read-file.md

Latest commit

 

History

History
46 lines (39 loc) · 1.12 KB

read-file.md

File metadata and controls

46 lines (39 loc) · 1.12 KB
Raw
title Read file
section api
sidebar true

POST /repositories/read-file

Read file content at HEAD, a commit SHA, or a release tag.

Guide: [Release tags]({{ '/guides/versioning/' | relative_url }})

Request body

Field Type Description
creator_user_id string Owner
payment_request_id string Payment request
relative_path string Path inside repo
commit_sha string? Optional commit (exclusive with version_tag)
version_tag string? Optional tag e.g. v2 (exclusive with commit_sha)

Response 200

{
  "path": "invoice.md",
  "content": "# Invoice\nTotal: 100",
  "commit_sha": "…",
  "version_tag": "v2"
}
curl -sS -X POST "$BASE/repositories/read-file" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-User-Id: user-1" \
  -H "Content-Type: application/json" \
  -d '{
    "creator_user_id":"user-1",
    "payment_request_id":"pr-100",
    "relative_path":"invoice.md",
    "version_tag":"v2"
  }'