Skip to content

Commit d9ef07c

Browse files
authored
Fix configuration.md ConfigValue references
Removes the documentation for a non-existent ConfigValue dataclass and replaces it with accurate documentation for the real third dataclass, ServerVersion (fields: version, commit). Clarifies that get_all() returns dict[str, str] rather than a dataclass. Closes #134
1 parent 144a103 commit d9ef07c

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

sdk/docs/configuration.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -204,21 +204,20 @@ All exceptions inherit from `DecreeError`:
204204

205205
## Return types
206206

207-
All return types are frozen dataclasses:
207+
`get_all()` returns a plain `dict[str, str]` mapping field paths to their string
208+
values — not a dataclass. The other typed return values are frozen dataclasses:
208209

209210
```python
210-
@dataclass(frozen=True, slots=True)
211-
class ConfigValue:
212-
field_path: str
213-
value: str
214-
checksum: str
215-
description: str
216-
217211
@dataclass(frozen=True, slots=True)
218212
class Change:
219213
field_path: str
220214
old_value: str | None
221215
new_value: str | None
222216
version: int
223217
changed_by: str
218+
219+
@dataclass(frozen=True, slots=True)
220+
class ServerVersion:
221+
version: str
222+
commit: str
224223
```

0 commit comments

Comments
 (0)