All but a few endpoints in the readme have been converted into OpenAPI spec. I've left the three post endpoints in openapi/README.md.workingcopy in case anyone wants to try to convert those over.
As for the content in the main README, I've left it as is because it might be worth running both forms of documenting APIs in parallel for a little bit to get a few more opinions from the community - if in the end it's easier to keep the readme format, that's no problem.
@vloschiavo when you're happy with the PR, please squash commits during merge. Post merging to master, please can you edit the GitHub Pages setting to deploy the master branch instead of the openapi branch (which will presumably be closed by the merge).
Here it is.
All but a few endpoints in the readme have been converted into OpenAPI spec. I've left the three post endpoints in openapi/README.md.workingcopy in case anyone wants to try to convert those over.
As for the content in the main README, I've left it as is because it might be worth running both forms of documenting APIs in parallel for a little bit to get a few more opinions from the community - if in the end it's easier to keep the readme format, that's no problem.
@vloschiavo when you're happy with the PR, please squash commits during merge. Post merging to master, please can you edit the GitHub Pages setting to deploy the master branch instead of the openapi branch (which will presumably be closed by the merge).
Thank you :)