spopensource / edgeconnect-python Goto Github PK

A few methods in pyedgeconnect use return_type="full_response" to return a requests.model.Response object, however, while the docstring has the properly documented return type, the definition line type-hint incorrectly often has dict

current

def get_appliance_stats_minute_file(
    self,
    file: str,
) -> dict:

instead of

def get_appliance_stats_minute_file(
    self,
    file: str,
) -> requests.Response:

Orchestrator.appliance_resync() function is returning a 404 when called, using /applianceResyncSynchronize as an endpoint.

Endpoint in Swagger documented as /applianceResync

The get_all_users() method is implemented using the post method as opposed to get. File _users.py line 45 should be corrected to "return self._get("/users")".

Currently EdgeConnect.login and Orchestrator.login functions return True when response received from EdgeConnect appliance or Orchestrator respectively even if status code isn't 200 or valid cookie isn't included

Passing the Orchestrator.upldate_appliance_access_group() method will pass the default value of "None" if either the appliance groups list or the appliance regions lists are not passed. This returns a HTTP 400 "Received Null value for group or region". A blank list must be passed currently to overcome this error.

The preconfig generator example looks for a column in CSV file for serial_number, however, it doesn't use the data when saving the preconfig on Orchestrator to match against an appliance

        # Set value for serial number if provided
        appliance_serial = row.get("serial_number")
        if appliance_serial is None:
            appliance_serial = ""
        else:
            pass

When orch.create_preconfig() is called, it doesn't assign this to the parameter serial_number:

                orch.create_preconfig(
                    preconfig_name=row["hostname"],
                    yaml_preconfig=yaml_preconfig,
                    auto_apply=auto_apply,
                    tag=row["hostname"],
                    ### MISSING -- serial_number = appliance_serial,
                    comment=f"Created/Uploaded @ {comment_timestamp}",
                )

get_timeseries_stats_tunnel_single_appliance method has a mandatory query parameter 'tunnelName.' Currently added to endpoint as the same name as the python variable 'tunnel_name' which does not properly query the API