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

Plugins must define app_name in api/urls.py to be included in API root view #4227

New Issue
Closed
opened 2025-12-29 18:33:59 +01:00 by adam · 0 comments
adam commented 2025-12-29 18:33:59 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Oct 29, 2020).

Environment

  • Python version: 3.6.9
  • NetBox version: 2.9.7

Steps to Reproduce

I'm actually not certain whether this is better classified as a bug or a lapse in the documentation, but I'm opting to propose it as a bug because I think it can be addressed by a code change.

  1. Create/install a plugin which provides at least one REST API endpoint. (Assume the plugin's name is myplugin.)
  2. Within api/urls.py, set app_name = myplugin-api
  3. Visit /api/plugins/ in the browser. The plugin should be included.
  4. Remove the app_name definition from api/urls.py.
  5. Visit /api/plugins/ in the browser again. The plugin no longer appears.

Expected Behavior

Plugin API endpoints should be detected automatically. AFAICT there's no reason a plugin should need to declare app_name. (The core apps do this, but only because they're being included dynamically.)

Observed Behavior

Plugin API endpoints disappear from the list when app_name is not declared.

It seems like the need for the app_name variable could be obviated within PluginsAPIRootView._get_plugin_entry() by changing

api_app_name = import_object(f"{plugin}.api.urls.app_name")

to

api_app_name = f'{app_config.name}-api'

This actually raises another point: the full URL name for a plugin API endpoint is currently in the format plugins-api:myplugin-api:url-name, which seems a bit unwieldy: plugins-api:myplugin:url-name should suffice. However, this would be a breaking change for any plugins which rely on reverse URL resolution to their REST API endpoints.

Originally created by @jeremystretch on GitHub (Oct 29, 2020). ### Environment * Python version: 3.6.9 * NetBox version: 2.9.7 ### Steps to Reproduce I'm actually not certain whether this is better classified as a bug or a lapse in the documentation, but I'm opting to propose it as a bug because I think it can be addressed by a code change. 1. Create/install a plugin which provides at least one REST API endpoint. (Assume the plugin's name is `myplugin`.) 2. Within `api/urls.py`, set `app_name = myplugin-api` 3. Visit `/api/plugins/` in the browser. The plugin should be included. 4. Remove the `app_name` definition from `api/urls.py`. 5. Visit `/api/plugins/` in the browser again. The plugin no longer appears. ### Expected Behavior Plugin API endpoints should be detected automatically. AFAICT there's no reason a plugin should need to declare `app_name`. (The core apps do this, but only because they're being included dynamically.) ### Observed Behavior Plugin API endpoints disappear from the list when `app_name` is not declared. It seems like the need for the `app_name` variable could be obviated within `PluginsAPIRootView._get_plugin_entry()` by changing ``` api_app_name = import_object(f"{plugin}.api.urls.app_name") ``` to ``` api_app_name = f'{app_config.name}-api' ``` This actually raises another point: the full URL name for a plugin API endpoint is currently in the format `plugins-api:myplugin-api:url-name`, which seems a bit unwieldy: `plugins-api:myplugin:url-name` should suffice. However, this would be a breaking change for any plugins which rely on reverse URL resolution to their REST API endpoints.
adam added the type: bugstatus: accepted labels 2025-12-29 18:33:59 +01:00
adam closed this issue 2025-12-29 18:33:59 +01:00
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 status: accepted type: bug
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#4227
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?