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>
28 lines
971 B
YAML
28 lines
971 B
YAML
# /messaging/v1/events/send/{requestId}:
|
|
get: # get_messaging_v1_events_send_by_id
|
|
summary: Poll the send events for one request id
|
|
description: Returns the buffered send events for a single request id, then removes them (evict-after-poll). The request id is the value returned by POST /messaging/v1/messages.
|
|
operationId: getMessagingSendEventsById
|
|
tags:
|
|
- messaging
|
|
parameters:
|
|
- in: path
|
|
name: requestId # Note the name is the same as in the path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The request id returned by the send endpoint.
|
|
responses:
|
|
'200':
|
|
description: The buffered send events for the request id.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: './schemas/apitypes.yaml#/SendStatus'
|
|
'404':
|
|
description: No send events buffered for the given request id.
|
|
'4XX':
|
|
description: Bad request.
|
|
'5XX':
|
|
description: Unexpected error.
|