starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add Examples to the Lookup Expressions Section. #5140

New Issue
Closed
opened 2025-12-29 19:24:46 +01:00 by adam · 1 comment
adam commented 2025-12-29 19:24:46 +01:00
Owner
Copy Link

Originally created by @jmcguir on GitHub (Aug 5, 2021).

Originally assigned to: @jmcguir on GitHub.

Change Type

Addition

Area

REST API

Proposed Changes

When I first used lookup expressions I kind of puzzled on how exactly they worked. It still happens each time I try to use them. I'd like to add some examples to them to make it clearer how they are used.

Add:

GET/api/ipam/vlans/?vid__gt=900

after the Numeric Fields subsection

and add:

GET api/dcim/devices/?name__ic=switch

after the String Fields subsection

and add:

GET api/ipam/vlans/?group_id__n=3203

after the Foreign Keys & Other Fields

I'd like to have them formatted like the example under the subsection "Filtering by Custom Field" looks.

I'm happy to submit a PR on this if approved.

Originally created by @jmcguir on GitHub (Aug 5, 2021). Originally assigned to: @jmcguir on GitHub. ### Change Type Addition ### Area REST API ### Proposed Changes When I first used lookup expressions I kind of puzzled on how exactly they worked. It still happens each time I try to use them. I'd like to add some examples to them to make it clearer how they are used. Add: `GET/api/ipam/vlans/?vid__gt=900` after the Numeric Fields subsection and add: `GET api/dcim/devices/?name__ic=switch` after the String Fields subsection and add: `GET api/ipam/vlans/?group_id__n=3203` after the Foreign Keys & Other Fields I'd like to have them formatted like the example under the subsection "Filtering by Custom Field" looks. I'm happy to submit a PR on this if approved.
adam added the status: acceptedtype: documentation labels 2025-12-29 19:24:46 +01:00
adam closed this issue 2025-12-29 19:24:46 +01:00
adam commented 2025-12-29 19:24:47 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 5, 2021):

Seems like the best place to add examples would be at the end of this section.

@jeremystretch commented on GitHub (Aug 5, 2021): Seems like the best place to add examples would be at the end of [this section](https://netbox.readthedocs.io/en/stable/rest-api/filtering/#lookup-expressions).
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#5140
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?