astelm/telemt
1
0
Fork 0
mirror of https://github.com/telemt/telemt.git synced 2026-04-15 17:44:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): update descriptions for outage mode parameters in API documentation

Browse Source
This commit is contained in:
miniusercoder
2026-04-06 21:38:19 +03:00
parent 2b8159a65e
commit 19f9eb36ac
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/API.md
View File

@@ -919,7 +919,7 @@ Note: the request contract is defined, but the corresponding route currently ret
| `me_bind_stale_ttl_secs` | `u64` | Stale writer TTL. | | `me_bind_stale_ttl_secs` | `u64` | Stale writer TTL. |
| `me_single_endpoint_shadow_writers` | `u8` | Shadow writers for single-endpoint DCs. | | `me_single_endpoint_shadow_writers` | `u8` | Shadow writers for single-endpoint DCs. |
| `me_single_endpoint_outage_mode_enabled` | `bool` | Outage mode toggle for single-endpoint DCs. | | `me_single_endpoint_outage_mode_enabled` | `bool` | Outage mode toggle for single-endpoint DCs. |
| `me_single_endpoint_outage_disable_quarantine` | `bool` | Quarantine behavior in outage mode. | | `me_single_endpoint_outage_disable_quarantine` | `bool` | Allows reconnect attempts to bypass endpoint quarantine for single-endpoint outage recovery paths. |
| `me_single_endpoint_outage_backoff_min_ms` | `u64` | Outage mode min reconnect backoff. | | `me_single_endpoint_outage_backoff_min_ms` | `u64` | Outage mode min reconnect backoff. |
| `me_single_endpoint_outage_backoff_max_ms` | `u64` | Outage mode max reconnect backoff. | | `me_single_endpoint_outage_backoff_max_ms` | `u64` | Outage mode max reconnect backoff. |
| `me_single_endpoint_shadow_rotate_every_secs` | `u64` | Shadow rotation interval. | | `me_single_endpoint_shadow_rotate_every_secs` | `u64` | Shadow rotation interval. |

6
docs/CONFIG_PARAMS.en.md
View File

@@ -738,7 +738,7 @@ This document lists all configuration keys accepted by `config.toml`.
<a id="cfg-general-me_single_endpoint_outage_disable_quarantine"></a> <a id="cfg-general-me_single_endpoint_outage_disable_quarantine"></a>
- `me_single_endpoint_outage_disable_quarantine` - `me_single_endpoint_outage_disable_quarantine`
- **Constraints / validation**: `bool`. - **Constraints / validation**: `bool`.
- **Description**: Ignores endpoint quarantine while in single-endpoint outage mode. - **Description**: Allows single-endpoint outage recovery reconnect paths to bypass endpoint quarantine.
- **Example**: - **Example**:
```toml ```toml
@@ -788,7 +788,7 @@ This document lists all configuration keys accepted by `config.toml`.
<a id="cfg-general-me_adaptive_floor_idle_secs"></a> <a id="cfg-general-me_adaptive_floor_idle_secs"></a>
- `me_adaptive_floor_idle_secs` - `me_adaptive_floor_idle_secs`
- **Constraints / validation**: `u64` (seconds). - **Constraints / validation**: `u64` (seconds).
- **Description**: Idle time before adaptive floor may reduce the single-endpoint writer target. - **Description**: Reserved adaptive-floor timing knob exposed in runtime config and API snapshots for compatibility.
- **Example**: - **Example**:
```toml ```toml
@@ -818,7 +818,7 @@ This document lists all configuration keys accepted by `config.toml`.
<a id="cfg-general-me_adaptive_floor_recover_grace_secs"></a> <a id="cfg-general-me_adaptive_floor_recover_grace_secs"></a>
- `me_adaptive_floor_recover_grace_secs` - `me_adaptive_floor_recover_grace_secs`
- **Constraints / validation**: `u64` (seconds). - **Constraints / validation**: `u64` (seconds).
- **Description**: Grace period to hold static floor after activity in adaptive mode. - **Description**: Reserved adaptive-floor grace knob exposed in runtime config and API snapshots for compatibility.
- **Example**: - **Example**:
```toml ```toml