Closed martinburchell closed 2 years ago
Looks very good! One minor thing: if you browse to the API test area and click "Options", you see a very nice display, but it offers "POST". Does that ever work? I thought OPTIONS was read-only, so should we remove this button (if that's possible)?
It wasn't picking up settings.CRATE for me, so I've added an explicit import of the CRATE object (from private_settings.py) in settings.py. Also changed relative to absolute import (OK?). Good to go from my perspective if you're happy -- thank you!
Looks very good! One minor thing: if you browse to the API test area and click "Options", you see a very nice display, but it offers "POST". Does that ever work? I thought OPTIONS was read-only, so should we remove this button (if that's possible)?
The page allows you to send either an OPTIONS request or a POST request. You see the response from the most recent request at the top of the page. To send an OPTIONS request there is just the button. The form with the POST button is for the POST request.
There was a bug that meant that if you hit the OPTIONS button, the JSON editors would not be be loaded into the subsequent page due to a JavaScript error. Now fixed.
To try it out:
pip install -e .
then:
then:
API documentation is at http://localhost:8000/schema/doc/
The API documentation also gets shoehorned into the Sphinx docs as an included piece of HTML