markitosgv / JWTRefreshTokenBundle / 30876478709

100%

push

github

feat: document the refresh token in the api platform specification

Lexik documents the login endpoint, but its response schema only carries the
JWT, because the refresh token beside it is added here and that factory has no
hook to extend. The refresh endpoint is documented by nobody: it is a firewall
authenticator, so there is no controller or resource for API Platform to find.

api_platform.enabled decorates the same factory at a lower priority than Lexik,
so it is handed the specification Lexik has already contributed to.

It reads the bundle's own configuration rather than repeating it, which is what
a decorator written by hand cannot do: with the cookie enabled and the token
removed from the body there is no refresh_token property to document, and
promising one is promising a field that never arrives.

The refresh paths are only ever named on the firewall, so the authenticator
factory records them as each authenticator is created.

Off by default, since an application already decorating the factory by hand
would end up documenting the endpoint twice.

Closes #372

115 of 119 new or added lines in 4 files covered. (96.64%)

1100 of 1130 relevant lines covered (97.35%)

13.36 hits per line