Clean up v3.4 release notes

docs/release-notes/version-3.4.md

@@ -1,49 +1,23 @@
 # NetBox v3.4
 
-## v3.4-beta2 (FUTURE)
-
-### Enhancements
-
-* [#815](https://github.com/netbox-community/netbox/issues/815) - Enable specifying terminations when bulk importing circuits
-* [#10371](https://github.com/netbox-community/netbox/issues/10371) - Add operational status field for modules
-* [#10675](https://github.com/netbox-community/netbox/issues/10675) - Add `max_weight` field to track maximum load capacity for racks
-* [#10945](https://github.com/netbox-community/netbox/issues/10945) - Enabled recurring execution of scheduled reports & scripts
-* [#11090](https://github.com/netbox-community/netbox/issues/11090) - Add regular expression support to global search engine
-* [#11022](https://github.com/netbox-community/netbox/issues/11022) - Introduce `QUEUE_MAPPINGS` configuration parameter to allow customization of background task prioritization
-
-### Bug Fixes
-
-* [#10946](https://github.com/netbox-community/netbox/issues/10946) - Fix AttributeError exception when viewing a device with a primary IP and no platform assigned
-* [#10948](https://github.com/netbox-community/netbox/issues/10948) - Linkify primary IPs for VDCs
-* [#10950](https://github.com/netbox-community/netbox/issues/10950) - Fix validation of VDC primary IPs
-* [#10957](https://github.com/netbox-community/netbox/issues/10957) - Add missing VDCs column to interface tables
-* [#10973](https://github.com/netbox-community/netbox/issues/10973) - Fix device links in VDC table
-* [#10980](https://github.com/netbox-community/netbox/issues/10980) - Fix view tabs for plugin objects
-* [#10982](https://github.com/netbox-community/netbox/issues/10982) - Catch `NoReverseMatch` exception when rendering tabs with no registered URL
-* [#10984](https://github.com/netbox-community/netbox/issues/10984) - Fix navigation menu expansion for plugin menus comprising multiple words
-* [#11000](https://github.com/netbox-community/netbox/issues/11000) - Improve validation of YAML-formatted import data
-* [#11046](https://github.com/netbox-community/netbox/issues/11046) - Fix exception when caching very large field values for search
-* [#11154](https://github.com/netbox-community/netbox/issues/11154) - Index VM interface MAC address and MTU for global search
-
-## v3.4-beta1 (2022-11-16)
+## v3.4.0 (FUTURE)
 
 !!! warning "PostgreSQL 11 Required"
     NetBox v3.4 requires PostgreSQL 11 or later.
 
 ### Breaking Changes
 
-* Device and virtual machine names are no longer case-sensitive. Attempting to create e.g. "device1" and "DEVICE1" will raise a validation error.
-* The `asn` field has been removed from the provider model. Please replicate any provider ASN assignments to the ASN model introduced in NetBox v3.1 prior to upgrading.
-* The `noc_contact`, `admin_contact`, and `portal_url` fields have been removed from the provider model. Please replicate any data remaining in these fields to the contact model introduced in NetBox v3.1 prior to upgrading.
-* The `content_type` field on the CustomLink and ExportTemplate models have been renamed to `content_types` and now supports the assignment of multiple content types.
-* The `cf` property on an object with custom fields now returns deserialized values. For example, a custom field referencing an object will return the object instance rather than its numeric ID. To access the raw serialized values, use `custom_field_data` instead.
+* Device and virtual machine names are no longer case-sensitive. Attempting to create e.g. "device1" and "DEVICE1" within the same site will raise a validation error.
+* The `asn`, `noc_contact`, `admin_contact`, and `portal_url` fields have been removed from the provider model. Please replicate any data remaining in these fields to the ASN and contact models introduced in NetBox v3.1 prior to upgrading.
+* The `content_type` fields on the CustomLink and ExportTemplate models have been renamed to `content_types` and now support the assignment of multiple content types per object.
+* Within the Python API, the `cf` property on an object with custom fields now returns deserialized values. For example, a custom field referencing an object will return the object instance rather than its numeric ID. To access the raw serialized values, reference the object's `custom_field_data` attribute instead.
 * The `NetBoxModelCSVForm` class has been renamed to `NetBoxModelImportForm`. Backward compatability with the previous name has been retained for this release, but will be dropped in NetBox v3.5.
 
 ### New Features
 
 #### New Global Search ([#10560](https://github.com/netbox-community/netbox/issues/10560))
 
-NetBox's global search functionality has been completely overhauled and replaced by a new cache-based lookup. This new implementation provides a much speedier, more intelligent search capability. Matches are returned in order of precedence regardless of object type, and matched field values are highlighted in the results. Additionally, custom field values are now included in global search results (when enabled). Plugins can also register their own models with the new global search engine.
+NetBox's global search functionality has been completely overhauled and replaced by a new cache-based lookup. This new implementation provides a much faster, more intelligent search capability. Results are returned in order of precedence regardless of object type, and matching field values are highlighted in the results. Additionally, custom field values are now included in global search results (where enabled). Plugins can also register their own models with the new global search engine.
 
 #### Virtual Device Contexts ([#7854](https://github.com/netbox-community/netbox/issues/7854))
 
@@ -51,19 +25,31 @@ A new model representing virtual device contexts (VDCs) has been added. VDCs are
 
 #### Saved Filters ([#9623](https://github.com/netbox-community/netbox/issues/9623))
 
-Object lists can be filtered by a variety of different fields and characteristics. Applied filters can now be saved for reuse as a convenience. Saved filters can be kept private, or shared among NetBox users.
+Object lists can be filtered by a variety of different fields and characteristics. Applied filters can now be saved for reuse. For example, the query string
+
+```
+?status=active&region_id=12&tenant=acme
+```
+
+can be saved and applied to future queries as
+
+```
+?filter=my-custom-filter
+```
+
+Saved filters can be kept private, or shared among NetBox users. They can be applied to both UI and REST API searches.
 
 ### JSON/YAML Bulk Imports ([#4347](https://github.com/netbox-community/netbox/issues/4347))
 
-NetBox's bulk import feature, which was previously limited to CSV-formatted data for most objects, has been extended to support the import of objects from JSON and/or YAML data as well.
+NetBox's bulk import feature, which was previously limited to CSV-formatted data for most types of objects, has been extended to accept data formatted in JSON or YAML as well. This enables users to directly import objects from a variety of sources without needing to first convert data to CSV.
 
-#### CSV-Based Bulk Updates ([#7961](https://github.com/netbox-community/netbox/issues/7961))
+#### Update Existing Objects via Bulk Import ([#7961](https://github.com/netbox-community/netbox/issues/7961))
 
 NetBox's CSV-based bulk import functionality has been extended to support also modifying existing objects. When an `id` column is present in the import form, it will be used to infer the object to be modified, rather than a new object being created. All fields (columns) are optional when modifying existing objects.
 
 #### Scheduled Reports & Scripts ([#8366](https://github.com/netbox-community/netbox/issues/8366))
 
-Reports and custom scripts can now be scheduled for execution at a desired time.
+Reports and custom scripts can now be scheduled for execution at a desired future time. Background scheduling is handled entirely by the existing RQ workers; there is no need to configure additional tasks to support scheduled jobs. When creating a scheduled job, the user may optionally specify an interval at which the job will run repeatedly (e.g. every 24 hours).
 
 #### API for Staged Changes ([#10851](https://github.com/netbox-community/netbox/issues/10851))
 
@@ -74,6 +60,7 @@ This release introduces a new programmatic API that enables plugins and custom s
 
 ### Enhancements
 
+* [#815](https://github.com/netbox-community/netbox/issues/815) - Enable specifying terminations when bulk importing circuits
 * [#6003](https://github.com/netbox-community/netbox/issues/6003) - Enable the inclusion of custom field values in global search
 * [#7376](https://github.com/netbox-community/netbox/issues/7376) - Enable the assignment of tags during CSV import
 * [#8245](https://github.com/netbox-community/netbox/issues/8245) - Enable GraphQL filtering of related objects
@@ -86,23 +73,39 @@ This release introduces a new programmatic API that enables plugins and custom s
 * [#9817](https://github.com/netbox-community/netbox/issues/9817) - Add `assigned_object` field to GraphQL type for IP addresses and L2VPN terminations
 * [#9832](https://github.com/netbox-community/netbox/issues/9832) - Add `mounting_depth` field to rack model
 * [#9892](https://github.com/netbox-community/netbox/issues/9892) - Add optional `name` field for FHRP groups
-* [#10052](https://github.com/netbox-community/netbox/issues/10052) - The `cf` attribute now returns deserialized custom field data
 * [#10348](https://github.com/netbox-community/netbox/issues/10348) - Add decimal custom field type
+* [#10371](https://github.com/netbox-community/netbox/issues/10371) - Add `status` field for modules
 * [#10545](https://github.com/netbox-community/netbox/issues/10545) - Standardize the use of `description` and `comments` fields on all primary models
 * [#10556](https://github.com/netbox-community/netbox/issues/10556) - Include a `display` field in all GraphQL object types
 * [#10595](https://github.com/netbox-community/netbox/issues/10595) - Add GraphQL relationships for additional generic foreign key fields
+* [#10675](https://github.com/netbox-community/netbox/issues/10675) - Add `max_weight` field to track maximum load capacity for racks
 * [#10698](https://github.com/netbox-community/netbox/issues/10698) - Omit app label from content type in table columns
 * [#10710](https://github.com/netbox-community/netbox/issues/10710) - Add `status` field to WirelessLAN
 * [#10761](https://github.com/netbox-community/netbox/issues/10761) - Enable associating an export template with multiple object types
-* [#10781](https://github.com/netbox-community/netbox/issues/10781) - Add support for Python v3.11
+* [#10945](https://github.com/netbox-community/netbox/issues/10945) - Enable recurring execution of scheduled reports & scripts
+* [#11022](https://github.com/netbox-community/netbox/issues/11022) - Introduce `QUEUE_MAPPINGS` configuration parameter to allow customization of background task prioritization
+
+### Bug Fixes (from v3.4-beta1)
+
+* [#10946](https://github.com/netbox-community/netbox/issues/10946) - Fix AttributeError exception when viewing a device with a primary IP and no platform assigned
+* [#10948](https://github.com/netbox-community/netbox/issues/10948) - Linkify primary IPs for VDCs
+* [#10950](https://github.com/netbox-community/netbox/issues/10950) - Fix validation of VDC primary IPs
+* [#10957](https://github.com/netbox-community/netbox/issues/10957) - Add missing VDCs column to interface tables
+* [#10973](https://github.com/netbox-community/netbox/issues/10973) - Fix device links in VDC table
+* [#10980](https://github.com/netbox-community/netbox/issues/10980) - Fix view tabs for plugin objects
+* [#10982](https://github.com/netbox-community/netbox/issues/10982) - Catch `NoReverseMatch` exception when rendering tabs with no registered URL
+* [#10984](https://github.com/netbox-community/netbox/issues/10984) - Fix navigation menu expansion for plugin menus comprising multiple words
+* [#11000](https://github.com/netbox-community/netbox/issues/11000) - Improve validation of YAML-formatted import data
+* [#11046](https://github.com/netbox-community/netbox/issues/11046) - Fix exception when caching very large field values for search
+* [#11154](https://github.com/netbox-community/netbox/issues/11154) - Index VM interface MAC address and MTU for global search
 
 ### Plugins API
 
-* [#4751](https://github.com/netbox-community/netbox/issues/4751) - Add `plugin_list_buttons` template tag to embed buttons on object lists
+* [#4751](https://github.com/netbox-community/netbox/issues/4751) - Enable embedding custom content on core list views via `list_buttons()` method
 * [#8927](https://github.com/netbox-community/netbox/issues/8927) - Enable inclusion of plugin models in global search via `SearchIndex`
-* [#9071](https://github.com/netbox-community/netbox/issues/9071) - Enable plugins to register top-level navigation menus
+* [#9071](https://github.com/netbox-community/netbox/issues/9071) - Enable plugins to register top-level navigation menus using PluginMenu
 * [#9072](https://github.com/netbox-community/netbox/issues/9072) - Enable registration of tabbed plugin views for core NetBox models
-* [#9880](https://github.com/netbox-community/netbox/issues/9880) - Enable plugins to install and register other Django apps
+* [#9880](https://github.com/netbox-community/netbox/issues/9880) - Enable plugins to install and register other Django apps via `django_apps` attribute
 * [#9887](https://github.com/netbox-community/netbox/issues/9887) - Inspect `docs_url` property to determine link to model documentation
 * [#10314](https://github.com/netbox-community/netbox/issues/10314) - Move `clone()` method from NetBoxModel to CloningMixin
 * [#10543](https://github.com/netbox-community/netbox/issues/10543) - Introduce `get_plugin_config()` utility function
@@ -112,11 +115,13 @@ This release introduces a new programmatic API that enables plugins and custom s
 
 * [#9045](https://github.com/netbox-community/netbox/issues/9045) - Remove legacy ASN field from provider model
 * [#9046](https://github.com/netbox-community/netbox/issues/9046) - Remove legacy contact fields from provider model
+* [#10052](https://github.com/netbox-community/netbox/issues/10052) - The `cf` attribute on objects now returns deserialized custom field data
 * [#10358](https://github.com/netbox-community/netbox/issues/10358) - Raise minimum required PostgreSQL version from 10 to 11
 * [#10694](https://github.com/netbox-community/netbox/issues/10694) - Emit the `post_save` signal when creating device components in bulk
 * [#10697](https://github.com/netbox-community/netbox/issues/10697) - Move application registry into core app
-* [#10699](https://github.com/netbox-community/netbox/issues/10699) - Remove custom `import_object()` function
-* [#10816](https://github.com/netbox-community/netbox/issues/10816) - Pass the current request when instantiating a FilterSet within UI views
+* [#10699](https://github.com/netbox-community/netbox/issues/10699) - Remove unused custom `import_object()` function
+* [#10781](https://github.com/netbox-community/netbox/issues/10781) - Add support for Python v3.11
+* [#10816](https://github.com/netbox-community/netbox/issues/10816) - Pass the current request as context when instantiating a FilterSet within UI views
 * [#10820](https://github.com/netbox-community/netbox/issues/10820) - Switch timezone library from pytz to zoneinfo
 * [#10821](https://github.com/netbox-community/netbox/issues/10821) - Enable data localization
 
@@ -131,43 +136,39 @@ This release introduces a new programmatic API that enables plugins and custom s
 * dcim.Device
     * Added a `description` field
 * dcim.DeviceType
-    * Added a `description` field
-    * Added optional `weight` and `weight_unit` fields
+    * Added `description`, `weight`, and `weight_unit` fields
 * dcim.Module
     * Added a `description` field
 * dcim.Interface
     * Added the `vdcs` field
 * dcim.Module
-    * Added a `status` field
+    * Added a required `status` field
 * dcim.ModuleType
-    * Added a `description` field
-    * Added optional `weight` and `weight_unit` fields
+    * Added `description`, `weight`, and `weight_unit` fields
 * dcim.PowerFeed
     * Added a `description` field
 * dcim.PowerPanel
     * Added `description` and `comments` fields
 * dcim.Rack
-    * Added a `description` field
-    * Added optional `weight`, `max_weight`, and `weight_unit` fields
+    * Added `description`, `mounting_depth`, `weight`, `max_weight`, and `weight_unit` fields
 * dcim.RackReservation
     * Added a `comments` field
 * dcim.VirtualChassis
     * Added `description` and `comments` fields
 * extras.CustomField
-    * Added the `search_weight` field
+    * Added a `search_weight` field
 * extras.CustomLink
     * Renamed `content_type` field to `content_types`
 * extras.ExportTemplate
     * Renamed `content_type` field to `content_types`
 * extras.JobResult
-    * Added `scheduled` and `started` datetime fields
+    * Added `interval`, `scheduled`, and `started` fields
 * ipam.Aggregate
     * Added a `comments` field
 * ipam.ASN
     * Added a `comments` field
 * ipam.FHRPGroup
-    * Added a `comments` field
-    * Added optional `name` field
+    * Added `name` and `comments` fields
 * ipam.IPAddress
     * Added a `comments` field
 * ipam.IPRange