Skip to content

Commit

Permalink
Add note in 'Introspecting ViewSet actions' docs section (#9633)
Browse files Browse the repository at this point in the history
* Fix `Introspecting ViewSet actions` docs section

* Update docs/api-guide/viewsets.md

---------

Co-authored-by: Bruno Alla <[email protected]>
  • Loading branch information
EXG1O and browniebroke authored Jan 29, 2025
1 parent e1c070a commit f8dbea1
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api-guide/viewsets.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,8 @@ You may inspect these attributes to adjust behavior based on the current action.
permission_classes = [IsAdminUser]
return [permission() for permission in permission_classes]

**Note**: the `action` attribute is not available in the `get_parsers`, `get_authenticators` and `get_content_negotiator` methods, as it is set _after_ they are called in the framework lifecycle. If you override one of these methods and try to access the `action` attribute in them, you will get an `AttributeError` error.

## Marking extra actions for routing

If you have ad-hoc methods that should be routable, you can mark them as such with the `@action` decorator. Like regular actions, extra actions may be intended for either a single object, or an entire collection. To indicate this, set the `detail` argument to `True` or `False`. The router will configure its URL patterns accordingly. e.g., the `DefaultRouter` will configure detail actions to contain `pk` in their URL patterns.
Expand Down

0 comments on commit f8dbea1

Please sign in to comment.