Error in Documentation of list_management.batch_delete_lists() (probably PiHole Bug)

[muller2002]

In function list_management.batch_delete_lists() it is told, that the keys "address" and "type" are required, but in realltiy it is "item" and "type".

I am really sure, that this is due to a bug in PiHole, see: pi-hole/FTL#2377

I am not sure, if waiting for an fix in PiHole or changing the documentation (or altering the "address" to "item" in the function is the best to do here.

[sbarbett]

Yeah, that's definitely not documented properly. I suspect that they will want to change the docs to specify the field as "item" vs changing it to "address," but I'd like to see how they respond to the issue before making any changes.

[DL6ER]

Yes, we will fix the API docs.

[DL6ER]

pi-hole/FTL#2379

[sbarbett]

I fixed the stream comment that describes the list object structure.

    def batch_delete_lists(self, lists):
        """
        Delete multiple lists.

        :param lists: List of dictionaries with keys "item" and "type".
                      Example: [{"item": "https://example.com/blocklist.txt", "type": "block"}]
        """
        if not isinstance(lists, list):
            raise ValueError("lists must be a list of dictionaries.")

        return self.connection.post("lists:batchDelete", data=lists)