diff --git a/CHANGES.rst b/CHANGES.rst index 1b5e6b97..5d4625b7 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -13,22 +13,23 @@ Features ~~~~~~~~ - Switched to new OpenWISP theme, registered the new menu items -- Added more REST API endpoint to manipulate details of Topology, Node and Link +- Added more REST API endpoint to manipulate details of Topology, Node and + Link Changes ~~~~~~~ Backward incompatible changes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ++++++++++++++++++++++++++++++ - Changed URL prefix of REST API from to ``/api/v1/topology/`` - ``/api/v1/network-topology/`` - for consistency with the other OpenWISP Modules -- Removed deprecated old receive topology API url; - use the new URL: ``/api/v1/network-topology/topology/{id}/receive/`` + ``/api/v1/network-topology/`` for consistency with the other OpenWISP + Modules +- Removed deprecated old receive topology API url; use the new URL: + ``/api/v1/network-topology/topology/{id}/receive/`` Dependencies -^^^^^^^^^^^^ +++++++++++++ - Dropped support for Python 3.6 - Added support for Python 3.8 and Python 3.9 @@ -38,14 +39,15 @@ Dependencies - Removed redundant django-model-utils (it's defined in openwisp-utils) Other changes -^^^^^^^^^^^^^ ++++++++++++++ - Moved uuid field of topology admin after main fields - Changed "View topology graph" button color - Added the `openwisp-utils DjangoModelPermissions `_ class to API views -- Allow nodes, link and topologies to be shared among different organizations +- Allow nodes, link and topologies to be shared among different + organizations Bugfixes ~~~~~~~~ @@ -59,11 +61,15 @@ Version 0.5.1 [2020-11-25] -------------------------- - [fix] Removed static() call from media assets -- [change] Increased `openwisp-users `__ version from 0.2.x to 0.5.x - (which brings many interesting improvements to multi-tenancy, - `see the change log of openwisp-users `_ +- [change] Increased `openwisp-users + `__ version + from 0.2.x to 0.5.x (which brings many interesting improvements to + multi-tenancy, `see the change log of openwisp-users + `_ for more information) -- Increased `openwisp-utils `__ version to 0.7.x +- Increased `openwisp-utils + `__ version + to 0.7.x Version 0.5.0 [2020-09-18] -------------------------- @@ -71,39 +77,47 @@ Version 0.5.0 [2020-09-18] Features ~~~~~~~~ -- Added `integration with OpenWISP Controller and OpenWISP Monitoring `_ -- API: added `swagger API docs `_ +- Added `integration with OpenWISP Controller and OpenWISP Monitoring + `_ +- API: added `swagger API docs + `_ - Admin: added UUID readonly field - Added user defined properties in Node and Link Changes ~~~~~~~ -- **Backward incompatible**: API and visualizer views now require authentication by default. - This can be changed through the new - `OPENWISP_NETWORK_TOPOLOGY_API_AUTH_REQUIRED `_ +- **Backward incompatible**: API and visualizer views now require + authentication by default. This can be changed through the new + `OPENWISP_NETWORK_TOPOLOGY_API_AUTH_REQUIRED + `_ setting - Upgraded openvpn nodes to netdiff 0.9 - Automatically manage organization of Node and Link -- Changed API URL: /api/v1/receive/{id}/ -> /api/v1//topology/{id}/receive/ (old URL kept for backward compatibility) +- Changed API URL: /api/v1/receive/{id}/ -> + /api/v1//topology/{id}/receive/ (old URL kept for backward + compatibility) Bugfixes ~~~~~~~~ - Fixed link status bug introduced in 0.4 - Fixed exceptions during update of data -- Do not save ``status_changed``, ``modified``, ``created`` in link properties +- Do not save ``status_changed``, ``modified``, ``created`` in link + properties - Fixed Topology admin for users who do not have delete permission Version 0.4.0 [2020-06-28] -------------------------- -- [refactoring] Merged code of django-netjsongraph in openwisp-network-topology +- [refactoring] Merged code of django-netjsongraph in + openwisp-network-topology - [**breaking change**]: URLS at ``/api/`` moved to ``/api/v1/`` - [docs] Reordered & Improved docs - [add] Requirement swapper~=1.1 - [docs] Added tutorial for extending openwisp-network-topology -- [feature] Upgrader script to upgrade from django-netjsongraph to openwisp-network-topology +- [feature] Upgrader script to upgrade from django-netjsongraph to + openwisp-network-topology - [change] Requirement netdiff~=0.8.0 Version 0.3.2 [2020-06-02] @@ -132,24 +146,28 @@ Version 0.2.2 [2020-01-13] -------------------------- - Updated dependencies -- Upgraded implementation of node addresses (via django-netjsongraph 0.5.0) +- Upgraded implementation of node addresses (via django-netjsongraph + 0.5.0) Version 0.2.1 [2018-02-24] -------------------------- - `fe9077c `_: - [models] Fixed related name of Link.target + [models] Fixed related name of Link.target Version 0.2.0 [2018-02-20] -------------------------- - `cb7366 `_: - [migrations] Added a migration file for link_status_changed and openvpn_parser + [migrations] Added a migration file for link_status_changed and + openvpn_parser - `#22 `_: Added support to django 2.0 -- `d40032 `_: +- `d40032 + `_: [qa] Fixed variable name error -- `de45b6 `_: +- `de45b6 + `_: Upgraded code according to latest django-netjsongraph 0.4.0 changes - `#17 `_: Integrated topology history feature from django-netjsongraph @@ -157,7 +175,8 @@ Version 0.2.0 [2018-02-20] Version 0.1.2 [2017-07-22] -------------------------- -- `#13 `_: +- `#13 + `_: Fixed the fetch and receive API bugs - `#15 `_: Imported admin tests from django-netjsongraph @@ -167,9 +186,13 @@ Version 0.1.2 [2017-07-22] Version 0.1.1 [2017-07-10] -------------------------- -- `95f8ade `_: [admin] Moved submit_line.html to `openwisp-utils `_ +- `95f8ade + `_: + [admin] Moved submit_line.html to `openwisp-utils + `_ Version 0.1 [2017-06-29] ------------------------ -- Added multi-tenancy and integrated `django-netjsongraph `_ +- Added multi-tenancy and integrated `django-netjsongraph + `_ diff --git a/README.rst b/README.rst index 465d61f2..333d6a48 100644 --- a/README.rst +++ b/README.rst @@ -48,8 +48,7 @@ store it, visualize it, edit its details, it also provides hooks (a.k.a to execute code when the status of a link changes. For a complete overview of features, refer to the `Network Topology: -Features -`_ +Features `_ section of the OpenWISP documentation. Documentation @@ -57,8 +56,7 @@ Documentation - `Developer documentation `_ -- `User documentation - `_ +- `User documentation `_ Contributing ------------ diff --git a/docs/developer/extending.rst b/docs/developer/extending.rst index c42d29cd..9ff9940a 100644 --- a/docs/developer/extending.rst +++ b/docs/developer/extending.rst @@ -3,9 +3,10 @@ Extending OpenWISP Network Topology .. include:: ../partials/developer-docs.rst -One of the core values of the OpenWISP project is :ref:`Software Reusability `, -for this reason *openwisp-network-topology* provides a set of base classes -which can be imported, extended and reused to create derivative apps. +One of the core values of the OpenWISP project is :ref:`Software +Reusability `, for this reason +*openwisp-network-topology* provides a set of base classes which can be +imported, extended and reused to create derivative apps. In order to implement your custom version of *openwisp-network-topology*, you need to perform the steps described in this section. diff --git a/docs/index.rst b/docs/index.rst index eb71a64a..0afa1652 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,21 +6,23 @@ Network Topology **Source code**: `github.com/openwisp/openwisp-network-topology `_. -OpenWISP Network Topology is a network topology collector and visualizer web application -and API, it allows to collect network topology data from different networking software -(dynamic mesh routing protocols, OpenVPN), store it, visualize it, edit its details, it -also provides hooks (a.k.a `Django signals -`_) to execute code when the -status of a link changes. +OpenWISP Network Topology is a network topology collector and visualizer +web application and API, it allows to collect network topology data from +different networking software (dynamic mesh routing protocols, OpenVPN), +store it, visualize it, edit its details, it also provides hooks (a.k.a +`Django signals `_) +to execute code when the status of a link changes. -When used in conjunction with :doc:`OpenWISP Controller ` and -:doc:`OpenWISP Monitoring `, it :doc:`makes the monitoring system -faster in detecting change to the network <./user/integrations>`. +When used in conjunction with :doc:`OpenWISP Controller +` and :doc:`OpenWISP Monitoring `, +it :doc:`makes the monitoring system faster in detecting change to the +network <./user/integrations>`. -For a comprehensive overview of features, please refer to the :doc:`user/intro` page. +For a comprehensive overview of features, please refer to the +:doc:`user/intro` page. -The following diagram illustrates the role of the Network Topology module within the -OpenWISP architecture. +The following diagram illustrates the role of the Network Topology module +within the OpenWISP architecture. .. figure:: images/architecture-v2-openwisp-network-topology.png :target: ../_images/architecture-v2-openwisp-network-topology.png @@ -31,7 +33,8 @@ OpenWISP architecture. .. important:: - For an enhanced viewing experience, open the image above in a new browser tab. + For an enhanced viewing experience, open the image above in a new + browser tab. Refer to :doc:`/general/architecture` for more information. diff --git a/docs/user/intro.rst b/docs/user/intro.rst index 3ffadfe9..52250afc 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -28,5 +28,5 @@ visualizing, and monitoring network topologies. Key features include: - **topology history**: allows saving daily snapshots of each topology that can be viewed in the frontend - **faster monitoring**: :doc:`integrates with OpenWISP Controller and - OpenWISP Monitoring ` for faster - detection of critical events in the network + OpenWISP Monitoring ` for faster detection of critical + events in the network diff --git a/docs/user/management-commands.rst b/docs/user/management-commands.rst index a38e1507..51d14f55 100644 --- a/docs/user/management-commands.rst +++ b/docs/user/management-commands.rst @@ -93,8 +93,8 @@ django-netjsongraph This management command can be used to create the initial ``DeviceNode`` relationships when the :doc:`integration with OpenWISP Controller -` is enabled in a pre-existing system -which already has some devices and topology objects in its database. +` is enabled in a pre-existing system which already has some +devices and topology objects in its database. .. code-block:: shell diff --git a/docs/user/settings.rst b/docs/user/settings.rst index 430ccd63..1cfb73c4 100644 --- a/docs/user/settings.rst +++ b/docs/user/settings.rst @@ -129,5 +129,4 @@ monitoring agent. The network topology objects are created using the device monitoring data collected by OpenWISP Monitoring. Thus, it requires :doc:`integration with OpenWISP Controller and OpenWISP Monitoring - ` to be enabled in the Django - project. + ` to be enabled in the Django project.