New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update API docs for consistency #8

Open

joncison opened this issue Jul 10, 2017 · 1 comment

Assignees

Labels

bug

Member

joncison commented Jul 10, 2017

Ensure correct / consistent use e.g. attribute descriptions, restrictions / facets etc. in

current API docs (http://biotools.readthedocs.io/en/latest/api_reference.html)
next-gen API docs (http://biotools.readthedocs.io/en/latest/api_reference_dev.html)
JSON attributes description (http://biotools.readthedocs.io/en/latest/api_attribute_model_dev.html)
Curators Guide (http://biotools.readthedocs.io/en/latest/curators_guide.html)

Jon and @ekry to work on this together : the first step being to align biotoolsSchema and JSON model internally, then fix docs above.

joncison self-assigned this

0xaf1f commented Aug 24, 2017

Is this why some examples like http://biotools.readthedocs.io/en/latest/api_reference.html#id5 fail?

Example

curl -X GET "https://bio.tools/api/t/signalp/version/"

$ curl -X GET "https://bio.tools/api/t/signalp/version/"
<h1>Not Found</h1><p>The requested URL /api/t/signalp/version/ was not found on this server.</p>

joncison added the bug label

joncison assigned ekry

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment