[DOCS]: Write Documentation for Postman Endpoints

[ttebify]

Task Description:

The purpose of this issue is to write documentation for all the endpoints in Postman that currently lack documentation. This will ensure that all endpoints have clear and comprehensive descriptions, making it easier for team members and users to understand and utilise the API. The specific tasks involved are as follows:

• Identify the endpoints in Postman that do not yet have documentation.
• Write detailed descriptions and explanations for each of the undocumented endpoints.
• Include information about the expected request parameters, response formats, and any specific considerations or requirements.
• Update the Postman collection or workspace with the newly written documentation.

Acceptance Criteria:

• All endpoints in Postman should have documentation.
• Each endpoint should have a clear and comprehensive description, including request parameters and response details.
• The Postman collection or workspace should be updated with the newly written documentation.

Implementation Guidelines:

1. Review the existing endpoints in the Postman collection or workspace.
2. Identify the endpoints that currently lack documentation.
3. For each undocumented endpoint, write a detailed description that explains the purpose and functionality of the endpoint.
4. Include information about the expected request parameters, their formats, and any validation rules.
5. Describe the response format and any relevant data or metadata included in the response.
6. If necessary, provide additional information or instructions for using the endpoint correctly.
7. Update the Postman collection or workspace, adding the documentation to the appropriate endpoint(s).
8. Test the documentation by making sample requests and verifying that the responses align with the documented expectations.