Mercurial > hg > orthanc-book
diff Sphinx/source/users/rest-cheatsheet.rst @ 577:7d27154e70f9
cheatsheet and full openapi
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 30 Dec 2020 07:55:12 +0100 |
parents | |
children | eaa6cdfa7ba6 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Sphinx/source/users/rest-cheatsheet.rst Wed Dec 30 07:55:12 2020 +0100 @@ -0,0 +1,23 @@ +.. _cheatsheet: + +Cheat sheet of the REST API +=========================== + +This quick reference of the :ref:`REST API of Orthanc <rest>` is +automatically generated from the source code of Orthanc. Clicking on +one of the HTTP methods will open its full OpenAPI documentation. + +If you are looking for samples, check out the dedicated :ref:`FAQ +entry <rest-samples>`. + + +.. csv-table:: Reference + :header-rows: 1 + :file: ./rest-cheatsheet.csv + :widths: 10, 2, 2, 2, 2, 10 + +NB: Up to Orthanc 1.8.2, this cheat sheet was manually published as an +`online spreadsheet +<https://docs.google.com/spreadsheets/d/e/2PACX-1vSBEymDKGZgskFEFF6yzge5JovGHPK_FIbEnW5a6SWUbPkX06tkoObUHh6T1XQhgj-HqFd0AWSnVFOv/pubhtml>`__. This +spreadsheet is still available online for history purpose, but is now +left unmaintained.