logos-delivery-rest-api/api-spec/messagingapi_messages.yaml
NagyZoltanPeter 23059b7c0b
feat: add messaging REST API spec
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>
2026-07-16 17:22:09 +02:00

24 lines
725 B
YAML

# /messaging/v1/messages:
post: # post_messaging_v1_messages
summary: Send a message through the messaging client
description: Sends a message (a MessageEnvelope) through the messaging client and returns the request id used to correlate the subsequent send events.
operationId: postMessagingMessage
tags:
- messaging
requestBody:
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/MessagingJsonEnvelope'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/MessagingSendResponse'
'4XX':
description: Bad request.
'5XX':
description: Unexpected error.