mirror/nanobot
1
0
Fork 0
mirror of https://github.com/HKUDS/nanobot.git synced 2026-04-24 11:55:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: use model_dump(by_alias=True) for default_config in plugin guide

Browse Source
This commit is contained in:
invictus 2026-04-07 00:14:24 +08:00 committed by Xubin Ren
parent 83ad013be5
commit 4648cb9e87
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/CHANNEL_PLUGIN_GUIDE.md
View File

@ -69,7 +69,7 @@ class WebhookChannel(BaseChannel):
@classmethod @classmethod
def default_config(cls) -> dict[str, Any]: def default_config(cls) -> dict[str, Any]:
return {"enabled": False, "port": 9000, "allowFrom": []} return WebhookConfig().model_dump(by_alias=True)
async def start(self) -> None: async def start(self) -> None:
"""Start an HTTP server that listens for incoming messages. """Start an HTTP server that listens for incoming messages.
@ -401,10 +401,10 @@ Override `default_config()` so `nanobot onboard` auto-populates `config.json`:
```python ```python
@classmethod @classmethod
def default_config(cls) -> dict[str, Any]: def default_config(cls) -> dict[str, Any]:
return {"enabled": False, "port": 9000, "allowFrom": []} return WebhookConfig().model_dump(by_alias=True)
``` ```
> **Note:** `default_config()` still returns a plain `dict` (not a Pydantic model) because it's used to serialize into `config.json`. Use camelCase keys (`allowFrom`) to match the JSON convention. > **Note:** `default_config()` returns a plain `dict` (not a Pydantic model) because it's used to serialize into `config.json`. The recommended way is to instantiate your config model and call `model_dump(by_alias=True)` — this automatically uses camelCase keys (`allowFrom`) and keeps defaults in a single source of truth.
If not overridden, the base class returns `{"enabled": false}`. If not overridden, the base class returns `{"enabled": false}`.