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

Namespace GraphQL queries by app #11300

New Issue
Open
opened 2025-12-29 21:43:16 +01:00 by adam · 0 comments
adam commented 2025-12-29 21:43:16 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Jun 20, 2025).

NetBox version

v4.3.2

Feature type

Change to existing functionality

Proposed functionality

Currently, the GraphQL API is flat: All model queries are available under the root query. For example, querying sites:

{
    site_list {
        id
        name
    }
}

This FR proposes nesting queries within their core app or plugin, to effectively namespace queries and prevent collisions. The above query would become:

{
    dcim {
        site_list {
            id
            name
        }
    }
}

Use case

This change will protect against name collisions in the case where two plugins have a model with the same name, or where a plugin model has the same name as a core model.

Database changes

None

External dependencies

None

Originally created by @jeremystretch on GitHub (Jun 20, 2025). ### NetBox version v4.3.2 ### Feature type Change to existing functionality ### Proposed functionality Currently, the GraphQL API is flat: All model queries are available under the root query. For example, querying sites: ``` { site_list { id name } } ``` This FR proposes nesting queries within their core app or plugin, to effectively namespace queries and prevent collisions. The above query would become: ``` { dcim { site_list { id name } } } ``` ### Use case This change will protect against name collisions in the case where two plugins have a model with the same name, or where a plugin model has the same name as a core model. ### Database changes None ### External dependencies None
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 breaking change complexity: medium needs milestone netbox topic: GraphQL 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#11300
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?