NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-22 23:46:44 -06:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Jeremy Stretch 2023-11-16 10:47:33 -05:00
parent 5a2a3e3705
commit 455ca26b8c
2 changed files with 29 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/customization/custom-fields.md
View File

@ -40,14 +40,22 @@ Related custom fields can be grouped together within the UI by assigning each th
This parameter has no effect on the API representation of custom field data. This parameter has no effect on the API representation of custom field data.
### Visibility ### Visibility & Editing
When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI. !!! info "This feature was improved in NetBox v3.7."
* **Read/write** (default): The custom field is included when viewing and editing objects. When creating a custom field, users can control the conditions under which it may be displayed and edited within the NetBox user interface. The following choices are available for controlling the display of a custom field on an object:
* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.)
* **Always** (default): The custom field is included when viewing an object.
* **If Set**: The custom field is included only if a value has been defined for the object.
* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. * **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users.
Additionally, the following options are available for controlling whether custom field values can be altered within the NetBox UI:
* **Yes** (default): The custom field's value may be modified when editing an object.
* **No**: The custom field is displayed for reference when editing an object, but its value may not be modified.
* **Hidden**: The custom field is not displayed when editing an object.
Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API. Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API.
### Validation ### Validation

25
docs/models/extras/customfield.md
View File

@ -64,16 +64,25 @@ Defines how filters are evaluated against custom field values.
| Loose | Match any occurrence of the value | | Loose | Match any occurrence of the value |
| Exact | Match only the complete field value | | Exact | Match only the complete field value |
### UI Visibility ### UI Visible
Controls how and whether the custom field is displayed within the NetBox user interface. Controls whether the custom field is displayed for objects within the NetBox user interface.
| Option | Description | | Option | Description |
|-------------------|--------------------------------------------------| |--------|----------------------------------------------------------------|
| Read/write | Display and permit editing (default) | | Always | The field is always displayed when viewing an object (default) |
| Read-only | Display field but disallow editing | | If set | The field is displayed only if a value has been defined |
| Hidden | Do not display field in the UI | | Hidden | The field is not displayed when viewing an object |
| Hidden (if unset) | Display in the UI only when a value has been set |
### UI Editable
Controls whether the custom field is editable on objects within the NetBox user interface.
| Option | Description |
|--------|------------------------------------------------------------------------------|
| Yes | The field's value may be changed when editing an object (default) |
| No | The field's value is displayed when editing an object but may not be altered |
| Hidden | The field is not displayed when editing an object |
### Default ### Default