PaloAltoNetworks / pan-os-python

The PAN-OS SDK for Python is a package to help interact with Palo Alto Networks devices (including physical and virtualized Next-generation Firewalls and Panorama). The pan-os-python SDK is object oriented and mimics the traditional interaction with the device via the GUI or CLI/API.
https://pan-os-python.readthedocs.io
ISC License
340 stars 168 forks source link

Inconsistent naming convention related to DecrytionRule tags #459

Closed vipaone9 closed 2 years ago

vipaone9 commented 2 years ago

Describe the bug

Class panos.policies.DecryptionRule has inconsistent naming convention...Any one would expect to follow standard convention (tag vs tags).

AuthenticationRule, AuthenticationOverride, NatRule & SecurityRule use 'tag" while DecryptionRule uses "tags". It would be nice to follow standard naming convention.

welcome-to-palo-alto-networks[bot] commented 2 years ago

:tada: Thanks for opening your first issue here! Welcome to the community!

shinmog commented 2 years ago

For historical reasons, it has to be tag in the above, but it will be tags going forward.

In general, if a param is a list of things, it should be plural so that it makes it more obvious to users that it's a list.