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

address review

Browse Source
This commit is contained in:
Sasha 2025-10-08 23:49:54 +02:00
parent a25e3b9d3a
commit 79a96a6acf
No known key found for this signature in database
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -69,7 +69,7 @@ An alternative would be to choose a programming language. However, such choice m
### Primitive types and general guidelines ### Primitive types and general guidelines
- No `default` means that the value is mandatory, meaning a `default` value implies an optional parameter. - No `default` means that the value is mandatory, meaning a `default` value implies an optional parameter.
- Primitive types are `string`, `int`, `bool`, `enum` and `uint` - Primitive types are `string`, `int`, `bool`, `byte`, `enum` and `uint`
- Complex pre-defined types are: - Complex pre-defined types are:
- `object`: object and other nested types. - `object`: object and other nested types.
- `array`: iterable object containing values of all the same type. - `array`: iterable object containing values of all the same type.
@ -315,16 +315,16 @@ types:
type: string type: string
description: "The content topic for the message." description: "The content topic for the message."
payload: payload:
type: Uint8Array type: array<byte>
description: "The message data to be sent." description: "The message data to be sent."
ephemeral: ephemeral:
type: bool type: bool
default: false default: false
description: "Whether the message is ephemeral." description: "Whether the message is ephemeral. Read at [ATTRIBUTES](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/14/message.md#message-attributes)"
rateLimitProof: rateLimitProof:
type: Uint8Array type: array<byte>
default: none default: none
description: "Rate limiting proof as bytes" description: "Rate limiting proof needed for [PUBLISHING](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md#publishing)"
RequestId: RequestId:
type: string type: string
@ -336,7 +336,7 @@ types:
```yaml ```yaml
functions: functions:
send: send:
description: "Send a message through the Waku network." description: "Send a message through the network."
parameters: parameters:
- name: message - name: message
type: SendMessage type: SendMessage