Skip to content

Commit e7405ee

Browse files
authored
Merge pull request #236 from jtpio/api-spec
Add a link to the swagger viewer to the REST API page in the docs
2 parents edc9dc2 + da60406 commit e7405ee

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

docs/source/developers/rest-api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
The REST API
22
============
33

4+
An interactive version is available
5+
`here <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyter_server/master/jupyter_server/services/api/api.yaml>`_.
6+
47
.. openapi:: ../../../jupyter_server/services/api/api.yaml

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Jupyter Server is the backend—the core services, APIs, and `REST endpoints`_
1919

2020
.. _Tornado: https://www.tornadoweb.org/en/stable/
2121
.. _Jupyter Notebook: https://github.com/jupyter/notebook
22-
.. _REST endpoints: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml
22+
.. _REST endpoints: https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyter_server/master/jupyter_server/services/api/api.yaml
2323

2424
Who's this for?
2525
---------------

jupyter_server/services/api/api.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
swagger: '2.0'
22
info:
3-
title: Jupyter Notebook API
4-
description: Notebook API
3+
title: Jupyter Server API
4+
description: Server API
55
version: "5"
66
contact:
77
name: Jupyter Project

0 commit comments

Comments
 (0)