search

opnsense / core

OPNsense GUI, API and systems backend
https://opnsense.org/
BSD 2-Clause "Simplified" License
3.33k stars 747 forks source link

Allow changing description string in Interfaces > Assignments #8017

Open mvglasow opened 5 days ago

mvglasow commented 5 days ago

Important notices

Before you add a new report, we ask you kindly to acknowledge the following:

Is your feature request related to a problem? Please describe.

As my OPNsense configuration evolves, the original description given in Interface assignments may no longer be correct. However, I cannot change it without removing the assignment and recreating it (which I am reluctant to do, because I don’t know if any references to that interface will still be correct after that).

Describe the solution you like

I would like an edit button in the list of assigned interfaces, which lets me change the description without removing/recreating the assignment.

Describe alternatives you considered

So far, the hackish workaround is to download the configuration, doctor it in a text editor (altering the strings as needed) and reimport it – not very elegant.

Additional context

The description is widely used throughout the GUI, therefore it is desirable to keep it up to date. On the other hand, internal references are by interface name (optXX), therefore the string would need to be changed in only one place. Issues may occur only if parts of the UI cache the string – this would need to be investigated if (and where) that happens, and the cache invalidated if the string changes.

AdSchellevis commented 5 days ago

I think this https://github.com/opnsense/core/issues/7522 ticket is quite similar, assuming you don't mean the description (which can be changed from the interface), but the technical name.

mvglasow commented 5 days ago

I mean the string that appears in Interfaces > Assignments, in the Interface column (LAN or the like, not opt1). Thanks to your comment, I just found it can be changed by navigating to Interfaces > [LAN] (replace with the interface description), but the Assignments list doesn’t provide a clue that this can be changed (it makes it look like it can’t).

Good to know the functionality is there, but UX could be improved. How about an edit button for every entry in Interfaces > Assignments, next to the delete button, which then takes you straight to Interfaces > [<description>]?

AdSchellevis commented 5 days ago

I'm not too enthusiastic about changing things in these legacy pages if the functionality is already available, risk of regressions usually doesn't outweigh the gain in usability.

mvglasow commented 5 days ago

Legacy? What is the recommended replacement for Interfaces > Assignments?

AdSchellevis commented 5 days ago

there is no replacement, but if we will probably replace it someday, as we did for a most of the legacy pages (in the browser ending at .php).