mirror of
https://github.com/logos-messaging/logos-delivery-rest-api.git
synced 2026-07-23 11:43:15 +00:00
23059b7c0b
Document the high-level messaging client REST surface following the
existing per-endpoint-file structure:
- POST/DELETE /messaging/v1/subscriptions (subscribe by content topic)
- POST /messaging/v1/messages (send a MessageEnvelope -> requestId)
- GET /messaging/v1/events/send[/{requestId}] (poll send events)
- GET /messaging/v1/events/received (poll received messages)
Adds the messaging schemas to schemas/apitypes.yaml (MessagingJsonEnvelope,
MessagingSendResponse, SendEventRecord, SendStatus, ReceivedMessageRecord,
list wrappers) and wires the paths + a `messaging` tag into openapi.yaml.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
17 lines
674 B
YAML
17 lines
674 B
YAML
# /messaging/v1/events/received:
|
|
get: # get_messaging_v1_events_received
|
|
summary: Poll buffered received messages
|
|
description: Returns buffered received messages (up to the cache capacity, oldest first), then clears them (evict-after-poll). Optimized for polling; each record carries the message hash and the full received WakuMessage.
|
|
operationId: getMessagingReceivedMessages
|
|
tags:
|
|
- messaging
|
|
responses:
|
|
'200':
|
|
description: The buffered received messages, oldest first.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: './schemas/apitypes.yaml#/ReceivedMessagesResponse'
|
|
'5XX':
|
|
description: Unexpected error.
|