Skip to content

Commit

Permalink
docs(provider): add retries and timeout config options
Browse files Browse the repository at this point in the history
Add documentation for two new provider configuration options:
- `retries` for specifying number of API retry attempts
- `timeout_seconds` for setting request timeout duration
  • Loading branch information
tdabasinskas committed Nov 20, 2024
1 parent b7afaef commit 3b4d5c6
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,5 @@ provider "backstage" {
- `base_url` (String) Base URL of the Backstage instance, e.g. https://demo.backstage.io. May also be provided via `BACKSTAGE_BASE_URL` environment variable.
- `default_namespace` (String) Name of default namespace for entities (`default`, if not set). May also be provided via `BACKSTAGE_DEFAULT_NAMESPACE` environment variable.
- `headers` (Map of String) Headers to be sent with each request to the Backstage API. Useful for authentication. May also be provided via `BACKSTAGE_HEADERS` environment variable.
- `retries` (Number) Number of retries to attempt on recoverable API errors (default: 0). May also be provided via `BACKSTAGE_RETRIES` environment variable.
- `timeout_seconds` (Number) Timeout for requests to the Backstage API in seconds (default: 15). May also be provided via `BACKSTAGE_TIMEOUT_SECONDS` environment variable.

0 comments on commit 3b4d5c6

Please sign in to comment.