[Proposal] add api access to git notes

[eveslage]

Your api is quite powerful to access al kinds of information in a git repository. But there is no way to access git-notes.

https://git-scm.com/docs/git-notes

we use git-notes to annotate commits without changing the commit itself. git log shows them along with the commit messages and gitea shows them in the web ui. But the api access is missing.

it would be nice to have access to git-notes though the api.

[emilekm]

// swagger:operation POST /repos/{owner}/{repo}/git/notes/{sha} repository repoCreateNote
// swagger:operation GET /repos/{owner}/{repo}/git/notes/{sha} repository repoGetNote
// swagger:operation PATCH /repos/{owner}/{repo}/git/notes/{sha} repository repoUpdateNote
// swagger:operation DELETE /repos/{owner}/{repo}/git/notes/{sha} repository repoDeleteNote

sha is the commit SHA, body for POST and PATCH would contain only the message.

This is minimal version, I don't see a need to include anything else (like merging notes).
If this looks ok to you I can send MR soon (already did some work).

[emilekm]

Also, do you need a list endpoint?

[eveslage]

That’s good news. I believe for our use case the best would be to have the git-notes info available when retrieving the commits from a repo, for instance, through: /repos/{owner}/{repo}/commits

If there is a performance concern over the general use case, we would also be fine with an additional query parameter that could specify whether to retrieve this data or not.

[nitul1991]

Is this issue still open? I'd like to contribute to gitea and this seems like a good first issue.

[zeripath]

yup it's still open.

[nitul1991]

Thanks for confirming @zeripath. Any tips on getting started with this issue?

[6543]

@nitul1991

1.I would say add func to module/git to be able to interact with notes
2. Add smal unit test for them
3. Add add endpoint
4. Add smal integration test for api

If you need help etc ... feel free to chat with us on discord

[nitul1991]

Thanks @zeripath! This should be enough to get me started.