✨ feat(Core): Criação de nova funcionalidade no metodo get que permit…

…e passar querys ultilizadas na pagína de filtro

CHANGELOG.md

@@ -1,7 +1,13 @@
 ## Unreleased
 
+## V1.2.0 (2024-07-17)
+### ✨ Features
+
+- **Core**: Criação de nova funcionalidade no metodo get que permite passar querys ultilizadas na pagína de filtro
+
 ### 📝💡 Documentation
 
+- **docs**: Create contributing documentation
 - **netboxcli**: update documentation in code
 - **netboxcli-docstrings**: add reference tags
 

README.md

@@ -137,13 +137,11 @@ Aqui está um checklist do que está atualmente disponível no NetboxCli e do qu
 Este checklist será atualizado à medida que novas funcionalidades forem implementadas. 
 Agradecemos por seu interesse e paciência enquanto trabalhamos para tornar o NetboxCli mais abrangente e útil para suas necessidades de automação e gerenciamento de rede.
 
-## 📌 Versão 1.1.7
+## 📌 Versão 1.2.0
 
-### **Adições na Versão 1.1.7**
+### **Adições na Versão 1.2.0**
 
-- **Correções de Bugs: ** Correção de bugs menores e melhorias de desempenho em todo o código.
-- **Melhorias de Desempenho: ** Otimização de consultas e operações para melhorar o desempenho geral do NetboxCli.
-- **Atualizações de Documentação: ** Atualizações e melhorias na documentação para refletir as mudanças mais recentes.
+- **Criação de nova feature:** Criação de nova funcionalidade no metodo get que permite passar querys ultilizadas na pagína de filtro
 
 ## ✒️ Autores
 

compile/api_structure.py

@@ -41,6 +41,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -51,6 +52,7 @@ def get(
            name (str, optional): The name of the resource to retrieve.
            tags (list, optional): List of tags to filter resources.
            search (str, optional): Search query to filter resources.
+           filter (str, optional): Filter query especified by the user in to filter resources.
            limit (int, optional): Maximum number of results to return. Defaults to 1000.
            
        Examples:
@@ -70,6 +72,9 @@ def get(
            Get resources by search query:
            >>> result = nb.{class_main}.{subclass}.get(search="query")
            
+           Get resources by filter query:
+              >>> result = nb.{class_main}.{subclass}.get(filter="assigned_to_interface=True")
+           
            Get all resources:
            >>> result = nb.{class_main}.{subclass}.get()
            

netboxcli/circuits/circuit_types.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.circuits.circuit_types.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.circuits.circuit_types.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.circuits.circuit_types.get()
 

netboxcli/circuits/circuits.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.circuits.circuits.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.circuits.circuits.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.circuits.circuits.get()
 

netboxcli/circuits/provider_accounts.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.circuits.provider_accounts.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.circuits.provider_accounts.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.circuits.provider_accounts.get()
 

netboxcli/circuits/provider_networks.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.circuits.provider_networks.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.circuits.provider_networks.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.circuits.provider_networks.get()
 

netboxcli/circuits/providers.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.circuits.providers.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.circuits.providers.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.circuits.providers.get()
 

netboxcli/connections/cables.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.connections.cables.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.connections.cables.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.connections.cables.get()
 

netboxcli/connections/wireless_links.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.connections.wireless_links.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.connections.wireless_links.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.connections.wireless_links.get()
 

netboxcli/core.py

@@ -44,6 +44,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -54,6 +55,7 @@ def get(
             name: (str): The name of the resource to retrieve.
             tags: (list): List of tags to filter resources.
             search: (str): Search query to filter resources.
+            filter: (str): Filter query especified by the user in to filter resources.
             limit: (int): Maximum number of results to return. Defaults to 1000.
 
         Returns:
@@ -84,6 +86,11 @@ def get(
                 response = self._netbox._request(
                     'get', f'{self._endpoint}?q={search}&?limit={limit}'
                 )
+
+            if filter:
+                response = self._netbox._request(
+                    'get', f'{self._endpoint}?{filter}&?limit={limit}'
+                )
             else:
                 response = self._netbox._request(
                     'get', f'{self._endpoint}?limit={limit}'
@@ -102,6 +109,7 @@ def get(
                                 filtered_resources.append(item)
 
                 return response
+
             else:
                 return response
 

netboxcli/customization/custom_fields.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.customization.custom_fields.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.customization.custom_fields.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.customization.custom_fields.get()
 

netboxcli/customization/custom_links.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.customization.custom_links.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.customization.custom_links.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.customization.custom_links.get()
 

netboxcli/customization/export_templates.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.customization.export_templates.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.customization.export_templates.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.customization.export_templates.get()
 

netboxcli/customization/image_attachments.py

@@ -16,6 +16,7 @@ def get(
         name: str = None,
         tags: list = None,
         search: str = None,
+        filter: str = None,
         limit: int = 1000,
     ) -> dict:
         """
@@ -26,6 +27,7 @@ def get(
             name (str, optional): The name of the resource to retrieve.
             tags (list, optional): List of tags to filter resources.
             search (str, optional): Search query to filter resources.
+            filter (str, optional): Filter query especified by the user in to filter resources.
             limit (int, optional): Maximum number of results to return. Defaults to 1000.
 
         Examples:
@@ -45,6 +47,9 @@ def get(
             Get resources by search query:
             >>> result = nb.customization.image_attachments.get(search="query")
 
+            Get resources by filter query:
+               >>> result = nb.customization.image_attachments.get(filter="assigned_to_interface=True")
+
             Get all resources:
             >>> result = nb.customization.image_attachments.get()