Skip to content

Document and/or rename misleading arguments of PyJWKClient #1066

Open
@pakal

Description

@pakal

The parameters of PyJWKClient are a bit misleading, as cache_keys/max_cached_keys only apply to PUBLIC KEYS and cache them FOREVER, whereas cache_jwk_set/lifespan really apply to the actual fetching/caching of JWK sets (but have no impact on the PUBLIC KEY caching)

Expected Result

If PyJWKClient is well part of the publci API (since it's quoted in tutorials), either this two-tier (and a bit complex) system should be documented and explained, and maybe arguments should be renamed (with deprecated aliases) to make it more explicitly which of these does what.

Actual Result

Our implementer had troubles grasping the API ^^"

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions