Merge pull request #92 from jvanderaa/add_deprecation_of_data_key

Adds deprecation notice to modules

.travis.yml

@@ -10,7 +10,7 @@ env:
   global:
     - COLLECTION_NAMESPACE: "networktocode"
     - COLLECTION_NAME: "nautobot"
-    - COLLECTION_VERSION: "2.0.1"
+    - COLLECTION_VERSION: "2.0.2"
 
 jobs:
   include:

changelogs/changelog.yaml

@@ -4,7 +4,6 @@ releases:
     changes:
       release_summary: 'This is the first official release of an Ansible Collection
         for Nautobot.
-
         This project is forked from the ``netbox.netbox`` Ansible Collection.'
     fragments:
     - release-v1.0.0.yml
@@ -206,14 +205,33 @@ releases:
     - v1.0.4.yml
     release_date: '2021-03-14'
   1.1.0:
-    changes:
-    modules:
-      - description: Action plugin to query Nautobot GraphQL API endpoint
-        name: query_graphql
-        namespace: 'networktocode.nautobot'
-      - description: Lookup plugin to query Nautobot GraphQL API endpoint
-        name: lookup_graphql
-        namespace: 'networktocode.nautobot'
     fragments:
     - v1.1.0.yml
-    release_date: '2021-04-12'
+    modules:
+    - description: Lookup plugin to query Nautobot GraphQL API endpoint
+      name: lookup_graphql
+      namespace: networktocode.nautobot
+    - description: Action plugin to query Nautobot GraphQL API endpoint
+      name: query_graphql
+      namespace: networktocode.nautobot
+    release_date: '2021-04-12'
+  2.0.0:
+    changes:
+      bugfixes:
+      - (#26) Add missing description to tenant_group
+      - (#29) Add missing field to vlan_group
+      - (#32) Fixed query on Virtual Chassis
+      - (#35) Add Site, Device Tracebacks due to changes in Nautobot
+      major_changes:
+      - (#33) Deprecates NAUTOBOT_API and NAUTOBOT_API_TOKEN environment variables
+      release_summary: Bug fixes and removal of NAUTOBOT_API and NAUTOBOT_API_TOKEN
+  2.0.1:
+    changes:
+      bugfixes:
+      - (#44) Add Interface Label Support
+      - (#45) SSL Verify Keyword Consistency Update
+      release_summary: Bug fix updates for label support and SSL version consistency
+  2.0.2:
+    changes:
+      deprecations:
+        - All plugin modules (does not include inventory and lookup modules) `data` key is deprecated. Next version will have all sub options moved to options

galaxy.yml

@@ -9,7 +9,7 @@ namespace: networktocode
 name: nautobot
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 2.0.1
+version: 2.0.2
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

plugins/module_utils/utils.py

@@ -454,6 +454,11 @@ def __init__(self, module, endpoint, client=None):
         self.check_mode = self.module.check_mode
         self.endpoint = endpoint
         query_params = self.module.params.get("query_params")
+        self.module.deprecate(
+            "The 'data' option is being removed. All sub options will be moved up one level to an option.",
+            version="3.0.0",
+            collection_name="networktocode.nautobot",
+        )
 
         if not HAS_PYNAUTOBOT:
             self.module.fail_json(

plugins/modules/aggregate.py

@@ -39,6 +39,7 @@
     type: str
   data:
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - "Defines the aggregate configuration"
     type: dict
     suboptions:

plugins/modules/cable.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the cable configuration
     suboptions:
       termination_a_type:

plugins/modules/circuit.py

@@ -41,6 +41,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the circuit configuration
     suboptions:
       cid:

plugins/modules/circuit_termination.py

@@ -41,6 +41,7 @@
     required: true
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the circuit termination configuration
     suboptions:
       circuit:

plugins/modules/circuit_type.py

@@ -41,6 +41,7 @@
     required: true
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the circuit type configuration
     suboptions:
       name:

plugins/modules/cluster.py

@@ -41,6 +41,7 @@
     required: true
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the cluster configuration
     suboptions:
       name:

plugins/modules/cluster_group.py

@@ -41,6 +41,7 @@
     required: true
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the cluster group configuration
     suboptions:
       name:

plugins/modules/cluster_type.py

@@ -41,6 +41,7 @@
     required: true
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the cluster type configuration
     suboptions:
       name:

plugins/modules/console_port.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the console port configuration
     suboptions:
       device:

plugins/modules/console_port_template.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the console port template configuration
     suboptions:
       device_type:

plugins/modules/console_server_port.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the console server port configuration
     suboptions:
       device:

plugins/modules/console_server_port_template.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the console server port template configuration
     suboptions:
       device_type:

plugins/modules/device.py

@@ -40,6 +40,7 @@
     type: str
   data:
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the device configuration
     suboptions:
       name:

plugins/modules/device_bay.py

@@ -39,6 +39,7 @@
     type: str
   data:
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the device bay configuration
     suboptions:
       device:

plugins/modules/device_bay_template.py

@@ -38,6 +38,7 @@
     type: str
   data:
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the device bay template configuration
     suboptions:
       device_type:

plugins/modules/device_interface.py

@@ -39,6 +39,7 @@
     type: str
   data:
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the interface configuration
     suboptions:
       device:

plugins/modules/device_interface_template.py

@@ -38,6 +38,7 @@
     type: str
   data:
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the prefix configuration
     suboptions:
       device_type:

plugins/modules/device_role.py

@@ -39,6 +39,7 @@
     type: str
   data:
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the device role configuration
     suboptions:
       name:

plugins/modules/device_type.py

@@ -39,6 +39,7 @@
     type: str
   data:
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the device type configuration
     suboptions:
       manufacturer:

plugins/modules/front_port.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the front port configuration
     suboptions:
       device:

plugins/modules/front_port_template.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the front port template configuration
     suboptions:
       device_type:

plugins/modules/inventory_item.py

@@ -40,6 +40,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the inventory item configuration
     suboptions:
       device:

plugins/modules/ip_address.py

@@ -41,6 +41,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the IP address configuration
     suboptions:
       family:

plugins/modules/ipam_role.py

@@ -40,6 +40,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the ipam role configuration
     suboptions:
       name:

plugins/modules/manufacturer.py

@@ -40,6 +40,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the manufacturer configuration
     suboptions:
       name:

plugins/modules/platform.py

@@ -40,6 +40,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the platform configuration
     suboptions:
       name:

plugins/modules/power_feed.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the power feed configuration
     suboptions:
       power_panel:

plugins/modules/power_outlet.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the power outlet configuration
     suboptions:
       device:

plugins/modules/power_outlet_template.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the power outlet configuration
     suboptions:
       device_type:

plugins/modules/power_panel.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the power panel configuration
     suboptions:
       site:

plugins/modules/power_port.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the power port configuration
     suboptions:
       device:

plugins/modules/power_port_template.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the power port configuration
     suboptions:
       device_type:

plugins/modules/prefix.py

@@ -41,6 +41,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the prefix configuration
     suboptions:
       family:

plugins/modules/provider.py

@@ -40,6 +40,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the provider configuration
     suboptions:
       name:

plugins/modules/rack.py

@@ -40,6 +40,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the rack configuration
     suboptions:
       name:

plugins/modules/rack_group.py

@@ -40,6 +40,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the rack group configuration
     suboptions:
       description:

plugins/modules/rack_role.py

@@ -40,6 +40,7 @@
   data:
     type: dict
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the rack role configuration
     suboptions:
       name:

plugins/modules/rear_port.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the rear port configuration
     suboptions:
       device:

plugins/modules/rear_port_template.py

@@ -40,6 +40,7 @@
     type: dict
     required: true
     description:
+      - (deprecated) In the next version of the modules the `data` option will be removed. All sub options will now be an option of the module.
       - Defines the rear port template configuration
     suboptions:
       device_type: