Document the rest_cherrypy /token and /app endpoints (#69726)#69727
Open
ggiesen wants to merge 1 commit into
Open
Document the rest_cherrypy /token and /app endpoints (#69726)#69727ggiesen wants to merge 1 commit into
ggiesen wants to merge 1 commit into
Conversation
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 saltstack#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 saltstack#69726
dwoz
approved these changes
Jul 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds the two missing sections to the rest_cherrypy REST URI Reference:
POST /token(Tokenhandler) andGET /app(Apphandler). Every other handler class on the page has an.. autoclass::entry; these two were never included, so their endpoint docstrings (complete with request/response examples in Token's case) have never been rendered anywhere, and both endpoints are absent from the API reference and the HTTP routing table even though the running API routes them.What issues does this PR fix or reference?
Fixes #69726
Previous Behavior
POST /tokenandGET /appwere undocumented in the rendered docs.New Behavior
Both endpoints appear in the REST URI Reference in the existing page style and are listed in the HTTP routing table.
Verified with the pinned docs toolchain (sphinx 7.0.1, sphinxcontrib-httpdomain 2.0.0):
make htmlandmake manbuild clean with-W -j auto --keep-going; both new sections render with properly transformed field lists and anchors (#post--token,#get--app); each route registers exactly once in the http domain, so this does not interact with the duplicate-route cleanup in #69725.Merge requirements satisfied?
Docs-only change; no runtime code paths affected.
Commits signed with GPG?
No