Skip to content
Snippets Groups Projects

Add API documentation

Merged Konrad Mohrfeldt requested to merge feature/api-docs into master
Compare changes
  • Side-by-side
  • Inline
Files
2
  • Most of the queryset filtering for subroutes formerly implemented
    through custom get_queryset methods can happen semi-automated through a
    mixin, making the behaviour re-usable and allowing us strip a lot of
    additional logic for retrieving objects.
    
    The use of the viewset get_object method also allows us to implement
    object access with permission classes in the future, and should make a
    whole lot of other code obselete.
    
    This change is primarily motivated by the fact that documentation of the
    API will become a lot easier if the subroutes don’t impose arbitrary
    restrictions on the specific subpath under which an operation is
    allowed. For instance updating a schedule should be possible through
    either /schedules/<pk>/ or
    /shows/<show_pk>/schedules/<schedule_pk>/ as long as all the necessary
    data is present in the request body.
Loading