redocly-cli
redocly-cli copied to clipboard
Allow Respect users to configure RESPECT_TIMEOUT and RESPECT_MAX_STEPS with CLI command options
Is your feature request related to a problem? Please describe.
Respect has two configurable execution limitation variables, that can't be changed with the respect command options:
export const DEFAULT_RESPECT_TIMEOUT = 3_600_000; // 1 hour in milliseconds
export const DEFAULT_RESPECT_MAX_STEPS = 2_000;
They are particularly useful in limiting CI execution to prevent internal loops, that can be result of incorrect Arazzo description.
Describe the solution you'd like
- Add
RESPECT_TIMEOUTandRESPECT_MAX_STEPSoptions for therespectcli command. Make sure that default values are applied when not option is provided. - Update code usage with common command prefix.
- Update env vars in
Respect Monitoring, it will be breaking change for it.
Describe alternatives you've considered
Do nothing.
Additional context
Rename these variables to be consistent with Redocly CLI env vars (they start with REDOCLY_CLI_...)
Tangentially related: https://github.com/Redocly/redocly-cli/issues/1796.