logos-messaging-rest-api/api-spec/lightpushapi_v3.yaml

73 lines
1.9 KiB
YAML

post:
summary: Request a message relay from a LightPush service provider
description: Push a message to be relayed on a PubSub topic.
operationId: postMessagesToPubsubTopic
tags:
- lightpush
requestBody:
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'413':
description: Payload too large.
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'420':
description: Invalid message.
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'421':
description: Unsupported pubsub topic.
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'429':
description: Too many requests
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'503':
description: Service not available
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'504':
description: Out of RLN proof
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'
'505':
description: No peers to relay
content:
application/json:
schema:
$ref: './schemas/apitypes.yaml#/PushResponse'