-
Notifications
You must be signed in to change notification settings - Fork 5.5k
update swagger API doc from jupyter-js-services #979
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.
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
Conversation
|
Is this an exact copy of what was in |
|
@blink1073 yes, other than bumping the version to 5. |
|
@blink1073 actually, after checking it with swagger, there were some validation errors that I've now fixed. |
|
LGTM |
notebook/services/api/api.yaml
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This description should be something like "Checkpoint restored", not created.
|
One small comment, but other than that, looks good to me. |
|
@jasongrout thanks! fixed. |
|
I'm trying to check the rendering, and for some reason it isn't rendering: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/minrk/notebook/swagger-doc/notebook/services/api/api.yaml |
|
It looks like a bug in the swagger renderer. I'm looking into it. |
|
Yep, definitely looks like a bug in swagger: swagger-api/swagger-ui#1903 |
|
How do I kickstart Travis again? edit: never mind, I had to log in to see the restart button. |
|
Does hitting the restart button here not work for you? https://travis-ci.org/jupyter/notebook/jobs/103882148 |
|
I hit it several times, and finally all of them passed. |
update swagger API doc from jupyter-js-services
|
@jasongrout, @blink1073, @minrk Do we want to link to the swagger API docs from the Developer section of the Sphinx docs or README.md? |
|
I'd say so (to both). |
|
Ping me when the rendering bug for swagger is solved, send me a link to where it's rendered, and I'm happy to update both. |
|
Yeah, I'd say that we figure out how to statically render that page and include it in the notebook as a static file. It's silly that we are depending on a hosted service to do the static rendering. |
|
and include it in the hosted documentation as well... |

No description provided.