bj api¶
Make an authenticated request to the Bitbucket or Jira API.
Synopsis¶
Description¶
Make an authenticated request against the Bitbucket or Jira REST API and print the JSON response. Choose the backend with --backend; --field adds parameters (query string for GET, JSON body otherwise).
Arguments¶
| Argument | Description |
|---|---|
PATH |
API path, e.g. /repositories/{ws}/{repo}. (required) |
Options¶
| Option | Description |
|---|---|
-b, --backend {bitbucket|jira} |
Which API to call. (default: bitbucket) |
-X, --method <text> |
HTTP method. (default: GET) |
-f, --field <text> |
key=value parameter (repeatable). |
-q, --jq <text> |
Filter JSON with jq. |
Examples¶
bj api /repositories/{workspace}/{repo_slug}/pullrequests
bj api --backend jira /myself
bj api --backend jira -X POST /issue/PROJ-42/comment -f body=hi