Browse Source

docs: updapte openapi

pull/237/head
Aldino Kemal 1 year ago
parent
commit
b5c09724b7
  1. 21
      docs/openapi.yaml

21
docs/openapi.yaml

@ -1,7 +1,7 @@
openapi: "3.0.0" openapi: "3.0.0"
info: info:
title: WhatsApp API MultiDevice title: WhatsApp API MultiDevice
version: 5.0.0
version: 5.1.0
description: This API is used for sending whatsapp via API description: This API is used for sending whatsapp via API
servers: servers:
- url: http://localhost:3000 - url: http://localhost:3000
@ -131,8 +131,9 @@ paths:
- name: phone - name: phone
in: query in: query
schema: schema:
type: integer
type: string
example: '6289685028129@s.whatsapp.net' example: '6289685028129@s.whatsapp.net'
description: Phone number with country code
responses: responses:
'200': '200':
description: OK description: OK
@ -162,13 +163,15 @@ paths:
- name: phone - name: phone
in: query in: query
schema: schema:
type: integer
type: string
example: '6289685028129@s.whatsapp.net' example: '6289685028129@s.whatsapp.net'
description: Phone number with country code
- name: is_preview - name: is_preview
in: query in: query
schema: schema:
type: boolean type: boolean
example: true example: true
description: Whether to fetch a preview of the avatar
responses: responses:
'200': '200':
description: OK description: OK
@ -350,6 +353,10 @@ paths:
type: string type: string
format: binary format: binary
description: Image to send description: Image to send
image_url:
type: string
example: https://example.com/image.jpg
description: Image URL to send
compress: compress:
type: boolean type: boolean
example: false example: false
@ -1320,13 +1327,17 @@ components:
type: number type: number
UserInfoResponse: UserInfoResponse:
type: object type: object
required:
- code
- message
- results
properties: properties:
code: code:
type: string type: string
example: SUCCESS example: SUCCESS
message: message:
type: string type: string
example:
example: Success
results: results:
type: object type: object
properties: properties:
@ -1574,7 +1585,7 @@ components:
properties: properties:
text: text:
type: string type: string
example: "WhatsApps official channel. Follow for our latest feature launches, updates, exclusive drops and more."
example: "WhatsApp's official channel. Follow for our latest feature launches, updates, exclusive drops and more."
id: id:
type: string type: string
example: "1689653839450668" example: "1689653839450668"

Loading…
Cancel
Save