Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description and 200 response example #1

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Conversation

mvhammedali
Copy link
Owner

What type of PR is this?

Check all applicable

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation
  • πŸ§‘β€πŸ’» Refactor
  • βœ… Test
  • πŸ€– Build or CI
  • ❓ Other (please specify)

Related Issue :

What does this PR do ?

Added description and 200 response example for /ping/, /queue/, /queue/details/{queue_name}/.

Consideration :

  • We could consider using try-except block for exception handling instead of if-else as that is the standard.

How to test ?

By running the server, you can see the changes.

Screenshots :

2024-03-25_12-56

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance API documentation and examples
2 participants