chore: Swagger documentation for public APIs (#2417)
This commit is contained in:
20
swagger/paths/public/inboxes/messages/create.yml
Normal file
20
swagger/paths/public/inboxes/messages/create.yml
Normal file
@@ -0,0 +1,20 @@
|
||||
tags:
|
||||
- Messages API
|
||||
operationId: create-a-message
|
||||
summary: Create a message
|
||||
description: Create a message
|
||||
security:
|
||||
- nil
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/public_message_create_payload'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/public_message'
|
||||
401:
|
||||
description: Unauthorized
|
||||
15
swagger/paths/public/inboxes/messages/index.yml
Normal file
15
swagger/paths/public/inboxes/messages/index.yml
Normal file
@@ -0,0 +1,15 @@
|
||||
tags:
|
||||
- Messages API
|
||||
operationId: list-all-converation-messages
|
||||
summary: List all messages
|
||||
description: List all messages in the conversation
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
type: array
|
||||
description: 'Array of messages'
|
||||
items:
|
||||
$ref: '#/definitions/public_message'
|
||||
401:
|
||||
description: Unauthorized
|
||||
20
swagger/paths/public/inboxes/messages/update.yml
Normal file
20
swagger/paths/public/inboxes/messages/update.yml
Normal file
@@ -0,0 +1,20 @@
|
||||
tags:
|
||||
- Messages API
|
||||
operationId: update-a-message
|
||||
summary: Update a message
|
||||
description: Update a message
|
||||
security:
|
||||
- nil
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/public_message_update_payload'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/public_message'
|
||||
401:
|
||||
description: Unauthorized
|
||||
Reference in New Issue
Block a user