From 4fa7dc4655ac54488ddd4e7f5a79ed3350eb3d0d Mon Sep 17 00:00:00 2001 From: "Gary T. Giesen" Date: Sun, 5 Jul 2026 22:13:32 -0400 Subject: [PATCH] Document the rest_cherrypy /token and /app endpoints The REST URI Reference page has an autoclass section for every handler class except Token (POST /token) and App (GET /app), so those two docstrings were never rendered anywhere and both endpoints are missing from the API reference and the HTTP routing table, despite being wired up in the running API. Add the two sections following the existing page style. Both routes are unique, so this does not interact with the duplicate route index cleanup in #69725; verified with the pinned docs toolchain that html and man build clean under -W -j auto, both sections render with transformed field lists and anchors, and each route registers exactly once. Fixes #69726 --- changelog/69726.fixed.md | 1 + doc/ref/netapi/all/salt.netapi.rest_cherrypy.rst | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 changelog/69726.fixed.md diff --git a/changelog/69726.fixed.md b/changelog/69726.fixed.md new file mode 100644 index 000000000000..382f3119f3df --- /dev/null +++ b/changelog/69726.fixed.md @@ -0,0 +1 @@ +Added the missing ``POST /token`` and ``GET /app`` sections to the rest_cherrypy REST API reference; their docstrings were never rendered because the page lacked autoclass entries for the Token and App handlers. diff --git a/doc/ref/netapi/all/salt.netapi.rest_cherrypy.rst b/doc/ref/netapi/all/salt.netapi.rest_cherrypy.rst index 0891dd296b0c..061df0c5ffa4 100644 --- a/doc/ref/netapi/all/salt.netapi.rest_cherrypy.rst +++ b/doc/ref/netapi/all/salt.netapi.rest_cherrypy.rst @@ -33,6 +33,12 @@ REST URI Reference .. autoclass:: Logout :members: POST +``/token`` +---------- + +.. autoclass:: Token + :members: POST + ``/minions`` ------------ @@ -80,3 +86,9 @@ REST URI Reference .. autoclass:: Stats :members: GET + +``/app`` +-------- + +.. autoclass:: App + :members: GET