feature: Implement Synchronization of Postman with API_DOCUMENTATION.md

[benoit-bremaud]

Description:

Summary

Implement a feature to automate the synchronization of Postman collections with the API documentation (API_DOCUMENTATION.md). This will ensure that the documentation is always up-to-date with the latest API changes and examples.

Context

Maintaining accurate and up-to-date API documentation is essential for developers and users of the API. Automating the synchronization between Postman collections and the Markdown documentation file will streamline the process, reduce manual effort, and minimize errors.

Objectives

• Export Postman collections and convert them to Markdown format.
• Integrate the converted Markdown into API_DOCUMENTATION.md.
• Automate the synchronization process using a script.

Acceptance Criteria

• The Postman collection can be exported and converted to Markdown.
• The converted Markdown is correctly integrated into API_DOCUMENTATION.md.
• The synchronization process can be automated with a script.
• The script is tested and verified to ensure it works as expected.

Tasks

• Create and initialize a new working branch
  • Branch name format: feature/205-sync-postman-with-doc
• Configure Postman collection with descriptions and examples.
• Export the Postman collection in Postman Collection v2.1 format.
• Convert the Postman collection to Markdown using postman-to-markdown.
• Integrate the converted Markdown into API_DOCUMENTATION.md.
• Create a script to automate the export, conversion, and integration process.
• Test the synchronization process to ensure accuracy and completeness.
• Write the commit message
  • Ensure the commit message follows the naming conventions as specified in the CONTRIBUTING.md guide.
• Create the Pull Request
  • Ensure the Pull Request follows the naming and description conventions as specified in the CONTRIBUTING.md guide.

Resources

• Postman-to-Markdown
• Postman Documentation
• Markdown Guide

UML Diagrams References

• Sequence Diagram: To visualize the flow of operations during the synchronization process.

Branch Name

feature/205-sync-postman-with-doc

Complementary Suggested Tasks

• Ensure compatibility with existing documentation tools and processes.
• Provide a usage guide for the synchronization script.
• Create follow-up issues for any identified improvements or additional automation features.