generate-integration-docs-screenshot: Group options by integration type.

Group argparse arguments into common and webhook-specific options.

The common group contains arguments that apply to both webhook and
non-webhook integrations. It is not assigned a description.

A fixtureless, non-webhook group will be added later, when its arguments
are created.
This commit is contained in:
Niloth P
2025-05-27 10:12:33 +05:30
committed by Tim Abbott
parent 3cb34ef03d
commit 2b358db46b

View File

@@ -270,24 +270,27 @@ batch_group.add_argument(
)
batch_group.add_argument("--integration", nargs="+", help="Names of specific integrations")
parser.add_argument(
common_group = parser.add_argument_group()
common_group.add_argument("--image-name", help="Name for the screenshot image")
common_group.add_argument("--image-dir", help="Directory name where to save the screenshot image")
common_group.add_argument("--bot-name", help="Name to use for the bot")
webhook_group = parser.add_argument_group("Webhook integrations options")
webhook_group.add_argument(
"--fixture-name",
help="Name of the fixture file to use. All other webhook options are ignored if the fixture is not specified.",
)
parser.add_argument("--image-name", help="Name for the screenshot image")
parser.add_argument("--image-dir", help="Directory name where to save the screenshot image")
parser.add_argument("--bot-name", help="Name to use for the bot")
parser.add_argument(
webhook_group.add_argument(
"-A", "--use-basic-auth", action="store_true", help="Add basic auth headers to the request"
)
parser.add_argument(
webhook_group.add_argument(
"-Q",
"--payload-as-query-param",
action="store_true",
help="Send payload as query param instead of body",
)
parser.add_argument("-P", "--payload-param-name", help="Param name to use for the payload")
parser.add_argument(
webhook_group.add_argument("-P", "--payload-param-name", help="Param name to use for the payload")
webhook_group.add_argument(
"-H",
"--custom-headers",
type=custom_headers,