added a doc string to get-list-details function

[Olatundeawo]

What type of PR is this?

Check all applicable

• [ ] 📝 Documentation
• [ ] 🧑‍💻 Refactor
• [ ] ✅ Test

Related Issue :

https://github.com/hotosm/raw-data-api/issues/219

What does this PR do ?

The essence of this pull request lies in fortifying the documentation for the get_list_details endpoint by embedding a detailed docstring. This docstring delves into the intricacies of the endpoint, elucidating its overarching purpose, input parameters, output composition, and potential error scenarios. Furthermore, it includes an illustrative response snippet to elucidate the expected outcome.

Consideration :

I take into consideration:

Prioritizing clarity and comprehensiveness in the documentation to facilitate understanding of the endpoint's functionality and behavior.

How to test ?

To test this enhancement:

Visist http://127.0.0.1:8000/v1/docs

[kshitijrajsharma]

Thanks for the PR