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

Implement API Endpoints to Return Parking with Most Free Spots and All Parking with Free Spots #16

Open
Kawaban opened this issue Nov 17, 2024 · 0 comments · May be fixed by #25
Open
Assignees

Comments

@Kawaban
Copy link
Member

Kawaban commented Nov 17, 2024

Objective:
The goal of this task is to create API endpoints that return:

  • The parking with the most free spots.
  • A list of all parking that have available spots.

Scope:

  1. Implementation:
  • Implement endpoits for retrieving information about the parking with the most free spots and a list of all parking that have available spots.
  1. Introduce a logging mechanism (using SLF4J annotation)
  • Log key events, such as API requests, responses, errors, and warnings.
  • Ensure logs include enough detail to trace issues without exposing sensitive information.
  1. Testing:
  • Write unit tests to thoroughly cover the functionality of the solution
  1. Documentation:
  • Create Swagger documentation for implemented endpoints.

Expected Outcome:

  • User is able to retrieve the parking with the most free spots and a list of all parking that have available spots
  • Unit tests ensure the correctness and reliability of the endpoints, covering different scenarios.
  • Swagger documentation is available for all implemented endpoints, providing clear descriptions of input parameters, response formats, and possible errors.
@Kawaban Kawaban changed the title mplement API Endpoints to Return Parking with Most Free Spots and All Parking with Free Spots Implement API Endpoints to Return Parking with Most Free Spots and All Parking with Free Spots Nov 17, 2024
@mateusz-plaska mateusz-plaska self-assigned this Nov 17, 2024
@mateusz-plaska mateusz-plaska linked a pull request Dec 13, 2024 that will close this issue
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 a pull request may close this issue.

2 participants