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

object-types api - add combined app_label.model field for quick lookups #9807

New Issue
Open
opened 2025-12-29 21:22:58 +01:00 by adam · 2 comments
adam commented 2025-12-29 21:22:58 +01:00
Owner
Copy Link

Originally created by @ITJamie on GitHub (Jun 6, 2024).

NetBox version

v4.0.3

Feature type

Data model extension

Proposed functionality

Add a read only field to the responses on the object-types API. allow filtering based on this "combined" field too
EG:

        {
            "id": 39,
            "url": "https://demo.netbox.dev/api/extras/object-types/39/",
            "display": "DCIM | interface",
            "app_label": "dcim",
            "model": "interface",
            "combined": "dcim.interface" # new field
        },

Use case

other api endpoints sometimes return the combined app_label.model string. to reference other object types.
eg on the interfaces API, an assigned interface returns "assigned_object_type": "dcim.interface". however to filter by that assigned_object_type you need to know the object-type id,

    "results": [
        {
            "id": 183,
            "url": "https://demo.netbox.dev/api/ipam/ip-addresses/183/",
            "display": "1.1.1.1/32",
# truncated
            "role": null,
            "assigned_object_type": "dcim.interface",
            "assigned_object_id": 1767,
# truncated
        },

being able to quickly use the combined string (egdcim.interface) to quickly lookup the object-type id without doing any text manipulation would be great

Database changes

N/A

External dependencies

N/A

Originally created by @ITJamie on GitHub (Jun 6, 2024). ### NetBox version v4.0.3 ### Feature type Data model extension ### Proposed functionality Add a read only field to the responses on the object-types API. allow filtering based on this "combined" field too EG: ``` { "id": 39, "url": "https://demo.netbox.dev/api/extras/object-types/39/", "display": "DCIM | interface", "app_label": "dcim", "model": "interface", "combined": "dcim.interface" # new field }, ``` ### Use case other api endpoints sometimes return the combined `app_label.model` string. to reference other object types. eg on the interfaces API, an assigned interface returns `"assigned_object_type": "dcim.interface"`. however to filter by that assigned_object_type you need to know the object-type id, ``` "results": [ { "id": 183, "url": "https://demo.netbox.dev/api/ipam/ip-addresses/183/", "display": "1.1.1.1/32", # truncated "role": null, "assigned_object_type": "dcim.interface", "assigned_object_id": 1767, # truncated }, ``` being able to quickly use the combined string (eg`dcim.interface`) to quickly lookup the object-type id without doing any text manipulation would be great ### Database changes N/A ### External dependencies N/A
adam added the type: featurecomplexity: mediumnetboxstatus: backlog labels 2025-12-29 21:22:58 +01:00
adam commented 2025-12-29 21:22:58 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 7, 2024):

Add a read only field to the responses on the object-types API. allow filtering based on this "combined" field too

It's worth pointing out that merely adding a read-only field is trivial, but enabling it to be used for filtering is a bit more involved.

Also, Django refers to this as the "natural key" for a content type; we might want to adopt the same name for the serializer field & filter.

>>> from django.contrib.contenttypes.models import ContentType
>>> ContentType.objects.get_for_model(Site)
<ContentType: DCIM | site>
>>> ContentType.objects.get_for_model(Site).natural_key()
('dcim', 'site')
@jeremystretch commented on GitHub (Jun 7, 2024): > Add a read only field to the responses on the object-types API. allow filtering based on this "combined" field too It's worth pointing out that merely adding a read-only field is trivial, but enabling it to be used for filtering is a bit more involved. Also, Django refers to this as the "natural key" for a content type; we might want to adopt the same name for the serializer field & filter. ```python >>> from django.contrib.contenttypes.models import ContentType >>> ContentType.objects.get_for_model(Site) <ContentType: DCIM | site> >>> ContentType.objects.get_for_model(Site).natural_key() ('dcim', 'site') ```
adam commented 2025-12-29 21:22:59 +01:00
Author
Owner
Copy Link

@ITJamie commented on GitHub (Jun 7, 2024):

I guess adding it as an actual field to make it easy to filter would make sense.
this endpoint is only really used in an informational way.

having it backfill the data into the model as part of migration wouldn't be hard.

as for the fieldname, natural_key would make a lot of sense, as long as it doesn't cause any kind of collision or confusion in the model

@ITJamie commented on GitHub (Jun 7, 2024): I guess adding it as an actual field to make it easy to filter would make sense. this endpoint is only really used in an informational way. having it backfill the data into the model as part of migration wouldn't be hard. as for the fieldname, natural_key would make a lot of sense, as long as it doesn't cause any kind of collision or confusion in the model
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 complexity: medium netbox status: backlog 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#9807
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?