starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-14 06:13:32 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

[PR #12371] [MERGED] Release v3.5.0 #13959

New Issue
Closed
opened 2025-12-29 23:21:45 +01:00 by adam · 0 comments
adam commented 2025-12-29 23:21:45 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/12371
Author: @jeremystretch
Created: 4/27/2023
Status: ✅ Merged
Merged: 4/27/2023
Merged by: @jeremystretch

Base: master ← Head: develop

📝 Commits (10+)

📊 Changes

589 files changed (+179903 additions, -8429 deletions)

View changed files

📝 .github/ISSUE_TEMPLATE/bug_report.yaml (+1 -1)
📝 .github/ISSUE_TEMPLATE/feature_request.yaml (+1 -1)
📝 base_requirements.txt (+21 -6)
➕ contrib/openapi2.json (+95605 -0)
➕ contrib/openapi2.yaml (+69695 -0)
📝 docs/administration/error-reporting.md (+1 -1)
📝 docs/administration/housekeeping.md (+1 -1)
📝 docs/administration/permissions.md (+2 -4)
📝 docs/configuration/default-values.md (+45 -0)
📝 docs/configuration/index.md (+1 -5)
📝 docs/configuration/miscellaneous.md (+5 -3)
➖ docs/configuration/napalm.md (+0 -51)
📝 docs/configuration/required-parameters.md (+2 -4)
📝 docs/configuration/system.md (+8 -0)
📝 docs/customization/custom-fields.md (+1 -6)
📝 docs/customization/custom-links.md (+0 -1)
📝 docs/customization/custom-scripts.md (+5 -6)
📝 docs/customization/reports.md (+4 -2)
📝 docs/development/application-registry.md (+18 -25)
📝 docs/development/models.md (+35 -18)

...and 80 more files

📄 Description

Breaking Changes

  • The account field has been removed from the provider model. This information is now tracked using the new provider account model. Multiple accounts can be assigned per provider.
  • A minimum length of 50 characters is now enforced for the SECRET_KEY configuration parameter.
  • The JobResult model has been moved from the extras app to core and renamed to Job. Accordingly, its REST API endpoint has been moved from /api/extras/job-results/ to /api/core/jobs/.
  • The obj_type field on the Job model (previously JobResult) has been renamed to object_type for consistency with other models.
  • The JOBRESULT_RETENTION configuration parameter has been renamed to JOB_RETENTION.
  • The obj context variable is no longer passed when rendering custom links: Use object instead.
  • The REST API schema is now generated using the OpenAPI 3.0 spec
  • The URLs for the REST API schema documentation have changed:
    • /api/docs/ is now /api/schema/swagger-ui/
    • /api/redoc/ is now /api/schema/redoc/

New Features

Customizable Dashboard (#9416)

The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the information most pertinent to them. Supported widgets include object statistics, configurable object lists, RSS feeds, and notes, and we expect to continue adding new widgets over time.

Remote Data Sources (#11558)

NetBox now has the ability to synchronize arbitrary data from external sources through the new DataSource and DataFile models. Synchronized files are stored in the PostgreSQL database, and may be referenced and consumed by other NetBox models, such as export templates and config contexts. Currently, replication from local filesystem paths, git repositories, and Amazon S3 buckets is supported, and we expect to introduce additional backends in the near future.

Configuration Template Rendering (#11559)

This release introduces the ability to render device configurations from Jinja2 templates natively within NetBox, via both the UI and REST API. The new ConfigTemplate model stores template code (which may be defined locally or sourced from remote data files). The rendering engine passes data gleaned from both config contexts and request parameters to generate complete configurations suitable for direct application to network devices.

NAPALM Integration Plugin (#10520)

The NAPALM integration feature found in previous NetBox releases has been moved from the core application to a dedicated plugin. This allows greater control over the feature's configuration and will unlock additional potential as a separate project.

ASN Ranges (#8550)

A new ASN range model has been introduced to facilitate the provisioning of new autonomous system numbers from within a prescribed range. For example, an administrator might define an ASN range of 65000-65099 to be used for internal site identification. This includes a REST API endpoint suitable for automatic provisioning, very similar to the allocation of available prefixes and IP addresses.

Provider Accounts (#9047)

A new model has been introduced to represent individual accounts within a common circuit provider. This replaces the account field on the provider model, enabling users to track multiple accounts per provider. New provider account instances will be created automatically during upgrade for all providers which currently have an account assigned. The assignment of individual circuits to a provider account remains optional.

Job-Triggered Webhooks (#8958)

Two new webhook trigger events have been introduced: job_start and job_end. These enable users to configure webhook to trigger when a background job starts or ends, respectively. This new functionality can be used, for example, to inform a remote system when a custom script has been executed.

Enhancements

  • #7947 - Enable marking IP ranges as fully utilized
  • #8184 - Employ HTMX to dynamically render tables listing related objects
  • #8272 - Support bridge relationships among device type interfaces
  • #8749 - Support replicating custom field values when cloning an object
  • #9073 - Enable syncing config context data from remote sources
  • #9653 - Enable setting a default platform for device types
  • #10054 - Introduce advanced object selector for UI forms
  • #10242 - Redirect to filtered objects list after bulk import
  • #10374 - Require unique tenant names & slugs per group
  • #10729 - Add date & time custom field type
  • #11029 - Enable change logging for cable terminations
  • #11254 - Introduce the X-Request-ID HTTP header to annotate the unique ID of each request for change logging
  • #11255 - Introduce the scheduling_enabled settings for reports & scripts
  • #11291 - Optimized GraphQL API request handling
  • #11440 - Add an enabled field for device type interfaces
  • #11494 - Enable filtering objects by create/update request IDs
  • #11517 - Standardize the inclusion of related objects across the entire UI
  • #11584 - Add a list view for contact assignments
  • #11625 - Add HTMX support to ObjectEditView
  • #11693 - Enable syncing export template content from remote sources
  • #11780 - Enable loading import data from remote sources
  • #11790 - Create database indexes for all generic foreign keys
  • #11968 - Add navigation menu buttons to create device & VM components
  • #12068 - Enable generic foreign key relationships from jobs to NetBox objects
  • #12085 - Add a file source view for reports
  • #12218 - Provide more relevant API endpoint descriptions in schema
  • #12343 - Enforce a minimum length for SECRET_KEY configuration parameter

Bug Fixes (From Beta2)

  • #12149 - Fix OpenAPI schema warnings relating to enum collisions
  • #12195 - Fix exception when setting IP address role to null via REST API
  • #12256 - Fix OpenAPI schema warnings relating to nested serializers
  • #12278 - Fix schema warnings related to IPAddressField
  • #12288 - Include servers definition in OpenAPI spec
  • #12299 - Fix object list widget support for filtering by multiple values

Other Changes

  • #9608 - Upgrade REST API schema to OpenAPI 3.0
  • #10604 - Remove unused extra_tabs block from object.html generic template
  • #10923 - Remove unused NetBoxModelCSVForm class (replaced by NetBoxModelImportForm)
  • #11489 - Consolidated several middleware classes
  • #11611 - Refactor API viewset classes and introduce NetBoxReadOnlyModelViewSet
  • #11694 - Remove obsolete SmallTextarea form widget
  • #11737 - ChangeLoggedModel now inherits WebhooksMixin
  • #11765 - Retire the StaticSelect and StaticSelectMultiple form widgets
  • #11955 - Remove the unused CSVDataField and CSVFileField classes
  • #12067 - Move & rename extras.JobResult to core.Job

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/12371 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 4/27/2023 **Status:** ✅ Merged **Merged:** 4/27/2023 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `master` ← **Head:** `develop` --- ### 📝 Commits (10+) - [`e19ce69`](https://github.com/netbox-community/netbox/commit/e19ce692388c2242ad271dfe2e85b269d7101d31) Closes #10923: Remove unused NetBoxModelCSVForm class - [`2381317`](https://github.com/netbox-community/netbox/commit/2381317eb32beef69703d7c67fa3a76896390ad5) Closes #10604: Remove unused extra_tabs block from object.html generic template - [`0b4ea14`](https://github.com/netbox-community/netbox/commit/0b4ea14e9ad8bf286d7b9d94057881d6a58483ce) Closes #11489: Refactor & combine core middleware - [`ef3ac25`](https://github.com/netbox-community/netbox/commit/ef3ac25406947b502d3a6a92c050200de6bcf7a6) Remove old feature version notices - [`f74a253`](https://github.com/netbox-community/netbox/commit/f74a2536f1ca24dd8984c7bff7b386244c29f8a7) Closes #11254: Introduce the X-Request-ID HTTP header to annotate the unique ID of each request for change logging - [`1a2dae3`](https://github.com/netbox-community/netbox/commit/1a2dae3471c4c7102339175f352c4c94efec10f9) Closes #8184: Enable HTMX for embedded tables (#11518) - [`8e94eb6`](https://github.com/netbox-community/netbox/commit/8e94eb67d23a93a05892a2167733ccbeda6d4b65) Add the `enabled` filed to InterfaceTemplate - [`48d6d72`](https://github.com/netbox-community/netbox/commit/48d6d7279d8d0fdbb6f053dfb45dd0e3c4e244b0) Changelog for #11440 - [`0c9e7aa`](https://github.com/netbox-community/netbox/commit/0c9e7aa074f82f7871c8304b9846ea88524b4362) Clean up related objects for sites, tenants - [`91b81d5`](https://github.com/netbox-community/netbox/commit/91b81d51da683140ae98e393356079a7eea49608) Standardize related model display for nested models ### 📊 Changes **589 files changed** (+179903 additions, -8429 deletions) <details> <summary>View changed files</summary> 📝 `.github/ISSUE_TEMPLATE/bug_report.yaml` (+1 -1) 📝 `.github/ISSUE_TEMPLATE/feature_request.yaml` (+1 -1) 📝 `base_requirements.txt` (+21 -6) ➕ `contrib/openapi2.json` (+95605 -0) ➕ `contrib/openapi2.yaml` (+69695 -0) 📝 `docs/administration/error-reporting.md` (+1 -1) 📝 `docs/administration/housekeeping.md` (+1 -1) 📝 `docs/administration/permissions.md` (+2 -4) 📝 `docs/configuration/default-values.md` (+45 -0) 📝 `docs/configuration/index.md` (+1 -5) 📝 `docs/configuration/miscellaneous.md` (+5 -3) ➖ `docs/configuration/napalm.md` (+0 -51) 📝 `docs/configuration/required-parameters.md` (+2 -4) 📝 `docs/configuration/system.md` (+8 -0) 📝 `docs/customization/custom-fields.md` (+1 -6) 📝 `docs/customization/custom-links.md` (+0 -1) 📝 `docs/customization/custom-scripts.md` (+5 -6) 📝 `docs/customization/reports.md` (+4 -2) 📝 `docs/development/application-registry.md` (+18 -25) 📝 `docs/development/models.md` (+35 -18) _...and 80 more files_ </details> ### 📄 Description ### Breaking Changes * The `account` field has been removed from the provider model. This information is now tracked using the new provider account model. Multiple accounts can be assigned per provider. * A minimum length of 50 characters is now enforced for the `SECRET_KEY` configuration parameter. * The JobResult model has been moved from the `extras` app to `core` and renamed to Job. Accordingly, its REST API endpoint has been moved from `/api/extras/job-results/` to `/api/core/jobs/`. * The `obj_type` field on the Job model (previously JobResult) has been renamed to `object_type` for consistency with other models. * The `JOBRESULT_RETENTION` configuration parameter has been renamed to `JOB_RETENTION`. * The `obj` context variable is no longer passed when rendering custom links: Use `object` instead. * The REST API schema is now generated using the OpenAPI 3.0 spec * The URLs for the REST API schema documentation have changed: * `/api/docs/` is now `/api/schema/swagger-ui/` * `/api/redoc/` is now `/api/schema/redoc/` ### New Features #### Customizable Dashboard ([#9416](https://github.com/netbox-community/netbox/issues/9416)) The static home view has been replaced with a fully customizable dashboard. Users can construct and rearrange their own personal dashboard to convey the information most pertinent to them. Supported widgets include object statistics, configurable object lists, RSS feeds, and notes, and we expect to continue adding new widgets over time. #### Remote Data Sources ([#11558](https://github.com/netbox-community/netbox/issues/11558)) NetBox now has the ability to synchronize arbitrary data from external sources through the new [DataSource](../models/core/datasource.md) and [DataFile](../models/core/datafile.md) models. Synchronized files are stored in the PostgreSQL database, and may be referenced and consumed by other NetBox models, such as export templates and config contexts. Currently, replication from local filesystem paths, git repositories, and Amazon S3 buckets is supported, and we expect to introduce additional backends in the near future. #### Configuration Template Rendering ([#11559](https://github.com/netbox-community/netbox/issues/11559)) This release introduces the ability to render device configurations from Jinja2 templates natively within NetBox, via both the UI and REST API. The new [ConfigTemplate](../models/extras/configtemplate.md) model stores template code (which may be defined locally or sourced from remote data files). The rendering engine passes data gleaned from both config contexts and request parameters to generate complete configurations suitable for direct application to network devices. #### NAPALM Integration Plugin ([#10520](https://github.com/netbox-community/netbox/issues/10520)) The NAPALM integration feature found in previous NetBox releases has been moved from the core application to a [dedicated plugin](https://github.com/netbox-community/netbox-napalm). This allows greater control over the feature's configuration and will unlock additional potential as a separate project. #### ASN Ranges ([#8550](https://github.com/netbox-community/netbox/issues/8550)) A new ASN range model has been introduced to facilitate the provisioning of new autonomous system numbers from within a prescribed range. For example, an administrator might define an ASN range of 65000-65099 to be used for internal site identification. This includes a REST API endpoint suitable for automatic provisioning, very similar to the allocation of available prefixes and IP addresses. #### Provider Accounts ([#9047](https://github.com/netbox-community/netbox/issues/9047)) A new model has been introduced to represent individual accounts within a common circuit provider. This replaces the `account` field on the provider model, enabling users to track multiple accounts per provider. New provider account instances will be created automatically during upgrade for all providers which currently have an account assigned. The assignment of individual circuits to a provider account remains optional. #### Job-Triggered Webhooks ([#8958](https://github.com/netbox-community/netbox/issues/8958)) Two new webhook trigger events have been introduced: `job_start` and `job_end`. These enable users to configure webhook to trigger when a background job starts or ends, respectively. This new functionality can be used, for example, to inform a remote system when a custom script has been executed. ### Enhancements * [#7947](https://github.com/netbox-community/netbox/issues/7947) - Enable marking IP ranges as fully utilized * [#8184](https://github.com/netbox-community/netbox/issues/8184) - Employ HTMX to dynamically render tables listing related objects * [#8272](https://github.com/netbox-community/netbox/issues/8272) - Support bridge relationships among device type interfaces * [#8749](https://github.com/netbox-community/netbox/issues/8749) - Support replicating custom field values when cloning an object * [#9073](https://github.com/netbox-community/netbox/issues/9073) - Enable syncing config context data from remote sources * [#9653](https://github.com/netbox-community/netbox/issues/9653) - Enable setting a default platform for device types * [#10054](https://github.com/netbox-community/netbox/issues/10054) - Introduce advanced object selector for UI forms * [#10242](https://github.com/netbox-community/netbox/issues/10242) - Redirect to filtered objects list after bulk import * [#10374](https://github.com/netbox-community/netbox/issues/10374) - Require unique tenant names & slugs per group * [#10729](https://github.com/netbox-community/netbox/issues/10729) - Add date & time custom field type * [#11029](https://github.com/netbox-community/netbox/issues/11029) - Enable change logging for cable terminations * [#11254](https://github.com/netbox-community/netbox/issues/11254) - Introduce the `X-Request-ID` HTTP header to annotate the unique ID of each request for change logging * [#11255](https://github.com/netbox-community/netbox/issues/11255) - Introduce the `scheduling_enabled` settings for reports & scripts * [#11291](https://github.com/netbox-community/netbox/issues/11291) - Optimized GraphQL API request handling * [#11440](https://github.com/netbox-community/netbox/issues/11440) - Add an `enabled` field for device type interfaces * [#11494](https://github.com/netbox-community/netbox/issues/11494) - Enable filtering objects by create/update request IDs * [#11517](https://github.com/netbox-community/netbox/issues/11517) - Standardize the inclusion of related objects across the entire UI * [#11584](https://github.com/netbox-community/netbox/issues/11584) - Add a list view for contact assignments * [#11625](https://github.com/netbox-community/netbox/issues/11625) - Add HTMX support to ObjectEditView * [#11693](https://github.com/netbox-community/netbox/issues/11693) - Enable syncing export template content from remote sources * [#11780](https://github.com/netbox-community/netbox/issues/11780) - Enable loading import data from remote sources * [#11790](https://github.com/netbox-community/netbox/issues/11790) - Create database indexes for all generic foreign keys * [#11968](https://github.com/netbox-community/netbox/issues/11968) - Add navigation menu buttons to create device & VM components * [#12068](https://github.com/netbox-community/netbox/issues/12068) - Enable generic foreign key relationships from jobs to NetBox objects * [#12085](https://github.com/netbox-community/netbox/issues/12085) - Add a file source view for reports * [#12218](https://github.com/netbox-community/netbox/issues/12218) - Provide more relevant API endpoint descriptions in schema * [#12343](https://github.com/netbox-community/netbox/issues/12343) - Enforce a minimum length for `SECRET_KEY` configuration parameter ### Bug Fixes (From Beta2) * [#12149](https://github.com/netbox-community/netbox/issues/12149) - Fix OpenAPI schema warnings relating to enum collisions * [#12195](https://github.com/netbox-community/netbox/issues/12195) - Fix exception when setting IP address role to null via REST API * [#12256](https://github.com/netbox-community/netbox/issues/12256) - Fix OpenAPI schema warnings relating to nested serializers * [#12278](https://github.com/netbox-community/netbox/issues/12278) - Fix schema warnings related to IPAddressField * [#12288](https://github.com/netbox-community/netbox/issues/12288) - Include `servers` definition in OpenAPI spec * [#12299](https://github.com/netbox-community/netbox/issues/12299) - Fix object list widget support for filtering by multiple values ### Other Changes * [#9608](https://github.com/netbox-community/netbox/issues/9608) - Upgrade REST API schema to OpenAPI 3.0 * [#10604](https://github.com/netbox-community/netbox/issues/10604) - Remove unused `extra_tabs` block from `object.html` generic template * [#10923](https://github.com/netbox-community/netbox/issues/10923) - Remove unused `NetBoxModelCSVForm` class (replaced by `NetBoxModelImportForm`) * [#11489](https://github.com/netbox-community/netbox/issues/11489) - Consolidated several middleware classes * [#11611](https://github.com/netbox-community/netbox/issues/11611) - Refactor API viewset classes and introduce NetBoxReadOnlyModelViewSet * [#11694](https://github.com/netbox-community/netbox/issues/11694) - Remove obsolete `SmallTextarea` form widget * [#11737](https://github.com/netbox-community/netbox/issues/11737) - `ChangeLoggedModel` now inherits `WebhooksMixin` * [#11765](https://github.com/netbox-community/netbox/issues/11765) - Retire the `StaticSelect` and `StaticSelectMultiple` form widgets * [#11955](https://github.com/netbox-community/netbox/issues/11955) - Remove the unused `CSVDataField` and `CSVFileField` classes * [#12067](https://github.com/netbox-community/netbox/issues/12067) - Move & rename `extras.JobResult` to `core.Job` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 23:21:45 +01:00
adam closed this issue 2025-12-29 23:21:46 +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 pull-request
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#13959
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?