From f17c5ecf9812b433c316a638d492dcbe361f41ba Mon Sep 17 00:00:00 2001 From: Dan Moore Date: Tue, 15 Dec 2020 10:48:42 -0700 Subject: [PATCH] Added 'gotchas' section to document the workaround for https://github.com/FusionAuth/fusionauth-python-client/issues/10 Working around this rather than fixing it because of future plans to overhaul client libs. If those don't work, should circle back and fix this by modifying client builder freemarker to stringify and lowercase all boolean args. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f1a9362..78048d9 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,7 @@ client = FusionAuthClient('6b87a398-39f2-4692-927b-13188a81a9a3', 'http://localh Each method in the client library includes documentation to describe the use and parameters. In addition to this resource, review the API documentation. https://fusionauth.io/docs/v1/tech/apis/ If you encounter issues with this library, please open an issue. + +### Gotchas + +If you need to pass a boolean to any methods, such as `logout`, pass a lowercase string value: `"true"` for `True`, `"false"` for `False`. See https://github.com/FusionAuth/fusionauth-python-client/issues/10 for more info on this issue.