From d347b97f20f212184f0144d3601aca509e3c926f Mon Sep 17 00:00:00 2001 From: Joel McGuire Date: Thu, 5 Aug 2021 10:28:32 -0700 Subject: [PATCH] Fixes #6887 Add Examples in the Lookup Expression Docs (#6898) Fixes #6887 Add Examples in the Lookup Expression Docs Co-authored-by: joel --- docs/rest-api/filtering.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/rest-api/filtering.md b/docs/rest-api/filtering.md index 471beffee..45dfcfa36 100644 --- a/docs/rest-api/filtering.md +++ b/docs/rest-api/filtering.md @@ -69,6 +69,12 @@ Numeric based fields (ASN, VLAN ID, etc) support these lookup expressions: | `gt` | Greater than | | `gte` | Greater than or equal to | +Here is an example of a numeric field lookup expression that will return all VLANs with a VLAN ID greater than 900: + +```no-highlight +GET /api/ipam/vlans/?vid__gt=900 +``` + ### String Fields String based (char) fields (Name, Address, etc) support these lookup expressions: @@ -86,7 +92,17 @@ String based (char) fields (Name, Address, etc) support these lookup expressions | `nie` | Inverse exact match (case-insensitive) | | `empty` | Is empty (boolean) | +Here is an example of a lookup expression on a string field that will return all devices with `switch` in the name: + +```no-highlight +GET /api/dcim/devices/?name__ic=switch +``` + ### Foreign Keys & Other Fields Certain other fields, namely foreign key relationships support just the negation -expression: `n`. +expression: `n`. Here is an example of a lookup expression on a foreign key, it would return all the VLANs that don't have a VLAN Group ID of 3203: + +```no-highlight +GET /api/ipam/vlans/?group_id__n=3203 +```