Resolve the branch to use

In order to resolve the database branch, the following algorithm is used:

• if the gitBranch was provided and is found in the git branches mapping, the associated Xata branch is returned
• else, if a Xata branch with the exact same name as gitBranch exists, return it
• else, if fallbackBranch is provided and a branch with that name exists, return it
• else, return the default branch of the DB (main or the first branch)

Example call:

1
// GET https://tutorial-ng7s8c.xata.sh/dbs/demo/dbs/demo/resolveBranch?gitBranch=test&fallbackBranch=tsg

Example response:

1
2
3
4
5
6
7
{
  "branch": "main",
  "reason": {
    "code": "DEFAULT_BRANCH",
    "message": "Default branch for this database (main)"
  }
}

{
  "branch": "main",
  "reason": {
    "code": "DEFAULT_BRANCH",
    "message": "Default branch for this database (main)"
  }
}

type ResolveBranch = {
    id?: string;
    message: string;
};

{
  "message": "invalid API key"
}