Some feedback/suggestions

[Pimmetje]

I was playing with your library and it seems nice. A few things that i found so far.

• The list functions do not exists on the objects. This makes the sample on the readme incorrect
• I think it's better to use the example with ca_content as this does not require a extra file
• Add a option to ignore certificate. This should not be used in production but can be helpful during testing.
• Adding the pypi packagename to the readme

Thanks for all the hard work.

[dylanturn]

Good morning, afternoon, or evening!

The list functions do not exists on the objects. This makes the sample on the readme incorrect

If you're referring to the alias object in list_output = alias.list() then the issue is that alias is actually a poorly named reference to opnsense.firewall.alias_controller.

In hindsight I should have done something like this in the readme: alias_controller = opnsense.firewall.alias_controller

I think it's better to use the example with ca_content as this does not require a extra file

I had documented the file since CA certs are verbose, but I think you're right in saying I should really document both.

Add a option to ignore certificate. This should not be used in production but can be helpful during testing.

Fair point, will do.

Adding the pypi packagename to the readme

Another fair point, will also do.

Thank you so much for your feedback!

[Pimmetje]

Thanks for your reply.

The issue with the list is a bit strange to me. The code works but i don't see where the list is coming from. I was put on the wrong foot because i use auto completion using my IDE complained about it. The IDE likes object types as a return value. Do you think it's useful to add? Basically it means not doing return list or return dict but using a internal object as a wrapper around it. This way a ide can autocomplete it.

For example make a Alias object with the fields like

class Alias:
    uuid: str
    enabled: bool
    name: str
    description: str
    type: str
    content: str
    current_items: int
    last_updated: str
    categories_uuid: List[str]

And for all the methods build a list of those and use List[Alias] as a return type.

But it could also be something for a extra wrapper to do this. They may be other/better ways to get the same thing.

[Pimmetje]

This already seem to be enough

class OpnsenseApi(Opnsense):

    def get_aliasses(self) -> List['OpnSenseApiAlias']:
        return self.firewall.alias_controller.list_aliases()


class OpnSenseApiAlias(TypedDict):
    uuid: str
    enabled: bool
    name: str
    description: str
    type: str
    content: str
    current_items: int
    last_updated: str
    categories_uuid: List[str]