Introduced new endpoints on following scenario :
Major patches that requires URL change they will be updated like following :
{API_URL}/_v{version_number}/
Docs will be different for different versions and also availability of api endpoints also differ from different version , can be accessed through /docs with each url
Backward compatibility is maintained on API , if new major change comes to specific endpoint they will be available as different version and previous version will still be able to deliver old info until we outdate it , It will be possible to release different version of same endpoint while maintaining all of versions like in the screenshot below
This PR also introduces new URL called /latest/ -- which will always point to latest version of API , so it will be possible for the consumer to consume API without knowing version , they can go to specific version of API through version route i.e. /v{version_number}/
Uses -- fastapi-versioning
Screenshots :
{API_URL}/docs will result following page giving info about available versions
This is how specific version of API documentation can be retrieved :
using latest on URL will always point to the latest version of API available
Redoc Can be checked here : http://52.203.15.233:8000/v1/redoc
Description :
Introduced new endpoints on following scenario : Major patches that requires URL change they will be updated like following : {API_URL}/_v{version_number}/
Docs will be different for different versions and also availability of api endpoints also differ from different version , can be accessed through /docs with each url
Backward compatibility is maintained on API , if new major change comes to specific endpoint they will be available as different version and previous version will still be able to deliver old info until we outdate it , It will be possible to release different version of same endpoint while maintaining all of versions like in the screenshot below
This PR also introduces new URL called /latest/ -- which will always point to latest version of API , so it will be possible for the consumer to consume API without knowing version , they can go to specific version of API through version route i.e. /v{version_number}/
Uses -- fastapi-versioning
Screenshots :
Contributes to https://github.com/hotosm/galaxy-api/issues/231
Contibutes to #134
Resolve #276
Also adds some techinal documents with sample request and response on exisiting endpoints
Based from https://github.com/hotosm/galaxy-api/pull/267