NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-27 01:36:11 -06:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

9608 remove pagination / filters from bulk operations

Browse Source
This commit is contained in:
Arthur 2023-03-15 10:33:27 -07:00
parent 04628bcf71
commit 989a589ee7
1 changed files with 30 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
netbox/core/api/schema.py
View File

@ -17,6 +17,7 @@ from drf_spectacular.plumbing import (
from drf_spectacular.types import OpenApiTypes from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import extend_schema from drf_spectacular.utils import extend_schema
# see netbox.api.routers.NetBoxRouter
BULK_ACTIONS = ["bulk_destroy", "bulk_partial_update", "bulk_update"] BULK_ACTIONS = ["bulk_destroy", "bulk_partial_update", "bulk_update"]
@ -47,7 +48,9 @@ class NetBoxAutoSchema(AutoSchema):
""" """
Overrides to spectaculars AutoSchema to fix following issues: Overrides to spectaculars AutoSchema to fix following issues:
1. bulk serializers cause operation_id conflicts with non-bulk ones 1. bulk serializers cause operation_id conflicts with non-bulk ones
2. bulk operations don't have filter params 2. bulk operations should specify a list
3. bulk operations don't have filter params
4. bulk operations don't have pagination
""" """
@property @property
@ -59,7 +62,7 @@ class NetBoxAutoSchema(AutoSchema):
def get_operation_id(self): def get_operation_id(self):
""" """
Fix: bulk serializers cause operation_id conflicts with non-bulk ones bulk serializers cause operation_id conflicts with non-bulk ones
bulk operations cause id conflicts in spectacular resulting in numerous: bulk operations cause id conflicts in spectacular resulting in numerous:
Warning: operationId "xxx" has collisions [xxx]. "resolving with numeral suffixes" Warning: operationId "xxx" has collisions [xxx]. "resolving with numeral suffixes"
code is modified from drf_spectacular.openapi.AutoSchema.get_operation_id code is modified from drf_spectacular.openapi.AutoSchema.get_operation_id
@ -88,8 +91,32 @@ class NetBoxAutoSchema(AutoSchema):
# if not bulk - just return normal id # if not bulk - just return normal id
return super().get_operation_id() return super().get_operation_id()
def get_request_serializer(self) -> typing.Any:
# bulk operations should specify a list
serializer = super().get_request_serializer()
if self.is_bulk_action:
return type(serializer)(many=True)
return serializer
def get_response_serializers(self) -> typing.Any:
# bulk operations should specify a list
response_serializers = super().get_response_serializers()
if self.is_bulk_action:
return type(response_serializers)(many=True)
return response_serializers
def get_filter_backends(self): def get_filter_backends(self):
# Fix: bulk operations don't have filter params # bulk operations don't have filter params
if self.is_bulk_action: if self.is_bulk_action:
return [] return []
return super().get_filter_backends() return super().get_filter_backends()
def _get_paginator(self):
# bulk operations don't have pagination
if self.is_bulk_action:
return None
return super()._get_paginator()