Browse Source

chore: update docs (#8)

pull/10/head
Aldino Kemal 4 years ago
committed by GitHub
parent
commit
fe6ae6d8d3
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 14
      docs/openapi.yaml
  2. 2
      readme.md

14
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: 2.1.1
version: 2.2.1
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
@ -412,6 +412,10 @@ paths:
message: message:
type: string type: string
example: selamat malam example: selamat malam
type:
type: string
example: 'user'
description: 'user/group | default: user'
responses: responses:
'200': '200':
description: OK description: OK
@ -508,6 +512,10 @@ paths:
image: image:
type: string type: string
format: binary format: binary
type:
type: string
example: 'user'
description: 'user/group | default: user'
responses: responses:
'200': '200':
description: OK description: OK
@ -604,6 +612,10 @@ paths:
file: file:
type: string type: string
format: binary format: binary
type:
type: string
example: 'user'
description: 'user/group | default: user'
responses: responses:
'200': '200':
description: OK description: OK

2
readme.md

@ -35,7 +35,7 @@
You can fork or edit this source code ! You can fork or edit this source code !
### Current API ### Current API
`You can check docs/openapi.yml for detail API`
You can check [docs/openapi.yml](./docs/openapi.yaml) for detail API
| Feature | Menu | Method | URL | Payload | | Feature | Menu | Method | URL | Payload |
|---------|-------------------------|--------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------|-------------------------|--------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

Loading…
Cancel
Save