PathOfBuilding
PathOfBuilding copied to clipboard
Proposal API contract
Fixes #7389 controversial addition by designing a common API to adhere to.
Description of the problem being solved:
This may be used as a base for designing a common PoB API, which build sites such as: maxroll, icy-veins, pobarchives and so on should adhere to if they want to be able to display builds inside of PoB. Furthermore it may also be possible for content creators to support this feature by providing a subset of the required API.
In this initial draft there would be an aim towards two so called endpoint types: REST and CSV.
The REST version would be for anyone who wants to support more complex features such as filtering and possibly other features. Whereas the CSV version would be an option for content creators who may not have the time, money or willingness to support a custom REST API for their builds. This would easily usable by them to either have a simple webserver just hosting a csv file or using GitHub in order to host the builds.
For more information and current thoughts about the API Contract the information can be found in APIContract.md
Steps taken to verify a working solution:
- TBD
Link to a build that showcases this PR:
TBD
Before screenshot:
TBD
After screenshot:
TBD