logos-messaging/specs
1
0
Fork 0
mirror of https://github.com/logos-messaging/specs.git synced 2026-01-07 00:23:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

user snake case for field names

Browse Source
This commit is contained in:
fryorcraken 2025-08-05 15:28:46 +10:00
parent 1e312bc2c3
commit 6a37950c66
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
standards/application/waku-api.md
View File

@ -103,7 +103,7 @@ types:
mode: mode:
type: string type: string
# For now, a mode **must** be passed by the developer # For now, a mode **must** be passed by the developer
constraints: ["edge", "relay"] constraints: [ "edge", "relay" ]
description: "The mode of operation of the Waku node. Core protocols used by the node are inferred from this mode." description: "The mode of operation of the Waku node. Core protocols used by the node are inferred from this mode."
network_config: network_config:
type: NetworkConfig type: NetworkConfig
@ -125,12 +125,12 @@ types:
description: "Bootstrap nodes, entree and multiaddr formats are accepted." description: "Bootstrap nodes, entree and multiaddr formats are accepted."
static_store_nodes: static_store_nodes:
type: array<string> type: array<string>
default: [] default: [ ]
description: "Only the passed nodes are used for store queries, discovered store nodes are discarded." description: "Only the passed nodes are used for store queries, discovered store nodes are discarded."
cluster_id: cluster_id:
type: uint type: uint
sharding_mode: sharding_mode:
constraints: ["auto", "static"] constraints: [ "auto", "static" ]
# The default network config is TheWakuNetwork, but if a dev override it, then we still provide a sharding default # The default network config is TheWakuNetwork, but if a dev override it, then we still provide a sharding default
default: "auto" default: "auto"
auto_sharding_config: auto_sharding_config:
@ -141,7 +141,7 @@ types:
AutoShardingConfig: AutoShardingConfig:
type: struct type: struct
fields: fields:
numShardsInCluster: num_shards_in_cluster:
type: uint type: uint
description: "The number of shards in the configured cluster; this is a globally agreed value for each cluster." description: "The number of shards in the configured cluster; this is a globally agreed value for each cluster."
``` ```
@ -168,7 +168,7 @@ values:
TheWakuNetworkPreset: TheWakuNetworkPreset:
type: NetworkConfig type: NetworkConfig
fields: fields:
bootstrap_nodes: ["enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im"] bootstrap_nodes: [ "enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im" ]
static_store_nodes: #TODO: enter sandbox store nodes multiaddr static_store_nodes: #TODO: enter sandbox store nodes multiaddr
cluster_id: 1 cluster_id: 1
sharding_mode: "auto" sharding_mode: "auto"
@ -184,7 +184,7 @@ values:
DefaultAutoShardingConfig: DefaultAutoShardingConfig:
type: AutoShardingConfig type: AutoShardingConfig
fields: fields:
numShardsInCluster: 1 num_shards_in_cluster: 1
``` ```
#### Extended definitions #### Extended definitions