mirror of
https://github.com/logos-messaging/logos-delivery-rest-api.git
synced 2026-07-23 19:53:16 +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>
51 lines
1.3 KiB
YAML
51 lines
1.3 KiB
YAML
# /messaging/v1/subscriptions:
|
|
post: # post_messaging_v1_subscriptions
|
|
summary: Subscribe the messaging client to an array of content topics
|
|
description: Subscribe the messaging client to an array of Content topics.
|
|
operationId: postMessagingSubscriptions
|
|
tags:
|
|
- messaging
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: './schemas/apitypes.yaml#/ContentTopic'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
'4XX':
|
|
description: Bad request.
|
|
'5XX':
|
|
description: Unexpected error.
|
|
|
|
delete: # delete_messaging_v1_subscriptions
|
|
summary: Unsubscribe the messaging client from an array of content topics
|
|
description: Unsubscribe the messaging client from an array of Content topics.
|
|
operationId: deleteMessagingSubscriptions
|
|
tags:
|
|
- messaging
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: './schemas/apitypes.yaml#/ContentTopic'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
'4XX':
|
|
description: Bad request.
|
|
'5XX':
|
|
description: Unexpected error.
|