Mercurial > hg > orthanc-book
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 576:28a09c734c90 | 577:7d27154e70f9 |
|---|---|
| 1 .. _cheatsheet: | |
| 2 | |
| 3 Cheat sheet of the REST API | |
| 4 =========================== | |
| 5 | |
| 6 This quick reference of the :ref:`REST API of Orthanc <rest>` is | |
| 7 automatically generated from the source code of Orthanc. Clicking on | |
| 8 one of the HTTP methods will open its full OpenAPI documentation. | |
| 9 | |
| 10 If you are looking for samples, check out the dedicated :ref:`FAQ | |
| 11 entry <rest-samples>`. | |
| 12 | |
| 13 | |
| 14 .. csv-table:: Reference | |
| 15 :header-rows: 1 | |
| 16 :file: ./rest-cheatsheet.csv | |
| 17 :widths: 10, 2, 2, 2, 2, 10 | |
| 18 | |
| 19 NB: Up to Orthanc 1.8.2, this cheat sheet was manually published as an | |
| 20 `online spreadsheet | |
| 21 <https://docs.google.com/spreadsheets/d/e/2PACX-1vSBEymDKGZgskFEFF6yzge5JovGHPK_FIbEnW5a6SWUbPkX06tkoObUHh6T1XQhgj-HqFd0AWSnVFOv/pubhtml>`__. This | |
| 22 spreadsheet is still available online for history purpose, but is now | |
| 23 left unmaintained. |