René's URL Explorer Experiment

Title: Allow for same param name but different contextual usage by gjtorikian · Pull Request #520 · workos/workos-python · GitHub

Open Graph Title: Allow for same param name but different contextual usage by gjtorikian · Pull Request #520 · workos/workos-python

X Title: Allow for same param name but different contextual usage by gjtorikian · Pull Request #520 · workos/workos-python

Description: Description As #519 notes, #512 corrected one problem and introduced another. The param provided by users through the SDK is user_id/ group_id / directory_id; the API accepts parameters as user / group / directory by the API, without the suffix. What I misunderstood was that pagination actually requires the *_id version of these parameters, so while #512 fixed pagination (by using *_id), it went ahead and broke regular API calls (by using the incorrect, suffixless parameters). Makes sense? Yeah, I had to re-read everything a few times myself to understand the difference in usage. The key is in these lines (repeated throughout several API resources, I'm just picking one): response = self._http_client.request( "directory_users", method=REQUEST_METHOD_GET, params=list_params, ) return WorkOSListResource( list_method=self.list_users, list_args=list_params, **ListPage[DirectoryUserWithGroups](**response).model_dump(), ) The request uses list_params, and then the pagination WorkOSListResource uses list_params again. To solve this, I added a function to translate the parameter name, depending on the context it's used. Essentially, this branch keeps the *_id names internally for pagination, then renames to the suffixless version them right before the HTTP call. Documentation Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates. [ ] Yes If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

Open Graph Description: Description As #519 notes, #512 corrected one problem and introduced another. The param provided by users through the SDK is user_id/ group_id / directory_id; the API accepts parameters as user / g...

X Description: Description As #519 notes, #512 corrected one problem and introduced another. The param provided by users through the SDK is user_id/ group_id / directory_id; the API accepts parameters as user / g...

Opengraph URL: https://github.com/workos/workos-python/pull/520

X: @github

direct link

Domain: patch-diff.githubusercontent.com

Links:

Viewport: width=device-width