Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GraphQL enabled API #5186

Closed
ziggekatten opened this issue Sep 28, 2020 · 2 comments
Closed

GraphQL enabled API #5186

ziggekatten opened this issue Sep 28, 2020 · 2 comments
Labels
status: duplicate This issue has already been raised

Comments

@ziggekatten
Copy link

Environment

  • Python version:
  • NetBox version:

Proposed Functionality

Using GraphQL to query the API to get information would simplify a lot of scenarios that today require multiple requests to get neccessary information. Example RootQuery would be: Tenant, IP-address, Prefix, VRF, VLAN, Interface, Virtual Machine, Virtual Interface, Device.

Having these would make life very easy to extract a Tenant's logical topology in one blow.

Use Case

Minimize number of GET requests to identify ID of object in netbox based on their relations when preparing an external system to update several objects in netbox.

Database Changes

No changes would be neccessary, as the models already have relations

External Dependencies

There are a package called Graphene-Django that could do this

@dgarros
Copy link
Contributor

dgarros commented Sep 28, 2020

I think it makes a lot of sense.
I think even if the API is Read-Only at first to reduce the amount of work it would be extremely useful.

Also there is already a project that did some work with Graphene-Django and NetBox that could be used for inspiration if needed https://github.com/ninech/django-netbox-graphql

@jeremystretch
Copy link
Member

Thank you for submitting this issue, however it appears that this topic has already been raised. Please see issue #2007 for further discussion. This is not something we'll be undertaking in the near future.

@jeremystretch jeremystretch added the status: duplicate This issue has already been raised label Sep 28, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 28, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: duplicate This issue has already been raised
Projects
None yet
Development

No branches or pull requests

3 participants