From b5c09724b752e1b51229202713707a44b2ec7099 Mon Sep 17 00:00:00 2001 From: Aldino Kemal Date: Wed, 5 Feb 2025 05:11:12 +0700 Subject: [PATCH] docs: updapte openapi --- docs/openapi.yaml | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/openapi.yaml b/docs/openapi.yaml index d274d61..cdcd0ed 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -1,7 +1,7 @@ openapi: "3.0.0" info: title: WhatsApp API MultiDevice - version: 5.0.0 + version: 5.1.0 description: This API is used for sending whatsapp via API servers: - url: http://localhost:3000 @@ -131,8 +131,9 @@ paths: - name: phone in: query schema: - type: integer + type: string example: '6289685028129@s.whatsapp.net' + description: Phone number with country code responses: '200': description: OK @@ -162,13 +163,15 @@ paths: - name: phone in: query schema: - type: integer + type: string example: '6289685028129@s.whatsapp.net' + description: Phone number with country code - name: is_preview in: query schema: type: boolean example: true + description: Whether to fetch a preview of the avatar responses: '200': description: OK @@ -350,6 +353,10 @@ paths: type: string format: binary description: Image to send + image_url: + type: string + example: https://example.com/image.jpg + description: Image URL to send compress: type: boolean example: false @@ -1320,13 +1327,17 @@ components: type: number UserInfoResponse: type: object + required: + - code + - message + - results properties: code: type: string example: SUCCESS message: type: string - example: + example: Success results: type: object properties: @@ -1574,7 +1585,7 @@ components: properties: text: type: string - example: "WhatsApp’s 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: type: string example: "1689653839450668"