skills.rest
netbox-community
netbox-communityOFFICIAL
Explore all skills by this author →
WebsiteGitHub

add-model

Implement a new NetBox model across UI, REST API, GraphQL, search, navigation, docs, and tests.

21.3k|3.1k|Updated Feb 29, 2016
Search Tags:#testing#documentation#graphql#api integration#netbox#django model#ui views
One-click install
npx skills add https://github.com/netbox-community/netbox --skill add-model-netbox-community
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: add-model
Source: https://github.com/netbox-community/netbox/tree/main/.claude/skills/add-model
Command: npx skills add https://github.com/netbox-community/netbox --skill add-model-netbox-community

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Adding a new data model to NetBox requires coordinating many framework components, and missing any piece (models, filters, serializers, views, tests, or docs) can break discovery, UI navigation, or API access.

Core Features & Use Cases

  • Step-by-step model wiring: Guides you through creating the Django model plus every required supporting component in the correct order.
  • Full-stack integration: Covers filtersets, forms (including bulk edit/import), tables, UI panels/layout, REST API serializers/viewsets/routes, and GraphQL types/filters/schema wiring.
  • Quality and discoverability: Includes registering the model in search, adding navigation menu entries, writing docs, and implementing tests to keep the change stable across interfaces.

Quick Start

Use the add-model skill to generate the complete set of NetBox components for your new object type by telling it the target app and the model’s name/URL slug.

Frequently Asked Questions about add-model

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new Django model to NetBox with complete API and UI support?▼

To add a new NetBox model end to end, you must wire up the Django model, filtersets, forms, tables, UI views, REST API serializers, GraphQL schema, search registration, navigation, and tests. Sequential setup ensures full framework integration and discoverability.

What components are required when creating a new object type in a NetBox app?▼

Creating a NetBox object type requires Django models, filtersets, forms, tables, URL routes, REST API viewsets, GraphQL types, search registration, navigation menu entries, documentation, and test coverage to maintain stable UI and API access.

Does adding a NetBox model automatically integrate with GraphQL and REST API endpoints?▼

No, adding a NetBox model requires manual GraphQL schema wiring and REST API serializer/viewset configuration. You must explicitly implement these components alongside UI views and URL routes to ensure full-stack API integration.

What is the best way to ensure a new NetBox model is discoverable in search and navigation?▼

To ensure NetBox model discoverability, you must explicitly register the model in search and add a navigation menu entry. Completing these steps alongside documentation and tests guarantees the object type is accessible across interfaces.

Why does my new NetBox model break API access or UI navigation after creation?▼

A new NetBox model breaks API access or UI navigation when dependent framework wiring is missing. Omitting filtersets, serializers, views, URL routes, or navigation entries disrupts discovery and prevents proper integration across the platform.

Can I use the add-model skill to generate bulk edit and import forms for NetBox?▼

Yes, the add-model skill guides the creation of NetBox forms including bulk edit and import functionality. It handles the complete form wiring alongside tables, UI panels, and layout required for the new object type.

Related Skills

Explore More Software Engineering Skills→
Sacred-GSacred-G
2

winui-app

Set up WinUI 3 environments and scaffold projects with packaging models.

Community
Intermediate
icartshicartsh
4

api-designer

Design RESTful and GraphQL APIs with OpenAPI 3.0 specifications.

Community
Advanced
jeremylongshorejeremylongshore
2.6k

generating-orm-code

Generate ORM models and database schemas across multiple frameworks.

Community
Intermediate
xxihxxih
1

django-patterns

Generate a Django project scaffold with modular settings and DRF API patterns.

Community
Advanced