From 6dc00206a485e22054a02185134626ee2beeb623 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 8 Dec 2025 15:13:19 -0500 Subject: [PATCH] Add GraphQL filter classes --- docs/plugins/development/graphql-api.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/plugins/development/graphql-api.md b/docs/plugins/development/graphql-api.md index 603b0cead..b7691cc70 100644 --- a/docs/plugins/development/graphql-api.md +++ b/docs/plugins/development/graphql-api.md @@ -46,3 +46,19 @@ NetBox provides two object type classes for use by plugins. ::: netbox.graphql.types.NetBoxObjectType options: members: false + +## GraphQL Filters + +NetBox provides a base filter class for use by plugins which employ subclasseses of `NetBoxModel`. + +::: netbox.graphql.filters.NetBoxModelFilter + options: + members: false + +Additionally, the following filter classes are available for subclasses of standard base models. + +| Model Class | FilterSet Class | +|-----------------------|----------------------------------------------------| +| `PrimaryModel` | `netbox.graphql.filters.PrimaryModelFilter` | +| `OrganizationalModel` | `netbox.graphql.filters.OrganizationalModelFilter` | +| `NestedGroupModel` | `netbox.graphql.filters.NestedGroupModelFilter` |