jupyter_server icon indicating copy to clipboard operation
jupyter_server copied to clipboard

Strawman API Docs

Open bollwyvl opened this issue 1 year ago • 5 comments

references

  • #1418

code changes

alternatives

  • looked at redoc per https://github.com/jupyter-server/jupyter_server/issues/1418#issuecomment-2090954016
    • has hard-coded tracking logo served from third-party site
    • don't feel like hostile-forking it
    • also brought in ~100mb of node_modules
  • mounting it on /api (or even api/spec.yaml?docs) would be strictly better, but these both seemed finicky to sniff based on headers, and sometimes be static file or JSON or whatever, and probably not worth the hassle
  • could be separately configurable, but if you have the rights to access the spec.yaml

assessment

  • this is an important feature
    • but not convinced this belongs in core, given the size
    • however, an officially-supported extension, potentially with a jupyter_server[apidocs] would probably be pretty good

screens

note screen
basic image
build-a-GET image
GOT image
400% image

:bell: @Zsailer @tonyfast

bollwyvl avatar May 03 '24 00:05 bollwyvl