generated from amosproj/amos202Xss0Y-projname
-
Notifications
You must be signed in to change notification settings - Fork 0
API endpoints discussion
Tanja Yakovenko edited this page Jun 3, 2024
·
2 revisions
Goal: Review and define the necessary API endpoints for the project, focusing on data delivery mechanisms and database management to support application functionality. Participants: Lucas, Leon, Celine, Ahsan, Emil, Tanja, Nicolas
Key Discussion Points:
- Overview of API Requirements:
- Discussed the need for an API to efficiently deliver all available datasets to the frontend.
- Emphasized the importance of retrieving specific metadata for each dataset to aid in data interpretation and utilization.
- Specific API Calls Identified:
- Crucial Endpoint: Develop an API call that lists all available datasets, providing a comprehensive view for the users.
- Metadata Retrieval: Implement an endpoint to fetch specific metadata for chosen datasets, enhancing data context.
- Location-Specific Data Request: Create functionality to request data for specific geographic locations, potentially using key-value pairs to define filters.
- Technical Discussions and Proposals:
- Leon’s Proposal: Suggested minimizing database interactions by initially parsing data from files directly; consider moving to backend database solutions if the file-based approach becomes inefficient.
- Emil’s Input: Advocated for default behaviors in the API, with capabilities to append metadata dynamically based on user needs.
- Database and Data Management:
- Explored using GeoJSON for backend effectiveness and compatibility.
- Discussed the need for data aggregation based on zoom levels, and the implications for database indexing. Considered the use of PostGIS and the potential need for MongoDB to handle different indexing requirements.
- Future Planning and Incremental Development:
- Agreed on the need for prioritization and maintaining an incremental approach to API development, allowing for adjustments in future sprints based on emerging requirements and feedback.
- REST API Design Considerations:
- Defined two primary types of input for the REST API: a. Geospatial Query: Input for bounding coordinates (top and lower corners) and zoom level, with responses including a list of points in GeoJSON format. b. Proximity Query: Input for a specific location to retrieve details about the nearest charging point.
Keep in mind:
- Determine the total number of datasets to be managed and integrated.
- Acknowledged that the project will likely remain in an ongoing state of development, adapting to new data and user requirements as they arise.