nautobot 2.0.4__py3-none-any.whl → 2.1.0b1__py3-none-any.whl

nautobot/docs/development/apps/api/views/nautobotuiviewset.md

@@ -1,147 +0,0 @@
-# NautobotUIViewSet
-
-+++ 1.4.0
-
-New in Nautobot 1.4 is the debut of `NautobotUIViewSet`: A powerful app development tool that can save app developer hundreds of lines of code compared to using legacy `generic.views`. Using it to gain access to default functionalities previous provided by `generic.views` such as `create()`, `bulk_create()`, `update()`, `partial_update()`, `bulk_update()`, `destroy()`, `bulk_destroy()`, `retrieve()` and `list()` actions.
-
-Note that this ViewSet is catered specifically to the UI, not the API.
-
-Concrete examples on how to use `NautobotUIViewSet` resides in `nautobot.circuits.views`.
-
-Below we provide an example on how to use `NautobotUIViewSet` on a theoretical app model.
-
-```python
-from nautobot.apps.views import NautobotUIViewSet
-from yourapp import filters, forms, models, tables
-from yourapp.api import serializers
-
-class YourAppModelUIViewSet(NautobotUIViewSet):
-    bulk_update_form_class = forms.YourAppModelBulkEditForm
-    filterset_class = filters.YourAppModelFilterSet
-    filterset_form_class = forms.YourAppModelFilterForm
-    form_class = forms.YourAppModelForm
-    queryset = models.YourAppModel.objects.all()
-    serializer_class = serializers.YourAppModelSerializer
-    table_class = tables.YourAppModelTable
-```
-
-## Setting ViewSet Attributes
-
-**One caveat of using the NautobotUIViewSet is that the `queryset`, `serializer_class` and `table_class` attribute of the `YourAppModelUIViewSet` has to be set before most of the `NautobotUIViewSet` functionalities will become available.**
-
-By default the URL patterns generated by a `NautobotUIViewSet` are based on the model's `pk` (`/model-name/<pk>/` for the detail view, `/model-name/<pk>/edit/` for the edit view, etc.). if you need to use a different field to look up an object, just override the default `lookup_field` in your ViewSet attributes:
-
-```python
-from nautobot.apps.views import NautobotUIViewSet
-
-class YourAppModelUIViewSet(NautobotUIViewSet):
-    ...
-    lookup_field = "slug"
-    ...
-```
-
-+/- 2.0.0
-    The default `lookup_field` for `NautobotUIViewSet` has been changed from `"slug"` to `"pk"`.
-
-!!! note
-    Using a field other than the default `pk` or the alternative field `slug` (as shown in the example above), may result in certain pieces of the UI not displaying (for example, the edit and delete buttons on the object detail view). This is due to the URL expecting a named key of slug or pk, rather than id.
-
-## View Template Context
-
-Templates can benefit from a very rich context passed down from the views and renderer, including forms, tables, as well as any other information that may be helpful for rendering templates. The keys it provides are as follows:
-
-* `content_type`: The ContentType object for the associated model
-* `filter_form`: The FilterForm object for the associated model
-* `form`: A Form object for the associated model if relevant (`None` for list and detail/retrieve views)
-* `object`: An instance of the associated mode if available (`None` for list and bulk operation views)
-* `permissions`: Summary of user permissions for the given model
-* `return_url`: The relevant return URL
-* `table`: A Table object for the associated model if relevant (`None` for detail/retrieve and update views)
-* `table_config_form`: A TableConfigForm object for the associated `table`, providing the ability to customize the table
-* `verbose_name`: The singular form of the model's name
-* `verbose_name_plural`: The plural form of the model's name
-
-An example from editing a Provider object:
-
-```python
-{
-    'content_type': <ContentType: circuits | provider>,
-    'filter_form': <ProviderFilterForm bound=True, valid=Unknown, fields=(location;q;asn;tag)>,
-    'form': <ProviderForm bound=False, valid=Unknown, fields=(name;asn;account;portal_url;noc_contact;admin_contact;comments;tags;object_note)>,
-    'object': <Provider: NautobotProvider>,
-    'permissions': {'add': True, 'change': True, 'delete': True, 'view': True},
-    'return_url': '/circuits/providers/nautobotprovider',
-    'table': None,
-    'table_config_form': None,
-    'verbose_name': 'provider',
-    'verbose_name_plural': 'providers'
-}
-```
-
-Other context keys may be available for certain views:
-
-* `editing`: Provided for create and update views to help the template determine if this is a new or existing object
-* `action_buttons`: Provided for the list view for the top of table buttons (such as "Add" and "Export")
-
-You may see other context keys as well, but any not documented above should not be relied upon as they may be removed in a future release. Some examples of those are:
-
-* `obj`: Please use `object` instead
-* `obj_type`: Please use `verbose_name` instead
-* `obj_type_plural`: Please use `verbose_name_plural` instead
-
---- 2.0.0
-    The `changelog_url` context key was removed. Use `object.get_changelog_url` instead.
-
-## Excluding ViewMixins from NautobotUIViewSet
-
-For app models that do not require certain views, simply inherit directly from the `ViewMixin` classes available in `nautobot.apps.views` instead of `NautobotUIViewSet`.
-
-Concrete examples for excluding `ViewMixins`, checkout `CircuitTerminationUIViewSet` and `CircuitTypeUIViewSet` in `nautobot.circuits.views`.
-
-```python
-## An app model viewset that does not support bulk views and operations
-import nautobot.apps.views
-
-class YourAppModelUIViewSet(
-    nautobot.apps.views.ObjectListViewMixin,
-    nautobot.apps.views.ObjectDetailViewMixin,
-    nautobot.apps.views.ObjectEditViewMixin,
-    nautobot.apps.views.ObjectDestroyViewMixin,
-):
-
-    filterset_class = YourAppModelFilterSet
-    filterset_form_class = YourAppModelFilterForm
-    form_class = YourAppModelForm
-    queryset = YourAppModel.objects.all()
-    serializer_class = serializers.YourAppModelSerializer
-    table_class = YourAppModelTable
-    # You do not need to specify attributes that are not needed.
-```
-
-Excluding unwanted urls from `NautobotUIViewSetRouter` is done for you at the ViewSet level. If you do not inherit the unwanted ViewMixins, the corresponding route from the router will not be published.
-
-```python
-# urls.py
-# All the urls correspond to BulkViewMixins will not be published when you register your ViewSet with the router.
-router.register("yourappmodel", views.YourAppModelUIViewSet)
-```
-
-## Template Naming for NautobotUIViewSet
-
-Template naming is very intuitive in NautobotUIViewSet. In `templates/yourapp` folder, name your templates following the convention `{model_name}_{action}.html`.
-
-| ViewMixins                 | action       |
-| -------------------------- |:------------:|
-| ObjectListViewMixin        | list         |
-| ObjectDetailViewMixin      | retrieve     |
-| ObjectEditViewMixin        | create/update|
-| ObjectDestroyViewMixin     | destroy      |
-| ObjectBulkDestroyViewMixin | bulk_destroy |
-| ObjectBulkCreateViewMixin  | bulk_create  |
-| ObjectBulkUpdateViewMixin  | bulk_update  |
-
-For example, for a DetailView template for `YourAppModel`, the template name will be `yourapp/yourappmodel_retrieve.html`, for a BulkCreateView template for `yourappmodel`, the template name will be `yourapp/yourappmodel_bulk_create.html` and etc.
-
-If you do not provide your own templates in the `yourapp/templates/yourapp` folder, `NautobotUIViewSet` will fall back to `generic/object_{self.action}.html`.
-
-Since in many cases the `create` and `update` templates for a model will be identical, you are not required to create both. If you provide a `{app_label}/{model_opts.model_name}_create.html` file but not a `{app_label}/{model_opts.model_name}_update.html` file, then when you update an object, it will fall back to `{app_label}/{model_opts.model_name}_create.html` and vice versa.

nautobot/docs/development/apps/api/views/nautobotuiviewsetrouter.md

@@ -1,41 +0,0 @@
-# NautobotUIViewSetRouter
-
-With `NautobotUIViewSet` as the base UI ViewSet for `YourAppModel`, it is required to register your urls with the help of `NautobotUIViewSetRouter`.
-
-For a concrete example on how to use `NautobotUIViewSetRouter`, see `nautobot.circuits.urls`.
-
-Below is a theoretical `urls.py` file for `YourAppModel`:
-
-```python
-from django.urls import path
-
-from nautobot.apps.urls import NautobotUIViewSetRouter
-from your_app import views
-
-
-router = NautobotUIViewSetRouter()
-router.register("yourappmodel", views.YourAppModelUIViewSet)
-
-urlpatterns = [
-    # Extra urls that do not follow the patterns of `NautobotUIViewSetRouter` go here.
-    # changelog, notes and etc.
-    ...
-    path(
-        "yourappmodels/<uuid:pk>/changelog/",
-        ObjectChangeLogView.as_view(),
-        name="yourappmodel_changelog",
-        kwargs={"model": yourappmodel},
-    ),
-    path(
-        "yourappmodels/<uuid:pk>/notes/",
-        ObjectNotesView.as_view(),
-        name="yourappmodel_notes",
-        kwargs={"model": yourappmodel},
-    ),
-    ...
-]
-urlpatterns += router.urls
-```
-
-+++ 1.5.1
-    Changelog and Notes views and URLs are now provided in the NautobotUIViewSet and NautobotUIViewSetRouter.

nautobot/docs/development/apps/api/views/notes.md

@@ -1,25 +0,0 @@
-# Note URL Endpoint
-
-+++ 1.4.0
-
-Models that inherit from `PrimaryModel` and `OrganizationalModel` can have notes associated. In order to utilize this new feature you will need to add the endpoint to `urls.py`. Here is an option to be able to support both 1.4+ and older versions of Nautobot:
-
-```python
-
-urlpatterns = [
-    path('random/', views.RandomAnimalView.as_view(), name='random_animal'),
-]
-
-try:
-    from nautobot.extras.views import ObjectNotesView
-    urlpatterns.append(
-        path(
-            'random/<uuid:pk>/notes/),
-            ObjectNotesView.as_view(),
-            name="random_notes",
-            kwargs={"model": Random},
-        )
-    )
-except ImportError:
-    pass
-```

nautobot/docs/development/apps/api/views/rest-api.md

@@ -1,64 +0,0 @@
-# Adding REST API Endpoints
-
-Apps can declare custom endpoints on Nautobot's REST API to retrieve or manipulate models or other data. These behave very similarly to views, except that instead of rendering arbitrary content using a template, data is returned in JSON format using a serializer. Nautobot uses the [Django REST Framework](https://www.django-rest-framework.org/), which makes writing API serializers and views very simple.
-
-First, create a serializer for the `Animal` model, in `api/serializers.py`:
-
-```python
-# api/serializers.py
-from nautobot.apps.api import ValidatedModelSerializer
-
-from nautobot_animal_sounds.models import Animal
-
-
-class AnimalSerializer(ValidatedModelSerializer):
-    """API serializer for interacting with Animal objects."""
-
-    class Meta:
-        model = Animal
-        fields = ('id', 'name', 'sound')
-```
-
-!!! tip
-    For more full-featured models, you should use one of the other base classes from `nautobot.apps.api` such as `NautobotModelSerializer`.
-
-Next, create a generic API view set that allows basic CRUD (create, read, update, and delete) operations for Animal instances. This is defined in `api/views.py`:
-
-```python
-# api/views.py
-from rest_framework.viewsets import ModelViewSet
-
-from nautobot_animal_sounds.models import Animal
-from .serializers import AnimalSerializer
-
-
-class AnimalViewSet(ModelViewSet):
-    """API viewset for interacting with Animal objects."""
-
-    queryset = Animal.objects.all()
-    serializer_class = AnimalSerializer
-```
-
-!!! tip
-    For more full-featured models, you should probably use `nautobot.apps.api.NautobotModelViewSet` as a base class.
-
-Finally, register a URL for our endpoint in `api/urls.py`. This file **must** define a variable named `urlpatterns`.
-
-```python
-# api/urls.py
-from rest_framework import routers
-
-from .views import AnimalViewSet
-
-
-router = routers.DefaultRouter()
-router.register('animals', AnimalViewSet)
-urlpatterns = router.urls
-```
-
-With these three components in place, we can request `/api/plugins/animal-sounds/animals/` to retrieve a list of all Animal objects defined.
-
-![Nautobot REST API app endpoint](../../../../media/plugins/plugin_rest_api_endpoint.png)
-
-!!! warning
-    This example is provided as a minimal reference implementation only. It does not address authentication, performance, or the myriad of other concerns that app authors should have.

nautobot/docs/development/apps/api/views/urls.md

@@ -1,26 +0,0 @@
-# Registering URL Patterns
-
-Finally, to make the view accessible to users, we need to register a URL for it. We do this in `urls.py` by defining a `urlpatterns` variable containing a list of paths.
-
-```python
-# urls.py
-from django.urls import path
-
-from . import views
-
-
-urlpatterns = [
-    path('random/', views.RandomAnimalView.as_view(), name='random_animal'),
-]
-```
-
-A URL pattern has three components:
-
-* `route` - The unique portion of the URL dedicated to this view
-* `view` - The view itself
-* `name` - A short name used to identify the URL path internally
-
-This makes our view accessible at the URL `/plugins/animal-sounds/random/`. (Remember, our `AnimalSoundsConfig` class sets our app's base URL to `animal-sounds`.) Viewing this URL should show the base Nautobot template with our custom content inside it.
-
-!!! tip
-    As a next step, you would typically want to add links from the Nautobot UI to this view, either from the [navigation menu](../ui-extensions/navigation.md), the [Nautobot home page](../ui-extensions/home-page.md), and/or the [Installed Plugins view](../configuration-view.md).

nautobot/docs/development/apps/api/views/view-overrides.md

@@ -1,50 +0,0 @@
-# Overriding Default Model Views in Nautobot Apps
-
-+++ 2.0.0
-
-In UI 2.0, Nautobot provides default model views (`ObjectListView`, `ObjectRetrieveView` and etc) for every model including App provided models unless they are explicitly overridden. For example, an app called `your_example_app` wants to override the default `ObjectRetrieveView` for its model called `YourExampleModel` with a customized view called `YourExampleView`. We need to go to the `index.js` file located in the `your_example_app/ui` folder and add a key `view_overrides` to the `app_config` dictionary variable.
-
-```no-highlight
-const app_config = {
-    ...
-    view_overrides: {}
-    ...
-}
-```
-
-In `view_overrides`'s dictionary, you need to specify the app and the model you want to override the default view for in this format `{app_label}: {model_name}`. So in our case, it would be `"your-example-app": "your-example-model"`.
-
-```no-highlight
-...
-    view_overrides: {
-        "your-example-app": "your-example-model": {}
-    }
-...
-```
-
-Finally, you need to specify the default view action you want to override and the new view in this format `{view_action}: {new_view}`. So in our case, it would be `"retrieve": "YourExampleView"`:
-
-```no-highlight
-...
-    view_overrides: {
-        "your-example-app": "your-example-model": {
-            "retrieve": "YourExampleView"
-        }
-    }
-...
-```
-
-Now if you go to `YourExampleModel`'s retrieve view, instead of the default `ObjectRetrieveView`, you will see the customized layout of `YourExampleView`.
-
-If you want to override the default `ObjectListView` as well for `YourExampleModel` with `YourExampleListView`, just append `"list": "YourExampleListView"` to the `"your-example-app": "your-example-model"` dictionary.
-
-```no-highlight
-...
-    view_overrides: {
-        "your-example-app": "your-example-model": {
-            "retrieve": "YourExampleView",
-            "list": "YourExampleListView",
-        }
-    }
-...
-```

nautobot/docs/development/apps/index.md

@@ -1,75 +0,0 @@
-# App Development
-
-This documentation covers the development of custom apps (plugins) for Nautobot. Nautobot apps are essentially self-contained [Django applications](https://docs.djangoproject.com/en/stable/ref/applications/) which integrate with Nautobot to provide custom functionality. Since the development of Django applications is already very well-documented, this will only be covering the aspects that are specific to Nautobot.
-
-Apps can [do a lot of different things](./index.md#capabilities), all of which will be covered in detail in this document.
-Keep in mind that each piece of functionality is entirely optional. For example, if your app merely adds a piece of middleware or an API endpoint for existing data, there's no need to define any new models.
-
-+/- 1.5.2
-    The `nautobot.apps` namespace was added in Nautobot 1.5.2. If developing apps to be backwards-compatible with older versions of Nautobot, please refer to the app developer documentation of your required Nautobot version.
-
-!!! tip
-    The app detail view (`/plugins/installed-plugins/<plugin_name>/`, accessible to superusers via **Plugins -> Installed Plugins** in the navigation menu, then selecting a specific app) provides in-depth information about which features any installed app is implementing or making use of.
-
-## Installing and Using Plugins
-
-Plugins are packaged [Django](https://docs.djangoproject.com/) apps that can be installed alongside Nautobot to provide custom functionality not present in the core application. Plugins can introduce their own models and views, but cannot interfere with existing components. A Nautobot user may opt to install plugins provided by the community or build his or her own.
-
-## Capabilities
-
-The Nautobot plugin architecture allows for plugins to do any or all of the following:
-
-### Extend the existing Nautobot UI
-
-* **Add navigation menu items.** A plugin can extend the navigation menus with new links and buttons or even entirely new menus.
-* **Add home page content.** A plugin can add custom items or custom panels to the Nautobot home page.
-* **Add content to existing model detail views.** A plugin can inject custom HTML content within the view of a core Nautobot model. This content can appear in the left column, right column, or full width of the page, and can also include custom buttons at the top of the page.
-
-+++ 1.2.0
-    * **Add a banner.** A plugin can add a custom banner to the top of any appropriate views.
-
-+++ 1.4.0
-    * **Add extra tabs to existing model detail views.** A plugin can inject additional tabs which will appear at the end of the object detail tabs list.
-
-### Extend and customize existing Nautobot functionality
-
-* **Add custom validation logic to existing data models.** A plugin can provide additional logic to customize the rules for validating created/updated data records.
-* **Provide Jobs.** A plugin can serve as a convenient way to package and install [Jobs](../../user-guide/platform-functionality/jobs/index.md).
-* **Add additional Git data types.** A plugin can add support for processing additional types of data stored in a [Git repository](../../user-guide/platform-functionality/gitrepository.md).
-
-+++ 1.1.0
-    * **Register additional Jinja2 filters.** A plugin can define custom Jinja2 filters to be used in computed fields, webhooks, custom links, and export templates.
-
-+++ 1.2.0
-    * **Populate extensibility features in the database.** A plugin can add content to the Nautobot database when installed, such as automatically creating new custom fields, relationships, and so forth.
-
-    * **Add additional secrets providers.** A plugin can add support for retrieving [Secret](../../user-guide/platform-functionality/secret.md) values from additional sources or external systems.
-
-+++ 1.4.0
-    * **Override already-defined views.** A plugin can define a view which can be set to override a view from the core set of views or another plugin's view.
-
-### Add entirely new features
-
-* **Add new data models.** A plugin can introduce one or more models to hold data. (A model is essentially a table in the SQL database.) These models can be integrated with core implementations of GraphQL, webhooks, logging, custom relationships, custom fields, and tags.
-* **Add new URLs and views.** A plugin can register URLs under the `/plugins/` root path to provide browseable views (pages) for users.
-* **Add new REST API endpoints.** A plugin can register URLs under the `/api/plugins/` root path to provide new REST API views.
-* **Add custom middleware.** A plugin can provide and register custom Django middleware.
-
-+++ 2.0.0
-    * **Register data models for the global search.** A plugin's data models can easily be included in the top-level "global" search.
-
-### Declare dependencies and requirements
-
-* **Declare configuration parameters.** A plugin can define required, optional, and default configuration parameters within its unique namespace. Plugin configuration parameters are configurable under [`PLUGINS_CONFIG`](../../user-guide/administration/configuration/optional-settings.md#plugins_config) in `nautobot_config.py`.
-* **Limit installation by Nautobot version.** A plugin can specify a minimum and/or maximum Nautobot version with which it is compatible.
-* **Add additional Django dependencies.** A plugin can define additional Django application dependencies to require when the plugin is enabled.
-
-## Limitations
-
-Either by policy or by technical limitation, the interaction of plugins with Nautobot core is restricted in certain ways. A plugin may not:
-
-* **Modify core models.** Plugins may not alter, remove, or override core Nautobot models in any way. This rule is in place to ensure the integrity of the core data model.
-* **Register URLs outside the `/plugins` root.** All plugin URLs are restricted to this path to prevent path collisions with core or other plugins.
-* **Override core templates.** Plugins can inject additional content where supported, but may not manipulate or remove core content.
-* **Modify core settings.** A configuration registry is provided for plugins, however they cannot alter or delete the core configuration.
-* **Disable core components.** Plugins are not permitted to disable or hide core Nautobot components.

nautobot/docs/development/apps/migration/code-updates.md

@@ -1,160 +0,0 @@
-# App Code Updates for Nautobot v2
-
-## Update Code Import Locations
-
-Most changes in code location arise from the merging of the `nautobot.utilities` module into the `nautobot.core` module.
-
-??? info "Full table of code location changes"
-    {data-table user-guide/administration/upgrading/from-v1/tables/v2-code-location-changes.yaml}
-
-## Replace PluginMenuItem with NavMenuItem
-
-In your app's `navigation.py` file. If you are still using `PluginMenuItem` from `nautobot.extras.plugin`, you should replace those code with `NavMenuGroup`, `NavMenuItem`, and `NavMenuTab` from `nautobot.apps.ui`.
-
-For example:
-
-Before:
-
-```python
-
-    from nautobot.extras.plugins import PluginMenuItem
-
-    menu_items = (
-        PluginMenuItem(
-            link="plugins:your_app:dashboard",
-            link_text="Dashboard",
-            permissions=["your_app.view_sync"],
-        ),
-        PluginMenuItem(
-            link="plugins:your_app:sync_list",
-            link_text="History",
-            permissions=["your_app.view_sync"],
-        ),
-        PluginMenuItem(
-            link="plugins:your_app:synclogentry_list",
-            link_text="Logs",
-            permissions=["your_app.view_synclogentry"],
-        ),
-    )
-
-```
-
-After:
-
-```python
-
-from nautobot.apps.ui import NavMenuGroup, NavMenuItem, NavMenuTab
-
-
-items = [
-    NavMenuItem(
-        link="plugins:your_app:dashboard",
-        name="Dashboard",
-        permissions=["your_app.view_sync"],
-    ),
-    NavMenuItem(
-        link="plugins:your_app:sync_list",
-        name="History",
-        permissions=["your_app.view_sync"],
-    ),
-    NavMenuItem(
-        link="plugins:your_app:synclogentry_list",
-        name="Logs",
-        permissions=["your_app.view_synclogentry"],
-    ),
-]
-
-menu_items = (
-    NavMenuTab(
-        name="Plugins",
-        groups=(NavMenuGroup(name="Your App", weight=1000, items=tuple(items)),),
-    ),
-)
-
-```
-
-### Remove Tag/Tags Filter from FilterSet Definitions
-
-In Nautobot 2.0, you can safely remove `tag = TagFilter(...)` from your filter set definitions as long as your filter sets inherit from `NautobotFilterSet` class and `tags` is added to the filter set class `Meta.fields`.
-
-For example, before the filter set could look like this:
-
-```py
-
-class AppModelFilterSet(BaseFilterSet):
-
-    name = MultiValueCharFilter(...)
-    number = MultiValueNumberFilter(...)
-    tag = TagFilter(...)
-
-    class Meta:
-        fields = ["name", "number"]
-```
-
-After changing the base class to `NautobotFilterSet` the `tag` filter should be removed:
-
-```py
-
-class AppModelFilterSet(NautobotFilterSet):
-
-    name = MultiValueCharFilter(...)
-    number = MultiValueNumberFilter(...)
-
-    class Meta:
-        fields = ["name", "number", "tags"]
-
-```
-
-## Replace DjangoFilterBackend with NautobotFilterBackend
-
-If your REST API has any `FilterBackend` classes derived from `DjangoFilterBackend`, you should replace `DjangoFilterBackend` with `NautobotFilterBackend`.
-
-## App Model Serializer Inheritance
-
-App Model Serializers for any models that could have a Generic Foreign Key or a Many to Many relationship from a Nautobot Core model **must** inherit from BaseModelSerializer at a minimum so that they have a properly generated `object_type` field. This also applies to the case where your model is a subclass of `ChangeLoggedModel` and you will have a Generic Foreign Key from `ObjectChange`'s `changed_object` field. Otherwise drf-spectacular schema generation will throw an error:
-
-```no-highlight
-(drf_spectacular.E001) Schema generation threw exception "Field name `object_type` is not valid for model `YourAppModel`.
-```
-
-## Revamp Rest API Serializers
-
-`NestedSerializer` classes are no longer needed in Nautobot 2.0. If any `NestedSerializers` exist for your models, you should just remove their class definitions and references.
-
-After removing existing `NestedSerializers`, you can change the `fields` attribute in your serializers' `class Meta` to `__all__` and that will automatically include all the model's fields in the serializer, including related-model fields that would previously have required a reference to a `NestedSerializer`. If you want to exclude certain fields of the model, you can specify a list of fields you want to display in the `fields` attribute instead.
-
-!!! warning
-    Use caution around `fields = "__all__"` -- if your model has any fields that should _not_ be exposed in the REST API, you should avoid using `"__all__"` and instead use an explicit `fields` list to ensure that such fields are not exposed. In some cases, it may be appropriate to use `"__all__"` in combination with flags such as `write_only=True` on specific fields, but proceed with caution and examine the REST API data carefully to ensure that its contents are as expected.
-
-Include all model attributes:
-
-```python
-class ExampleModelSerializer(NautobotModelSerializer):
-    """Used for normal CRUD operations."""
-
-    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:example_plugin-api:anotherexamplemodel-detail")
-
-    class Meta:
-        model = AnotherExampleModel
-        fields = "__all__"
-```
-
-Include only specified model attributes:
-
-```python
-class ExampleModelSerializer(NautobotModelSerializer):
-    """Used for normal CRUD operations."""
-
-    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:example_plugin-api:anotherexamplemodel-detail")
-
-    class Meta:
-        model = AnotherExampleModel
-        # example_attribute_4 is not included in the serializer
-        fields = ["url", "example_attribute_1", "example_attribute_2", "example_attribute_3"]
-```
-
-In addition, the `?brief=` API query parameter is replaced by `?depth=<0-10>`. As a result, the ability to specify `brief_mode` in `DynamicModelChoiceField`, `DynamicModelMultipleChoiceField`, and `MultiMatchModelMultipleChoiceField` has also been removed. For every occurrence of the aforementioned fields where you have `brief_mode` set to `True/False` (e.g. `brief_mode=True`), please remove the statement, leaving other occurrences of the fields where you do not have `brief_mode` specified as they are. Check out our [API documentation](../../../user-guide/platform-functionality/rest-api/overview.md#depth-query-parameter) for this change.
-
-## Revamp CSV Import and Export
-
-CSV Import for models are now done automatically via the Rest API. As a result of this change, `CSVForm` classes are no longer needed and should be deleted. In addition, the Model `csv_headers` attribute and `to_csv` method are no longer needed or used in CSV generation, and should be removed from your model definitions. Check out our [release notes](../../../release-notes/version-2.0.md#revamped-csv-import-and-export-254) for this specific change.

nautobot/docs/development/apps/migration/dependency-updates.md

@@ -1,13 +0,0 @@
-# Dependency Updates
-
-## Nautobot Version
-
-Change your Nautobot to the latest/v2.0 release.
-
-## Python Version
-
-Python 3.7 support is dropped for Nautobot v2.0 and Python 3.8 is the minimum version for Nautobot and its apps.
-
-## pylint-nautobot
-
-pylint-nautobot is now a required dev-dependency. Make sure you add `pylint-nautobot = "*"` under `tool.poetry.dev-dependencies` section in your `pyproject.toml`.