Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ConnectWiseEndpoint._make_request() argument "as_json" not implemented #8

Closed
EMoonArchiTech opened this issue Aug 18, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@EMoonArchiTech
Copy link
Contributor

Hi all, while digging around in this cool piece of software you've made, I found an unimplemented argument in the _make_request() function. specifically, "as_json" is mentioned in the docstring but from what I can see does not seem to be implemented in the function itself.

I also looked in the requests.api module and it does not appear to be present as a parameter there either. However, I have not been able to test this myself so apologies if this is onerous.

Should this be implemented in code or removed from the docs?

as_json (bool, optional): Whether to return the JSON response or the Response object. Defaults to True.

@Yoshify
Copy link
Contributor

Yoshify commented Aug 20, 2023

Thanks for raising this - this was a legacy parameter that has since been removed as we didn't see much use for it internally, but documentation hasn't been updated. As this project is still in pre-release phase no documentation has been finalized, there'll be a sweep done once we're at a state where we're ready to call it finished.

You're welcome to submit a PR for this if you'd like, otherwise I'll be tracking it for update in an upcoming release.

Cheers!

@Yoshify Yoshify self-assigned this Aug 20, 2023
@Yoshify Yoshify added the documentation Improvements or additions to documentation label Aug 20, 2023
EMoonArchiTech added a commit to EMoonArchiTech/pyconnectwise that referenced this issue Aug 20, 2023
Removed as_json documentation per issue HealthITAU#8
HealthITAU#8 (comment)
@EMoonArchiTech
Copy link
Contributor Author

You're welcome to submit a PR for this if you'd like, otherwise I'll be tracking it for update in an upcoming release.

Done! Hopefully no issues :) I usually just commit to my own repo's so not super familiar with pull request etiquette.

Yoshify added a commit that referenced this issue Aug 21, 2023
Removed legacy param documentation from connectwise_endpoint.py #8
@Yoshify
Copy link
Contributor

Yoshify commented Aug 21, 2023

All looked good, thanks for the help!

Closing this now.

@Yoshify Yoshify closed this as completed Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants