Raw Data API Improvement - Githubissues

hotosm / raw-data-api

Raw Data API is a set of high-performant APIs for transforming and exporting OpenStreetMap (OSM) data in different GIS file formats

https://hotosm.github.io/raw-data-api/

GNU Affero General Public License v3.0

25 stars 34 forks source link

Raw Data API Improvement #238

Closed KafayatYusuf closed 7 months ago

KafayatYusuf commented 8 months ago

What type of PR is this?

Check all applicable

[ ] 🍕 Feature
[ ] 🐛 Bug Fix
[X] 📝 Documentation
[ ] 🧑‍💻 Refactor
[X] ✅ Test
[ ] 🤖 Build or CI
[X] ❓ Other (Correction of spelling errors and punctuation marks)

Related Issue:

Corrects grammatical errors and punctuation in the markdown
Removes trailing backslashes

What does this PR do?

Removes trailing backslashes
Updates API description
Add googles docstrings to functions
Add status response codes (200,400,403,404,408 & 500) to endpoints
Corrects grammatical errors and punctuation in the Markdown
Contributes to this issue [https://github.com/hotosm/raw-data-api/issues/219]

Consideration:

Updating the description helps the user to understand what the API is all about
Removing trailing backslashes help to keep a consistent format and avoid errors
Status response codes help user to identify and know the responses to expect

How to test?

Visit the link below to access the API documentation Raw Data API Documentation ratemyopenapi

Screenshots:

Checklists:

Checklist before requesting review:

📖 Read the HOT Code of Conduct: https://docs.hotosm.org/code-of-conduct
👷‍♀️ Create small PRs. In most cases, this will be possible.
✅ Provide tests for your changes.
📝 Use descriptive commit messages.
📗 Update any related documentation and include any relevant screenshots.

[optional] What gif best describes this PR or how it makes you feel?

organizing

KafayatYusuf commented 7 months ago

Closed due to wrong placement (pushing)