Some of the commands docs have an argument set that is not correctly set or incoherent. Some arguments are marked as "required" even though it shouldn't...
Current docs show both --branch <id> and a required <branch name> positional argument for some commands.
Docs:
Examples from current docs:
xata branch delete [--organization <id>] [--project <id>] [--branch <id>] [--yes] [--json] <branch name>
xata branch url [--organization <id>] [--project <id>] [--branch <id>] [--database <name>] [--type <type>] <branch name>
Local CLI help from xata-cli 1.5.4 shows the positional as optional:
xata branch delete
ARGUMENTS
[branch name] The branch to delete
xata branch url
ARGUMENTS
[branch name] The branch to get URL for
The docs makes CLI look different than it is. Branch id is the stable automation input, and the current CLI appears to accept it without also requiring a branch name.
Expected behavior:
Docs should show <branch name> as optional when --branch id is provided, or otherwise clearly explain the fallback behavior.
Overall docs is drifting too much from actual behavior.
Some of the commands docs have an argument set that is not correctly set or incoherent. Some arguments are marked as "required" even though it shouldn't...
Current docs show both
--branch <id>and a required<branch name>positional argument for some commands.Docs:
xata branch delete: https://xata.io/docs/cli/branchxata branch url: https://xata.io/docs/cli/branchExamples from current docs:
Local CLI help from
xata-cli1.5.4 shows the positional as optional:xata branch delete ARGUMENTS [branch name] The branch to delete xata branch url ARGUMENTS [branch name] The branch to get URL forThe docs makes CLI look different than it is. Branch id is the stable automation input, and the current CLI appears to accept it without also requiring a branch name.
Expected behavior:
Docs should show
<branch name>as optional when--branchid is provided, or otherwise clearly explain the fallback behavior.Overall docs is drifting too much from actual behavior.