nautobot/nautobot

Display an "API" tab for every object in the UI which shows the JSON representation for that object.

Opened this issue · 0 comments

jamesharr commented

As ...

Austin - Network Automation Engineer

I want ...

In the Nautobot UI most object views include a tab representing Advanced, Notes, Change Log. Including a tab that would show the REST JSON representation of the object would be extremely handy. That tab could be called "API", "JSON" or something else.

So that ...

It's easy to see the internal representation of an object when developing external automation scripts that makes use of Nautobot. Currently this can be accomplished by prefixing the object URL with /api, remove the query string, and hit CMD+Return/Shit+Return, but that's kind of a hassle if it's something you do a lot.

In the current version of Nautobot, under Advanced, there's a "View in API" button that provides similar behavior, but opens a new webpage / new browser tab. This is useful, however when doing development/research work, this usually leads to me doubling the number of tabs open when digging through an object hierarchy.

I know this is done when...

  • I can easily view the REST representation of an object without switching contexts
  • It might be useful to provide a UI control to set a depth field that mimics the API depth field.

Optional - Feature groups this request pertains to.

  • Automation
  • Circuits
  • DCIM
  • IPAM
  • Misc (including Data Sources)
  • Organization
  • Plugins (and other Extensibility)
  • Security (Secrets, etc)
  • Image Management
  • UI/UX
  • Documentation
  • Other (not directly a platform feature)

Database Changes

None

External Dependencies

Unclear if there are any external dependencies required for this, though JSON highlighting would be useful.