This is a dummy API used to define the API contract for the API modifier, I'm opening this PR, so that we can discuss it more easily (as we can post comments on specific places in the code)
I created a new file api_contract.py to avoid merge conflicts and to keep things simple and not worry about the implementation. This explains some oddities like keeping everything in one file or the JWTToken defined as a header instead of a proper dependancy since this file is only used for documentation of the API contract.
This PR is not meant to be merged -- once we're happy with the contract, we'll just grab the openapi.json file and upload it to Confluence after which we can close this PR
To see the docs run make api-contract-server and navigate to http://127.0.0.1:8000/docs (or alter the docker config and rebuild the container if you don't want to run the code locally)
This is a dummy API used to define the API contract for the API modifier, I'm opening this PR, so that we can discuss it more easily (as we can post comments on specific places in the code)
I created a new file
api_contract.pyto avoid merge conflicts and to keep things simple and not worry about the implementation. This explains some oddities like keeping everything in one file or the JWTToken defined as a header instead of a proper dependancy since this file is only used for documentation of the API contract.This PR is not meant to be merged -- once we're happy with the contract, we'll just grab the
openapi.jsonfile and upload it to Confluence after which we can close this PRTo see the docs run
make api-contract-serverand navigate tohttp://127.0.0.1:8000/docs(or alter the docker config and rebuild the container if you don't want to run the code locally)