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

Search Prefixes by an exact description via REST API #6068

New Issue
Closed
opened 2025-12-29 19:36:18 +01:00 by adam · 2 comments
adam commented 2025-12-29 19:36:18 +01:00
Owner
Copy Link

Originally created by @djothi on GitHub (Feb 9, 2022).

Originally assigned to: @djothi on GitHub.

NetBox version

v3.1.7

Feature type

New functionality

Proposed functionality

curl https://demo.netbox.dev/api/prefixes/?q=CONTAINERS returns all prefixes that have the string "CONTAINERS" in their description. Queryset: Prefix.objects.filter(description__icontains=CONTAINERS)

The proposed functionality is to be able to return all prefixes via the REST API that have an exact description:

curl https://demo.netbox.dev/api/prefixes/?description=CONTAINERS would return only prefixes that have "CONTAINERS" as a description. Queryset: Prefix.objects.filter(description="CONTAINERS")

Use case

Getting Prefixes using an exact description via REST API.

Database changes

None

External dependencies

None

Originally created by @djothi on GitHub (Feb 9, 2022). Originally assigned to: @djothi on GitHub. ### NetBox version v3.1.7 ### Feature type New functionality ### Proposed functionality `curl https://demo.netbox.dev/api/prefixes/?q=CONTAINERS` returns all prefixes that have the string "CONTAINERS" in their description. Queryset: `Prefix.objects.filter(description__icontains=CONTAINERS)` The proposed functionality is to be able to return all prefixes via the REST API that have an exact `description`: `curl https://demo.netbox.dev/api/prefixes/?description=CONTAINERS` would return only prefixes that have "CONTAINERS" as a description. Queryset: `Prefix.objects.filter(description="CONTAINERS")` ### Use case Getting Prefixes using an exact description via REST API. ### Database changes None ### External dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 19:36:18 +01:00
adam closed this issue 2025-12-29 19:36:18 +01:00
adam commented 2025-12-29 19:36:19 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 18, 2022):

I think it's reasonable to enable this; it should involve just adding 'description' to Meta.fields in the FilterSet. However, if we're going to implement it, it should be added for all models with a description field and not just Prefix.

@jeremystretch commented on GitHub (Feb 18, 2022): I think it's reasonable to enable this; it should involve just adding `'description'` to `Meta.fields` in the FilterSet. However, if we're going to implement it, it should be added for _all_ models with a description field and not just Prefix.
adam commented 2025-12-29 19:36:20 +01:00
Author
Owner
Copy Link

@djothi commented on GitHub (Feb 24, 2022):

Ok, working on it.

@djothi commented on GitHub (Feb 24, 2022): Ok, working on it.
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: feature
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#6068
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?