Skip to content

Commit 6dc0020

Browse files
committed
Add GraphQL filter classes
1 parent 16c8dff commit 6dc0020

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/plugins/development/graphql-api.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,19 @@ NetBox provides two object type classes for use by plugins.
4646
::: netbox.graphql.types.NetBoxObjectType
4747
options:
4848
members: false
49+
50+
## GraphQL Filters
51+
52+
NetBox provides a base filter class for use by plugins which employ subclasseses of `NetBoxModel`.
53+
54+
::: netbox.graphql.filters.NetBoxModelFilter
55+
options:
56+
members: false
57+
58+
Additionally, the following filter classes are available for subclasses of standard base models.
59+
60+
| Model Class | FilterSet Class |
61+
|-----------------------|----------------------------------------------------|
62+
| `PrimaryModel` | `netbox.graphql.filters.PrimaryModelFilter` |
63+
| `OrganizationalModel` | `netbox.graphql.filters.OrganizationalModelFilter` |
64+
| `NestedGroupModel` | `netbox.graphql.filters.NestedGroupModelFilter` |

0 commit comments

Comments
 (0)