chore: Swagger documentation for public APIs (#2417)

This commit is contained in:
Sojan Jose
2021-06-16 00:14:09 +05:30
committed by GitHub
parent 2b9c93a1b3
commit af8223545e
22 changed files with 978 additions and 186 deletions

View 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

View 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

View 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