postman-cli-completion 1.76.0 → 1.77.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/completions/bash/postman.bash +64 -11
- package/completions/fish/postman.fish +144 -109
- package/completions/zsh/_postman +125 -71
- package/package.json +1 -1
package/completions/zsh/_postman
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
#compdef postman
|
|
2
2
|
compdef _postman postman
|
|
3
|
-
# Zsh completion for Postman CLI (postman v1.
|
|
3
|
+
# Zsh completion for Postman CLI (postman v1.77.0)
|
|
4
4
|
# Auto-generated by scripts/generate.mjs — DO NOT EDIT
|
|
5
5
|
# Source: spec/commands.json
|
|
6
6
|
# https://github.com/yokawasa/postman-cli-completion
|
|
@@ -163,6 +163,7 @@ _postman_collection() {
|
|
|
163
163
|
publish) _postman_collection_publish ;;
|
|
164
164
|
generate) _postman_collection_generate ;;
|
|
165
165
|
sync) _postman_collection_sync ;;
|
|
166
|
+
share) _postman_collection_share ;;
|
|
166
167
|
request) _postman_collection_request ;;
|
|
167
168
|
folder) _postman_collection_folder ;;
|
|
168
169
|
example) _postman_collection_example ;;
|
|
@@ -186,6 +187,7 @@ _postman_collection_commands() {
|
|
|
186
187
|
'publish:Publish a cloud collection'\''s documentation (or request Community Manager approval).'
|
|
187
188
|
'generate:Generate artifacts from a collection.'
|
|
188
189
|
'sync:Sync artifacts generated from a collection.'
|
|
190
|
+
'share:Grant a role on a collection to one or more people.'
|
|
189
191
|
'request:Add, get, update, or remove requests in a local v3 collection.'
|
|
190
192
|
'folder:Add, get, update, or remove folders in a local v3 collection.'
|
|
191
193
|
'example:Add, update, remove, get, or list examples (saved responses) under a request.'
|
|
@@ -329,6 +331,17 @@ _postman_collection_sync_spec() {
|
|
|
329
331
|
'*:collection:_files -g "*.json"'
|
|
330
332
|
}
|
|
331
333
|
|
|
334
|
+
_postman_collection_share() {
|
|
335
|
+
_arguments \
|
|
336
|
+
'--user[Who to share with. Repeatable, and each value may be a comma-separated list. A value containing @ is treated as an email address, anything else as a Postman user id.]:email|id' \
|
|
337
|
+
'--role[The role to grant. (default\: "viewer")]:viewer|editor' \
|
|
338
|
+
'--json[Print the outcome as machine-readable JSON.]' \
|
|
339
|
+
'--timeout[Milliseconds to wait for Postman. Defaults to 30000.]:ms' \
|
|
340
|
+
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
341
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
342
|
+
'*:id:'
|
|
343
|
+
}
|
|
344
|
+
|
|
332
345
|
_postman_collection_request() {
|
|
333
346
|
local context state state_descr line
|
|
334
347
|
typeset -A opt_args
|
|
@@ -1046,6 +1059,7 @@ _postman_environment() {
|
|
|
1046
1059
|
new) _postman_environment_new ;;
|
|
1047
1060
|
list) _postman_environment_list ;;
|
|
1048
1061
|
get) _postman_environment_get ;;
|
|
1062
|
+
share) _postman_environment_share ;;
|
|
1049
1063
|
delete) _postman_environment_delete ;;
|
|
1050
1064
|
var) _postman_environment_var ;;
|
|
1051
1065
|
lint) _postman_environment_lint ;;
|
|
@@ -1060,6 +1074,7 @@ _postman_environment_commands() {
|
|
|
1060
1074
|
'new:Scaffold a local environment file, or create one in a Postman workspace with --workspace.'
|
|
1061
1075
|
'list:List environments in a Postman workspace.'
|
|
1062
1076
|
'get:Read an environment by ID or local environment file path.'
|
|
1077
|
+
'share:Grant a role on a cloud environment to one or more people.'
|
|
1063
1078
|
'delete:Delete an environment by ID or local environment file path. Prompts unless --yes is passed.'
|
|
1064
1079
|
'var:Read and update environment variables.'
|
|
1065
1080
|
'lint:Run linting on a local Postman environment at the given file or directory path.'
|
|
@@ -1095,6 +1110,17 @@ _postman_environment_get() {
|
|
|
1095
1110
|
'*:environment:_files -g "*.json"'
|
|
1096
1111
|
}
|
|
1097
1112
|
|
|
1113
|
+
_postman_environment_share() {
|
|
1114
|
+
_arguments \
|
|
1115
|
+
'--user[Who to share with. Repeatable, and each value may be a comma-separated list. A value containing @ is treated as an email address, anything else as a Postman user id.]:email|id' \
|
|
1116
|
+
'--role[The role to grant. (default\: "viewer")]:viewer|editor' \
|
|
1117
|
+
'--json[Print the outcome as machine-readable JSON.]' \
|
|
1118
|
+
'--timeout[Milliseconds to wait for Postman. Defaults to 30000.]:ms' \
|
|
1119
|
+
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1120
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1121
|
+
'*:environmentId:_files -g "*.json"'
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1098
1124
|
_postman_environment_delete() {
|
|
1099
1125
|
_arguments \
|
|
1100
1126
|
'(-y --yes)'{-y,--yes}'[Delete without asking for confirmation first]' \
|
|
@@ -1473,7 +1499,7 @@ _postman_mock_generate() {
|
|
|
1473
1499
|
'--deploy[After generating, upload the mock to Postman cloud and deploy it to a live mock server (private by default). Uses --workspace, else the workspace linked to this project.]' \
|
|
1474
1500
|
'--public[With --deploy, let anyone with the link reach the server (default\: callers need an API key)]' \
|
|
1475
1501
|
'(-s --slug)'{-s,--slug}'[With --deploy, the short label used in the server'\''s web address]:slug' \
|
|
1476
|
-
'--json[
|
|
1502
|
+
'--json[Print the result (with --deploy, the live server details) as machine-readable data instead of a summary]' \
|
|
1477
1503
|
'--api-key[Postman API key to use with --workspace or --deploy (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1478
1504
|
'(-x --suppress-exit-code)'{-x,--suppress-exit-code}'[Always exit with code 0, even on failure]' \
|
|
1479
1505
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
@@ -1499,6 +1525,7 @@ _postman_mock_push() {
|
|
|
1499
1525
|
_arguments \
|
|
1500
1526
|
'(-w --workspace)'{-w,--workspace}'[Postman cloud workspace to upload to, by id (defaults to the workspace already linked to this project)]:id' \
|
|
1501
1527
|
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1528
|
+
'--json[Print the result as machine-readable data]' \
|
|
1502
1529
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1503
1530
|
'*:mockPath:_files -g "*.json"'
|
|
1504
1531
|
}
|
|
@@ -1520,7 +1547,7 @@ _postman_mock_deploy() {
|
|
|
1520
1547
|
_postman_mock_get() {
|
|
1521
1548
|
_arguments \
|
|
1522
1549
|
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1523
|
-
'--json[Print the details as machine-readable data instead of a
|
|
1550
|
+
'--json[Print the details as machine-readable data instead of a summary]' \
|
|
1524
1551
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1525
1552
|
'*:mockIdOrPath:_files -g "*.json"'
|
|
1526
1553
|
}
|
|
@@ -1552,6 +1579,7 @@ _postman_mock_delete() {
|
|
|
1552
1579
|
_arguments \
|
|
1553
1580
|
'(-y --yes)'{-y,--yes}'[Delete without asking for confirmation first]' \
|
|
1554
1581
|
'--api-key[Postman API key, used with a Postman cloud id (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1582
|
+
'--json[Print the result as machine-readable data (requires --yes)]' \
|
|
1555
1583
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1556
1584
|
'*:mockIdOrPath:_files -g "*.json"'
|
|
1557
1585
|
}
|
|
@@ -1577,6 +1605,7 @@ _postman_monitor() {
|
|
|
1577
1605
|
metrics) _postman_monitor_metrics ;;
|
|
1578
1606
|
pause) _postman_monitor_pause ;;
|
|
1579
1607
|
resume) _postman_monitor_resume ;;
|
|
1608
|
+
share) _postman_monitor_share ;;
|
|
1580
1609
|
esac
|
|
1581
1610
|
;;
|
|
1582
1611
|
esac
|
|
@@ -1585,17 +1614,18 @@ _postman_monitor() {
|
|
|
1585
1614
|
_postman_monitor_commands() {
|
|
1586
1615
|
local -a sub
|
|
1587
1616
|
sub=(
|
|
1588
|
-
'run:
|
|
1617
|
+
'run:Run a monitor now and report the result.'
|
|
1589
1618
|
'create:Create a collection-based monitor.'
|
|
1590
1619
|
'update:Update a monitor'\''s schedule, runner, notifications, request selection or run options.'
|
|
1591
1620
|
'delete:Permanently delete a monitor. Prompts for confirmation unless --yes is passed.'
|
|
1592
|
-
'jobs:Inspect a monitor'\''s jobs and their per-
|
|
1593
|
-
'runs:Inspect a monitor
|
|
1594
|
-
'list:List the monitors visible to you.'
|
|
1595
|
-
'get:Show a monitor'\''s configuration.'
|
|
1621
|
+
'jobs:Inspect a monitor'\''s jobs (also called executions) and their per-runner runs.'
|
|
1622
|
+
'runs:Inspect one run of a monitor job\: its requests, assertions and attempts.'
|
|
1623
|
+
'list:List the monitors visible to you, one page at a time.'
|
|
1624
|
+
'get:Show a monitor'\''s configuration and its last run.'
|
|
1596
1625
|
'metrics:Show per-request latency and outcome history for a monitor.'
|
|
1597
1626
|
'pause:Pause a monitor, so it stops firing on schedule.'
|
|
1598
1627
|
'resume:Resume a paused monitor, so it fires on schedule again.'
|
|
1628
|
+
'share:Grant a role on a monitor to one or more people.'
|
|
1599
1629
|
)
|
|
1600
1630
|
_describe -t commands 'monitor command' sub
|
|
1601
1631
|
}
|
|
@@ -1603,28 +1633,28 @@ _postman_monitor_commands() {
|
|
|
1603
1633
|
_postman_monitor_run() {
|
|
1604
1634
|
_arguments \
|
|
1605
1635
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1606
|
-
'(-x --suppress-exit-code)'{-x,--suppress-exit-code}'[
|
|
1607
|
-
'(-t --timeout)'{-t,--timeout}'[
|
|
1608
|
-
'--async[Submit the run and
|
|
1609
|
-
'--json[
|
|
1636
|
+
'(-x --suppress-exit-code)'{-x,--suppress-exit-code}'[Always exit 0, whatever the run'\''s result or the failure]' \
|
|
1637
|
+
'(-t --timeout)'{-t,--timeout}'[How long to wait for the run to finish, in milliseconds (default\: 900000)]:ms' \
|
|
1638
|
+
'--async[Submit the run and print its job id and Postman URL without waiting for it to finish]' \
|
|
1639
|
+
'--json[Print { state, monitorId, jobId, url, stats } as JSON, and nothing else]' \
|
|
1610
1640
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1611
1641
|
'*:monitorId:'
|
|
1612
1642
|
}
|
|
1613
1643
|
|
|
1614
1644
|
_postman_monitor_create() {
|
|
1615
1645
|
_arguments \
|
|
1616
|
-
'(-c --collection)'{-c,--collection}'[Collection to monitor
|
|
1646
|
+
'(-c --collection)'{-c,--collection}'[Collection to monitor\: its id or uid, from the Postman app or `postman collection list`]:id' \
|
|
1617
1647
|
'--name[Monitor name (defaults to the linked collection'\''s own name)]:name' \
|
|
1618
|
-
'(-e --environment)'{-e,--environment}'[Environment to run the
|
|
1619
|
-
'(-w --workspace)'{-w,--workspace}'[Workspace to create the monitor in (defaults to the workspace named in the local .postman/resources.yaml manifest; required if neither is available)]:id' \
|
|
1620
|
-
'--schedule[Cron expression for the monitor'\''s schedule]:cron' \
|
|
1648
|
+
'(-e --environment)'{-e,--environment}'[Environment to run the collection with\: its uid, from the Postman app or `postman environment list`]:id' \
|
|
1649
|
+
'(-w --workspace)'{-w,--workspace}'[Workspace to create the monitor in, from `postman workspace list` (defaults to the workspace named in the local .postman/resources.yaml manifest; required if neither is available)]:id' \
|
|
1650
|
+
'--schedule[Cron expression for the monitor'\''s schedule, five fields\: minute hour day-of-month month day-of-week, for example "0 9 * * MON". Leave month as * unless the monitor should run only in certain months; then write the month as a name (jan-dec)]:cron' \
|
|
1621
1651
|
'--timezone[Time zone for --schedule, for example America/New_York (defaults to the host machine'\''s own zone)]:tz' \
|
|
1622
1652
|
'--runner[A Postman region name (see `postman runner regions`) or the id of a self-hosted runner created in Postman (list existing ones with `postman runner list`) to run from (repeatable) (default\: \[\])]:value' \
|
|
1623
1653
|
'(-i --item)'{-i,--item}'[Id of a request or folder in the collection to run, in the order given (repeatable; ids only, not names or paths; defaults to every request; list ids with `postman collection get <collection-id> --json`) (default\: \[\])]:id' \
|
|
1624
1654
|
'--notify-email[Email to notify on a run failure or error (repeatable) (default\: \[\])]:email' \
|
|
1625
1655
|
'--notification-limit[Consecutive failure notifications to send before muting them]:n' \
|
|
1626
|
-
'--retry[Times to retry a failed run]:n' \
|
|
1627
|
-
'--timeout[
|
|
1656
|
+
'--retry[Times to retry a failed run\: --retry 2 allows up to 3 attempts]:n' \
|
|
1657
|
+
'--timeout[Per-request timeout the monitor applies when it runs, in milliseconds (this command does not wait for a run; `postman monitor run --timeout` sets how long that waits)]:ms' \
|
|
1628
1658
|
'--delay[Delay between requests in milliseconds]:ms' \
|
|
1629
1659
|
'--strict-ssl[Fail the run when the target'\''s TLS certificate cannot be verified]' \
|
|
1630
1660
|
'--insecure[Skip TLS certificate verification for the monitored target]' \
|
|
@@ -1636,25 +1666,25 @@ _postman_monitor_create() {
|
|
|
1636
1666
|
'--iteration-strategy[How iteration data is consumed, for example round_robin, repeat_last or stop_at_end (requires --iteration-count, --dataset-id and --dataset-view-id)]:strategy' \
|
|
1637
1667
|
'--no-run-now[Do not trigger an immediate run after creating the monitor]' \
|
|
1638
1668
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1639
|
-
'--json[
|
|
1669
|
+
'--json[Print the outcome, the created monitor'\''s id, uid, name and active state, and the job of its first run, as JSON]' \
|
|
1640
1670
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1641
1671
|
}
|
|
1642
1672
|
|
|
1643
1673
|
_postman_monitor_update() {
|
|
1644
1674
|
_arguments \
|
|
1645
1675
|
'--name[New monitor name]:name' \
|
|
1646
|
-
'--schedule[New cron expression for the monitor'\''s schedule]:cron' \
|
|
1676
|
+
'--schedule[New cron expression for the monitor'\''s schedule, five fields\: minute hour day-of-month month day-of-week, for example "0 9 * * MON". Leave month as * unless the monitor should run only in certain months; then write the month as a name (jan-dec)]:cron' \
|
|
1647
1677
|
'--timezone[Time zone for --schedule, for example America/New_York (defaults to the host machine'\''s own zone)]:tz' \
|
|
1648
1678
|
'--runner[A Postman region name (see `postman runner regions`) or the id of a self-hosted runner created in Postman (list existing ones with `postman runner list`) to run from (repeatable; replaces the current set) (default\: \[\])]:value' \
|
|
1649
1679
|
'(-i --item)'{-i,--item}'[Id of a request or folder in the collection to run, in the order given (repeatable; ids only, not names or paths; replaces the saved selection; list ids with `postman collection get <collection-id> --json`) (default\: \[\])]:id' \
|
|
1650
1680
|
'--clear-items[Remove the saved selection so the monitor runs every request in its collection]' \
|
|
1651
1681
|
'--notify-email[Email to notify on a run failure or error (repeatable; replaces the current list) (default\: \[\])]:email' \
|
|
1652
1682
|
'--clear-notifications[Remove every notification recipient]' \
|
|
1653
|
-
'(-e --environment)'{-e,--environment}'[Environment to run the
|
|
1683
|
+
'(-e --environment)'{-e,--environment}'[Environment to run the collection with, replacing the current one\: its uid, from `postman environment list`]:id' \
|
|
1654
1684
|
'--clear-environment[Run the monitored collection with no environment]' \
|
|
1655
1685
|
'--notification-limit[Consecutive failure notifications to send before muting them]:n' \
|
|
1656
|
-
'--retry[Times to retry a failed run]:n' \
|
|
1657
|
-
'--timeout[
|
|
1686
|
+
'--retry[Times to retry a failed run\: --retry 2 allows up to 3 attempts]:n' \
|
|
1687
|
+
'--timeout[Per-request timeout the monitor applies when it runs, in milliseconds (this command does not wait for a run; `postman monitor run --timeout` sets how long that waits)]:ms' \
|
|
1658
1688
|
'--delay[Delay between requests in milliseconds]:ms' \
|
|
1659
1689
|
'--strict-ssl[Fail the run when the target'\''s TLS certificate cannot be verified]' \
|
|
1660
1690
|
'--insecure[Skip TLS certificate verification for the monitored target]' \
|
|
@@ -1665,16 +1695,16 @@ _postman_monitor_update() {
|
|
|
1665
1695
|
'--iteration-count[Number of iterations to run]:n' \
|
|
1666
1696
|
'--iteration-strategy[How iteration data is consumed, for example round_robin, repeat_last or stop_at_end (requires --iteration-count, --dataset-id and --dataset-view-id)]:strategy' \
|
|
1667
1697
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1668
|
-
'--json[
|
|
1698
|
+
'--json[Print the outcome and the monitor'\''s id, uid, name and active state as JSON]' \
|
|
1669
1699
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1670
1700
|
'*:monitorId:'
|
|
1671
1701
|
}
|
|
1672
1702
|
|
|
1673
1703
|
_postman_monitor_delete() {
|
|
1674
1704
|
_arguments \
|
|
1675
|
-
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt]' \
|
|
1705
|
+
'(-y --yes)'{-y,--yes}'[Skip the confirmation prompt; required when there is no interactive terminal or with --silent]' \
|
|
1676
1706
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1677
|
-
'--json[
|
|
1707
|
+
'--json[Print the outcome (deleted or aborted) and the monitor id as JSON]' \
|
|
1678
1708
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1679
1709
|
'*:monitorId:'
|
|
1680
1710
|
}
|
|
@@ -1699,29 +1729,29 @@ _postman_monitor_jobs() {
|
|
|
1699
1729
|
_postman_monitor_jobs_commands() {
|
|
1700
1730
|
local -a sub
|
|
1701
1731
|
sub=(
|
|
1702
|
-
'list:List a monitor'\''s recent jobs.'
|
|
1703
|
-
'get:
|
|
1732
|
+
'list:List a monitor'\''s recent jobs, newest first. A job (also called an execution) is one firing of the monitor, with one run per runner.'
|
|
1733
|
+
'get:Show one job (also called an execution) and the state, runner and duration of each of its runs. A run'\''s duration covers every attempt, including retries.'
|
|
1704
1734
|
)
|
|
1705
1735
|
_describe -t commands 'jobs command' sub
|
|
1706
1736
|
}
|
|
1707
1737
|
|
|
1708
1738
|
_postman_monitor_jobs_list() {
|
|
1709
1739
|
_arguments \
|
|
1710
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1711
|
-
'--result[
|
|
1712
|
-
'--trigger[
|
|
1740
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1741
|
+
'--result[Only jobs that finished in this state\: success, failure, error or abort; any other value is rejected before any request]:state' \
|
|
1742
|
+
'--trigger[Only jobs started by this trigger\: api, schedule, webhook or postman-cli; any other value is rejected before any request]:value' \
|
|
1713
1743
|
'--since[Only jobs that finished at or after this ISO 8601 date-time]:dateTime' \
|
|
1714
|
-
'--limit[
|
|
1715
|
-
'--cursor[
|
|
1716
|
-
'--json[
|
|
1744
|
+
'--limit[Jobs per page, 1-25 (default\: 25)]:n' \
|
|
1745
|
+
'--cursor[Page number to read, from the "Next page" line or `nextCursor` under --json of a previous listing; pass the same --limit and filters]:page' \
|
|
1746
|
+
'--json[Print { monitorId, jobs, nextCursor } as JSON, each job with its runs]' \
|
|
1717
1747
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1718
1748
|
'*:monitorId:'
|
|
1719
1749
|
}
|
|
1720
1750
|
|
|
1721
1751
|
_postman_monitor_jobs_get() {
|
|
1722
1752
|
_arguments \
|
|
1723
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1724
|
-
'--json[
|
|
1753
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1754
|
+
'--json[Print the job as JSON, with each run'\''s state, runner, counts, duration and attempts]' \
|
|
1725
1755
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1726
1756
|
'*:jobId:'
|
|
1727
1757
|
}
|
|
@@ -1745,17 +1775,17 @@ _postman_monitor_runs() {
|
|
|
1745
1775
|
_postman_monitor_runs_commands() {
|
|
1746
1776
|
local -a sub
|
|
1747
1777
|
sub=(
|
|
1748
|
-
'get:
|
|
1778
|
+
'get:Show one attempt of a run\: each request with its response or error, and its assertions, console lines and exceptions. A retried run has several attempts, numbered from 0; the latest is shown unless --attempt names another. Console, assertion and exception messages are the collection'\''s own output, printed as the run recorded them.'
|
|
1749
1779
|
)
|
|
1750
1780
|
_describe -t commands 'runs command' sub
|
|
1751
1781
|
}
|
|
1752
1782
|
|
|
1753
1783
|
_postman_monitor_runs_get() {
|
|
1754
1784
|
_arguments \
|
|
1755
|
-
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1756
|
-
'--attempt[Which attempt
|
|
1757
|
-
'--failed-only[Show only failed
|
|
1758
|
-
'--json[
|
|
1785
|
+
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1786
|
+
'--attempt[Which attempt to show, from 0 for the first (default\: the latest)]:n' \
|
|
1787
|
+
'--failed-only[Show only requests with a failed assertion, an exception or a network error]' \
|
|
1788
|
+
'--json[Print the run as JSON\: its state, attempt, assertion counts and every request with its entries]' \
|
|
1759
1789
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1760
1790
|
'*:runId:'
|
|
1761
1791
|
}
|
|
@@ -1763,27 +1793,26 @@ _postman_monitor_runs_get() {
|
|
|
1763
1793
|
_postman_monitor_list() {
|
|
1764
1794
|
_arguments \
|
|
1765
1795
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1766
|
-
'(-w --workspace)'{-w,--workspace}'[
|
|
1767
|
-
'(-c --collection)'{-c,--collection}'[
|
|
1768
|
-
'(-e --environment)'{-e,--environment}'[
|
|
1769
|
-
'--runner[
|
|
1770
|
-
'--owner[
|
|
1771
|
-
'--
|
|
1772
|
-
'--
|
|
1773
|
-
'--
|
|
1774
|
-
'--
|
|
1775
|
-
'--
|
|
1776
|
-
'--
|
|
1777
|
-
'(-f --filter)'{-f,--filter}'[Show only monitors whose name contains this text (applies to the returned page, case-insensitive)]:text' \
|
|
1796
|
+
'(-w --workspace)'{-w,--workspace}'[Only monitors in this workspace (ids from `postman workspace list`)]:id' \
|
|
1797
|
+
'(-c --collection)'{-c,--collection}'[Only monitors on this collection\: its id or uid]:id' \
|
|
1798
|
+
'(-e --environment)'{-e,--environment}'[Only monitors on this environment\: its uid]:id' \
|
|
1799
|
+
'--runner[Only monitors on this self-hosted runner id, from `postman runner list` (not a Postman region). Cannot be combined with --workspace, --collection, --environment, --owner or --active]:id' \
|
|
1800
|
+
'--owner[Only monitors created by this user id\: the `owner` field under --json]:id' \
|
|
1801
|
+
'--active[Only active (true) or paused (false) monitors]:true|false' \
|
|
1802
|
+
'--limit[Monitors per page, 1-25]:n' \
|
|
1803
|
+
'--cursor[Page to read\: the cursor from the "Next page" line of a previous listing, or `nextCursor` under --json; pass the same filters and --limit]:token' \
|
|
1804
|
+
'--columns[Comma-separated columns to show. Defaults to Name, ID, State, Health, Schedule, Owner, Collection, dropping Collection, Owner, Schedule in that order when the table is wider than the terminal. Also available\: Environment, Runners, Notifications]:names' \
|
|
1805
|
+
'--no-headers[Omit the header row and its rule]' \
|
|
1806
|
+
'(-f --filter)'{-f,--filter}'[Only monitors whose name contains this text, case-insensitive (applies to the returned page)]:text' \
|
|
1778
1807
|
'--sort[Sort the returned page by "name" or "active"]:field' \
|
|
1779
|
-
'--json[
|
|
1808
|
+
'--json[Print { monitors, nextCursor } as JSON, every monitor field except lastRun present (null when unset); monitor get carries lastRun]' \
|
|
1780
1809
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1781
1810
|
}
|
|
1782
1811
|
|
|
1783
1812
|
_postman_monitor_get() {
|
|
1784
1813
|
_arguments \
|
|
1785
1814
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1786
|
-
'--json[
|
|
1815
|
+
'--json[Print the monitor as JSON, every field present (null when unset)]' \
|
|
1787
1816
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1788
1817
|
'*:monitorId:'
|
|
1789
1818
|
}
|
|
@@ -1794,8 +1823,8 @@ _postman_monitor_metrics() {
|
|
|
1794
1823
|
'--since[Only executions at or after this ISO 8601 date-time (defaults to 7 days ago)]:dateTime' \
|
|
1795
1824
|
'--until[Only executions at or before this ISO 8601 date-time (defaults to now)]:dateTime' \
|
|
1796
1825
|
'(-f --filter)'{-f,--filter}'[Show only requests whose name contains this text (case-insensitive)]:text' \
|
|
1797
|
-
'--limit[
|
|
1798
|
-
'--json[
|
|
1826
|
+
'--limit[Rows to show, any positive whole number\: the worst-behaving requests in the table, or the newest executions under --json. Applied after the results are fetched]:n' \
|
|
1827
|
+
'--json[Print { monitorId, window, metricsAvailable, executions } as JSON, one entry per request per job per runner]' \
|
|
1799
1828
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1800
1829
|
'*:monitorId:'
|
|
1801
1830
|
}
|
|
@@ -1803,7 +1832,7 @@ _postman_monitor_metrics() {
|
|
|
1803
1832
|
_postman_monitor_pause() {
|
|
1804
1833
|
_arguments \
|
|
1805
1834
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1806
|
-
'--json[
|
|
1835
|
+
'--json[Print the outcome and the monitor'\''s id, uid, name and active state as JSON]' \
|
|
1807
1836
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1808
1837
|
'*:monitorId:'
|
|
1809
1838
|
}
|
|
@@ -1811,7 +1840,18 @@ _postman_monitor_pause() {
|
|
|
1811
1840
|
_postman_monitor_resume() {
|
|
1812
1841
|
_arguments \
|
|
1813
1842
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session, then a guest session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1814
|
-
'--json[
|
|
1843
|
+
'--json[Print the outcome and the monitor'\''s id, uid, name and active state as JSON]' \
|
|
1844
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1845
|
+
'*:monitorId:'
|
|
1846
|
+
}
|
|
1847
|
+
|
|
1848
|
+
_postman_monitor_share() {
|
|
1849
|
+
_arguments \
|
|
1850
|
+
'--user[Who to share with. Repeatable, and each value may be a comma-separated list. A value containing @ is treated as an email address, anything else as a Postman user id.]:email|id' \
|
|
1851
|
+
'--role[The role to grant. (default\: "viewer")]:viewer|editor' \
|
|
1852
|
+
'--json[Print the outcome as machine-readable JSON.]' \
|
|
1853
|
+
'--timeout[Milliseconds to wait for Postman. Defaults to 30000.]:ms' \
|
|
1854
|
+
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1815
1855
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
1816
1856
|
'*:monitorId:'
|
|
1817
1857
|
}
|
|
@@ -1908,7 +1948,7 @@ _postman_runner_start() {
|
|
|
1908
1948
|
_arguments \
|
|
1909
1949
|
'--id[The ID of the runner to execute]:id' \
|
|
1910
1950
|
'--key[The secret key for the runner]:key:_files -g "*.(pem|crt|key)"' \
|
|
1911
|
-
'--region[
|
|
1951
|
+
'--region[Data residency of the Postman account the runner belongs to\: "us" (default) or "eu". This is not a monitor runner region]:region' \
|
|
1912
1952
|
'--proxy[External proxy URL, for example http\://proxy.com or http\://proxy.com\:8080]:url' \
|
|
1913
1953
|
'--egress-proxy[Enable built-in egress proxy]' \
|
|
1914
1954
|
'--egress-proxy-authz-url[Custom egress proxy authorization service base URL]:url' \
|
|
@@ -1924,15 +1964,15 @@ _postman_runner_start() {
|
|
|
1924
1964
|
_postman_runner_list() {
|
|
1925
1965
|
_arguments \
|
|
1926
1966
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1927
|
-
'(-w --workspace)'{-w,--workspace}'[
|
|
1928
|
-
'--json[
|
|
1967
|
+
'(-w --workspace)'{-w,--workspace}'[Only runners this workspace can use\: runners scoped to it and runners shared with the whole team]:id' \
|
|
1968
|
+
'--json[Print { runners } as JSON, every field present (null when unset)]' \
|
|
1929
1969
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1930
1970
|
}
|
|
1931
1971
|
|
|
1932
1972
|
_postman_runner_regions() {
|
|
1933
1973
|
_arguments \
|
|
1934
1974
|
'--api-key[Postman API key (defaults to POSTMAN_API_KEY, then the `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
1935
|
-
'--json[
|
|
1975
|
+
'--json[Print { regions } as JSON, every field present (null when unset)]' \
|
|
1936
1976
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
1937
1977
|
}
|
|
1938
1978
|
|
|
@@ -2261,7 +2301,7 @@ _postman_spec_generate() {
|
|
|
2261
2301
|
_postman_spec_generate_commands() {
|
|
2262
2302
|
local -a sub
|
|
2263
2303
|
sub=(
|
|
2264
|
-
'collection:Generate a Postman collection from
|
|
2304
|
+
'collection:Generate a Postman collection from an OpenAPI or AsyncAPI (Kafka) specification. Only Kafka AsyncAPI 2.x and 3.0 specs are supported\: the spec must declare a kafka or kafka-secure server.'
|
|
2265
2305
|
)
|
|
2266
2306
|
_describe -t commands 'generate command' sub
|
|
2267
2307
|
}
|
|
@@ -2269,7 +2309,7 @@ _postman_spec_generate_commands() {
|
|
|
2269
2309
|
_postman_spec_generate_collection() {
|
|
2270
2310
|
_arguments \
|
|
2271
2311
|
'(-n --name)'{-n,--name}'[Collection name]:name' \
|
|
2272
|
-
'--folder-strategy[Folder strategy\: Paths or Tags (default\: Paths) (default\: "Paths")]:strategy' \
|
|
2312
|
+
'--folder-strategy[Folder strategy\: Paths or Tags (default\: Paths). OpenAPI only (default\: "Paths")]:strategy' \
|
|
2273
2313
|
'(-w --workspace)'{-w,--workspace}'[Workspace ID (cloud mode)]:id' \
|
|
2274
2314
|
'--api-key[Postman API key]:key:_files -g "*.(pem|crt|key)"' \
|
|
2275
2315
|
'--force[Overwrite the collection if one with this name already exists (local mode)]' \
|
|
@@ -2305,8 +2345,8 @@ _postman_spec_sync_collection() {
|
|
|
2305
2345
|
_arguments \
|
|
2306
2346
|
'--collection-id[Collection ID to sync (required for cloud mode)]:id' \
|
|
2307
2347
|
'--api-key[Postman API key]:key:_files -g "*.(pem|crt|key)"' \
|
|
2308
|
-
'--force[Overwrite hand-written scripts, headers and descriptions that the spec would otherwise drop]' \
|
|
2309
|
-
'--dry-run[Report what sync would change and remove without writing anything]' \
|
|
2348
|
+
'--force[Overwrite hand-written scripts, headers and descriptions that the spec would otherwise drop (OpenAPI), or collection files that could not be read (AsyncAPI)]' \
|
|
2349
|
+
'--dry-run[Report what sync would change and remove without writing anything (OpenAPI only)]' \
|
|
2310
2350
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
2311
2351
|
'*:spec:'
|
|
2312
2352
|
}
|
|
@@ -2337,6 +2377,7 @@ _postman_workspace() {
|
|
|
2337
2377
|
activity) _postman_workspace_activity ;;
|
|
2338
2378
|
create) _postman_workspace_create ;;
|
|
2339
2379
|
delete) _postman_workspace_delete ;;
|
|
2380
|
+
share) _postman_workspace_share ;;
|
|
2340
2381
|
pull) _postman_workspace_pull ;;
|
|
2341
2382
|
connect-git) _postman_workspace_connect_git ;;
|
|
2342
2383
|
disconnect-git) _postman_workspace_disconnect_git ;;
|
|
@@ -2357,7 +2398,8 @@ _postman_workspace_commands() {
|
|
|
2357
2398
|
'activity:Read a workspace'\''s activity feed.'
|
|
2358
2399
|
'create:Create a Postman workspace and bind it to this git repository.'
|
|
2359
2400
|
'delete:Permanently delete a workspace and everything in it. Prompts for confirmation unless --yes is passed.'
|
|
2360
|
-
'
|
|
2401
|
+
'share:Grant a role on a workspace to one or more people.'
|
|
2402
|
+
'pull:Pull workspace entities from a Postman workspace into the local folder.'
|
|
2361
2403
|
'connect-git:Connect a Postman workspace to a local git repository.'
|
|
2362
2404
|
'disconnect-git:Disconnect a Postman workspace from its local git repository.'
|
|
2363
2405
|
'diff:Preview local-vs-cloud drift before pushing. Read-only\: nothing is created, updated or deleted.'
|
|
@@ -2451,6 +2493,17 @@ _postman_workspace_delete() {
|
|
|
2451
2493
|
'*:workspaceId:'
|
|
2452
2494
|
}
|
|
2453
2495
|
|
|
2496
|
+
_postman_workspace_share() {
|
|
2497
|
+
_arguments \
|
|
2498
|
+
'--user[Who to share with. Repeatable, and each value may be a comma-separated list. A value containing @ is treated as an email address, anything else as a Postman user id.]:email|id' \
|
|
2499
|
+
'--role[The role to grant. (default\: "viewer")]:viewer|editor' \
|
|
2500
|
+
'--json[Print the outcome as machine-readable JSON.]' \
|
|
2501
|
+
'--timeout[Milliseconds to wait for Postman. Defaults to 30000.]:ms' \
|
|
2502
|
+
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
2503
|
+
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
2504
|
+
'*:workspaceId:'
|
|
2505
|
+
}
|
|
2506
|
+
|
|
2454
2507
|
_postman_workspace_pull() {
|
|
2455
2508
|
_arguments \
|
|
2456
2509
|
'(-y --yes)'{-y,--yes}'[Skip all confirmation prompts]' \
|
|
@@ -2834,7 +2887,6 @@ _postman_init() {
|
|
|
2834
2887
|
_arguments \
|
|
2835
2888
|
'--json[Emit machine-readable output for agents]' \
|
|
2836
2889
|
'--dry-run[Report what would happen without writing anything]' \
|
|
2837
|
-
'--no-fetch[Use the skills bundled with this CLI instead of fetching the latest]' \
|
|
2838
2890
|
'--spec[Which spec is authoritative, when more than one could be]:path:_files -g "*.(yaml|yml|json)"' \
|
|
2839
2891
|
'--visibility[Create and bind a workspace non-interactively (personal, team)]:status' \
|
|
2840
2892
|
'(-y --yes)'{-y,--yes}'[Accept the default for every question instead of asking or stopping]' \
|
|
@@ -3344,7 +3396,7 @@ _postman_simulation_create() {
|
|
|
3344
3396
|
'--deploy[After creating, upload the simulation (and its mocks) to Postman cloud and deploy it to a live mock server (private by default).]' \
|
|
3345
3397
|
'--public[With --deploy, let anyone with the link reach the server (default\: callers need an API key)]' \
|
|
3346
3398
|
'(-s --slug)'{-s,--slug}'[With --deploy, the short label used in the server'\''s web address]:slug' \
|
|
3347
|
-
'--json[
|
|
3399
|
+
'--json[Print the result (with --deploy, the live server details) as machine-readable data instead of a summary]' \
|
|
3348
3400
|
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
3349
3401
|
'(-h --help)'{-h,--help}'[display help for command]'
|
|
3350
3402
|
}
|
|
@@ -3361,7 +3413,7 @@ _postman_simulation_list() {
|
|
|
3361
3413
|
_postman_simulation_get() {
|
|
3362
3414
|
_arguments \
|
|
3363
3415
|
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
3364
|
-
'--json[Print the details as machine-readable data instead of a
|
|
3416
|
+
'--json[Print the details as machine-readable data instead of a summary]' \
|
|
3365
3417
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
3366
3418
|
'*:simIdOrPath:'
|
|
3367
3419
|
}
|
|
@@ -3393,6 +3445,7 @@ _postman_simulation_push() {
|
|
|
3393
3445
|
_arguments \
|
|
3394
3446
|
'(-w --workspace)'{-w,--workspace}'[Postman cloud workspace to upload to, by id (defaults to the workspace already linked to this project)]:id' \
|
|
3395
3447
|
'--api-key[Postman API key (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
3448
|
+
'--json[Print the result as machine-readable data]' \
|
|
3396
3449
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
3397
3450
|
'*:simPath:'
|
|
3398
3451
|
}
|
|
@@ -3442,6 +3495,7 @@ _postman_simulation_delete() {
|
|
|
3442
3495
|
_arguments \
|
|
3443
3496
|
'(-y --yes)'{-y,--yes}'[Delete without asking for confirmation first]' \
|
|
3444
3497
|
'--api-key[Postman API key, used with a Postman cloud id (defaults to your `postman login` session)]:key:_files -g "*.(pem|crt|key)"' \
|
|
3498
|
+
'--json[Print the result as machine-readable data (requires --yes)]' \
|
|
3445
3499
|
'(-h --help)'{-h,--help}'[display help for command]' \
|
|
3446
3500
|
'*:simIdOrPath:'
|
|
3447
3501
|
}
|