bcgov / citz-imb-wayfinder

CITZ IMB Capstone 2023 Wayfinder

Apache License 2.0

6 stars 2 forks source link

Wayf 97 update and fix swagger docs #79

Closed LocalNewsTV closed 1 year ago

LocalNewsTV commented 1 year ago

Description

This PR includes the following proposed change(s):

Updated Swagger documentation for /locations endpoint to match new data
Took existing swagger doc and compartmentalized it for better reader usability
added stub swagger doc for /reports endpoint for future updating, as currently the Reporting feature is not finalized

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Refactoring / Documentation
[ ] Updating Testing Framework(s)
[ ] Version change

How Has This Been Tested?

Visually Read and checked data was displayed as intended

Frontend Development Changes

[x] N/A
[ ] I have performed a self-review of my own code
[ ] I have made corresponding changes to project documentation or diagrams that reflect my changes
[ ] New and existing unit tests pass locally with my changes
[ ] My code follows Airbnb React Style Guidelines

API Development Changes

[ ] N/A
[ ] I have performed a self-review of my own code
[ ] My code follows standards and practices outlined in the BC Government API Development Guidelines
[x] New and existing unit tests pass locally with my changes
[x] My changes includes Swagger documentation updates that reflect the changes I am introducing