Migrating v2.x to v3.0¶

Most migrations outside of the UI updates are minimal. However, for completeness, we will review the UI changes and several niche changes that may affect your app.

UI Migrations¶

Nautobot v3.0 introduces many modernizations and improvements to building user interfaces. Although we did our best to make the migration as smooth as possible for app developers, we were not able to avoid some of the breaking changes. Below is a list of guides explaining how to upgrade respective UI parts.

Overall, there are three pillars of v3.0 UI:

Remember to follow our UI Best Practices.

Data Validation Engine¶

Tip

You can safely skip this section if you do not reference DataComplianceRule or ComplianceError in your code.

The Data Compliance feature set from the Data Validation Engine App has been moved directly into core. Import paths that reference nautobot_data_validation_engine.custom_validators.DataComplianceRule or nautobot_data_validation_engine.custom_validators.ComplianceError should be updated to nautobot.apps.models.DataComplianceRule and nautobot.apps.models.ComplianceError, respectively.

GraphQL¶

Tip

You can safely skip this section if you do not reference execute_query or execute_saved_query in your code.

Code that calls the GraphQL execute_query() and execute_saved_query() functions may need to be updated to account for changes to the response object returned by these APIs. Specifically, the response.to_dict() method is no longer supported, but instead the returned data and any errors encountered may now be accessed directly as response.data and response.errors respectively.