Adding documentation in viewset breaks the viewable API UI #8613
Unanswered
ris-tlp
asked this question in
Potential Issue
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hi! I wanted to add the URLs being generated in a ViewSet class as doc strings for easier reference as shown below:
Upon doing this and navigating to the viewable API, it breaks the page and does not show any results.
Once I remove the URLs/protocols from the class's doc string:
The viewable API now works as intended:
I'm assuming this isn't intended behavior, is there a better/different way of adding documentation like that? I know it's redundant as the Mixin classes are self-explanatory, but I was wondering if something like this might have effects on other parts of DRF. Thanks!
Beta Was this translation helpful? Give feedback.
All reactions