Skip to content

Commit a495f59

Browse files
committed
Update documentation and dependencies for API changes and model enhancements
- Added new API changes documentation to mkdocs.yml for better navigation. - Updated various model parameters in the documentation to reflect recent changes, including RetryPolicyModel and StoreConfigModel. - Incremented versions for several dependencies in uv.lock to ensure compatibility and access to the latest features. - Enhanced state-manager-setup documentation for clarity in environment variable configuration. - Improved formatting in create-graph and api-changes documentation for better readability.
1 parent 0c1e9f1 commit a495f59

5 files changed

Lines changed: 84 additions & 120 deletions

File tree

docs/docs/exosphere/api-changes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ retry_policy = RetryPolicyModel(
7575
### Available Models
7676

7777
#### GraphNodeModel
78+
7879
- **node_name** (str): Class name of the node
7980
- **namespace** (str): Namespace where node is registered
8081
- **identifier** (str): Unique identifier in the graph
@@ -83,13 +84,15 @@ retry_policy = RetryPolicyModel(
8384
- **unites** (Optional[UnitesModel]): Unite configuration for parallel execution
8485

8586
#### RetryPolicyModel (Beta)
87+
8688
- **max_retries** (int): Maximum number of retry attempts (default: 3)
8789
- **strategy** (RetryStrategyEnum): Retry strategy using enum values (default: EXPONENTIAL)
8890
- **backoff_factor** (int): Base delay in milliseconds (default: 2000)
8991
- **exponent** (int): Exponential multiplier (default: 2)
9092
- **max_delay** (int | None): Maximum delay cap in milliseconds (optional)
9193

9294
#### StoreConfigModel (Beta)
95+
9396
- **required_keys** (list[str]): Keys that must be present in the store
9497
- **default_values** (dict[str, str]): Default values for store keys
9598

docs/docs/exosphere/create-graph.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,7 @@ retry_policy = RetryPolicyModel(
284284
```
285285

286286
**Available Retry Strategies:**
287+
287288
- `RetryStrategyEnum.EXPONENTIAL`
288289
- `RetryStrategyEnum.EXPONENTIAL_FULL_JITTER`
289290
- `RetryStrategyEnum.EXPONENTIAL_EQUAL_JITTER`

docs/docs/exosphere/state-manager-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ The state manager uri and key would be configured accordingly while setting up n
146146
image: ghcr.io/exospherehost/exosphere-state-manager:latest
147147
ports:
148148
- "8000:8000"
149-
environment:
149+
environment:
150150
- MONGO_URI=${MONGO_URI}
151151
- MONGO_DATABASE_NAME=${MONGO_DATABASE_NAME}
152152
- STATE_MANAGER_SECRET=${STATE_MANAGER_SECRET}

docs/mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ plugins:
108108
Introduction:
109109
- index.md
110110
- getting-started.md
111+
- exosphere/api-changes.md
111112
- exosphere/local-setup.md
112113
- docker-compose-setup.md
113114
- exosphere/state-manager-setup.md
@@ -149,6 +150,7 @@ nav:
149150
- Register Node: exosphere/register-node.md
150151
- Create Runtime: exosphere/create-runtime.md
151152
- Create Graph: exosphere/create-graph.md
153+
- API Changes: exosphere/api-changes.md
152154
- Retry Policy: exosphere/retry-policy.md
153155
- Trigger Graph: exosphere/trigger-graph.md
154156
- Dashboard: exosphere/dashboard.md

0 commit comments

Comments
 (0)