% skyramp generate load rest -h
Generate load tests for REST protocol

Usage:
skyramp generate load rest <endpoint_url> -X <rest-method> --request-data <sample-request> [flags]
skyramp generate load rest <endpoint_url> -X <rest-method> --api-schema <path-to-spec> [flags]
skyramp generate load rest <endpoint_url> -X POST --form-params <form-params> [flags]
skyramp generate load rest --help

Arguments:
endpoint_url                       Test is created for this endpoint url

Examples:
skyramp generate load rest https://skyramp.dev/api/products -X POST --language python --request-data @request.json
skyramp generate load rest https://skyramp.dev/api/products -X POST --language python --api-schema ./openapi_spec.json

Input Flags:
       --api-schema                     Path to OpenAPI specification 
  -X,  --method                         REST method to be tested      
       --request-data                   Sample request data as JSON/YAML blob or @path to a file

Param Flags:
       --auth-header                    Authorization header type     
       --form-params                    Form parameters for POST methods
       --path-params                    Comma-separated list of path parameters
       --query-params                   Comma-separated list of query parameters

Load Config Flags:
       --default-load-count             Number of times to execute the load test
       --default-load-duration          Duration of load test (s)     
       --default-load-num-threads       Number of concurrent threads for load test
       --default-load-rampup-duration   Load rampup duration (s)      
       --default-load-rampup-interval   Load rampup interval (s)      
       --default-load-target-rps        Target RPS for load test      

Output Flags:
       --deploy-dashboard               Deploy the Skyramp dashboard for test result collection
       --framework                      Testing framework for generated test [junit, playwright, pytest, robot]
       --language                       Language for generated test [java, javascript, python, typescript]
       --output                         Generated test name           
       --output-dir                     Location to write generated tests
       --overwrite                      Overwrite existing tests without additional confirmation

Runtime Flags:
       --docker-network                 Docker network for skyramp worker
       --docker-skyramp-port            Docker port for skyramp worker
  -k,  --insecure                       Skip ssl server verification