Notes Read

Read the Git note attached to a commit or other Git object SHA. Notes let you store review status, handoff details, or other context without changing repository contents.

Deprecated: Use /api/repos/{repo_name}/notes instead.

GET /api/v1/repos/notes

Notes Read

cURL

curl --request GET \
  --url https://api.{cluster}.code.storage/api/v1/repos/notes \
  --header 'Authorization: Bearer <token>'

200

{
  "note": "Reviewed. Ready for production.",
  "ref_sha": "0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492",
  "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sha · string · required

Git object SHA whose note should be fetched.

Response

200

application/json

The note stored for the requested Git object.

A single Git note attached to a commit, including the current notes ref tip.

note · string · required

The note content.

Example:

"Reviewed. Ready for production."

ref_sha · string · required

Current SHA of refs/notes/commits.

Example:

"0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492"

sha · string · required

The commit SHA.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"