Endpoint:

POST /api/v1/pong

Summary

The Pong endpoint is used to test the connectivity and response of the API server. It is part of the test-apis suite, designed to ensure that the server is operational and can handle requests properly.

Parameters

uid (query, optional):
- Description: User UUID to test get wallet balance.
- Type: string
Authorization (header, required):
- Description: Bearer Token for authentication.
- Type: string

Responses

200 OK:
- Description: The request was successful, and the server is responsive.
- Content: application/json
- Schema: types.SuccessResponse
400 Bad Request:
- Description: The request was malformed or missing required parameters.
- Content: application/json
- Schema: types.ErrorResponse
500 Internal Server Error:
- Description: The server encountered an unexpected condition that prevented it from fulfilling the request.
- Content: application/json
- Schema: types.ErrorResponse

Usage

This endpoint is typically used in development and testing environments to verify that the API server is up and running. It can be used to check the server's ability to process requests and return responses.

Example Request

POST /api/v1/pong?uid=12345 HTTP/1.1
Host: api.example.com
Authorization: Bearer your_token_here

Example Response

{
  "success": true,
  "data": {}
}

Notes

Ensure that the Authorization header is included in the request to authenticate the call.
The uid parameter is optional and can be used to test specific user-related functionalities.