Create Pull Request API parameters insufficient documentation

[hramrach]

Description

https://docs.gitea.com/api/1.24/#tag/repository/operation/repoListPullRequests (should be https://docs.gitea.com/api/1.24/#tag/repository/operation/repoCreatePullRequest but the anchors are off-by one) shows:

Request Body schema: application/json

assignee | string
-- | --
assignees | Array of strings
base | string
body | string
due_date | string <date-time>
head | string
labels | Array of integers <int64> [ items <int64 > ]
milestone | integer <int64>
reviewers | Array of strings
team_reviewers | Array of strings
title | string

Presumably base and head some how specify the source and target (or target and source?) of the PR. The meaning and format is not documented. Is this only for local PRs inside a single repository, or can a different repository be somehow specified? Which is the source and which the target?

Gitea Version

1.24

Can you reproduce the bug on the Gitea demo site?

Yes

Log Gist

No response

Screenshots

No response

Git Version

No response

Operating System

No response

How are you running Gitea?

.

Database

None

[hramrach]

In git terms PRs are suggestions to merge one branch into another. 'head' is completely generic, and 'base' is used in some other contexts such as rebase as the upstream so it's probably meant to be a suggestion to merge 'head' into 'base'. A short description of the API would go a long way to clarify that.

As for merging between repositories skimming through the source this does not seem possible, and as such this does not do anything of use for me.

Is there any API that can open PR between different repositories?

If there is one that would be also something to reference in the description.

[hramrach]

hm, nope: there is repo ID for both head and base:

            HeadRepoID: compareResult.headRepo.ID,
            BaseRepoID: repo.ID,

so it's probably possible to specify the repository to merge from but it's not documented how.