Skip to content

PR #13387 broke the documented get_plugin_config method as it is documented #13516

@kkthxbye-code

Description

@kkthxbye-code

Change Type

Correction

Area

Plugins

Proposed Changes

Not sure if this should be a bug report or a documentation change, as I'm not sure what the intention was. PR #13387 moved get_plugin_config from extras.plugins to extras.plugins.util. This seems like an undocumented backwards incompatible change to the plugin API. It broke netbox-napalm for instance:

netbox-community/netbox-napalm-plugin#16

The change should either be rolled back or the documentation should be changed here:

!!! tip "Accessing Config Parameters"
Plugin configuration parameters can be accessed using the `get_plugin_config()` function. For example:
```python
from extras.plugins import get_plugin_config
get_plugin_config('my_plugin', 'verbose_name')
```

If the change is to stay, we should edit the release notes on github for 3.5.8 indicating that there's a BC break.

Metadata

Metadata

Assignees

Labels

severity: mediumResults in substantial degraded or broken functionality for specfic workflowstype: bugA confirmed report of unexpected behavior in the application

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions