FusionAuth / fusionauth-typescript-client

A TypeScript client for FusionAuth
https://fusionauth.io
Apache License 2.0
60 stars 27 forks source link

Client and API Documentation don't align - searchEntityTypes #78

Open ansonallard opened 1 year ago

ansonallard commented 1 year ago

When I went to set the correct permissions on my API key to call the searchEntityTypes function, I visited the FusionAuth Entity Type documentation and found that the API call was a GET for searching entity types. I then set my api key to allow GET on /api/entity/type/search. However, I still received a 401, and after reading the client code, it makes a POST request instead, which doesn't align with the documentation. I'd like to understand which is correct - a GET or POST - and note that the discrepancy between the client and the documentation should be updated.

mooreds commented 1 year ago

Thanks @ansonallard

I looked at this API and both GETs and POSTs should work.

Does that help?

I'll take a todo to update it.

ansonallard commented 1 year ago

Hey @mooreds - I was able to get the POST to work as well. Thanks for queuing an update. 😄 I just wanted to let your team know that the documentation specified one verb and the client library used another, so I just wanted to make sure I understood what was the correct/intended verb for the use case.