Fixed "use_tfa" incorrect naming and typing in API

[Kruzya]

Affected version

2.2.8

If we open API documentation for User entity, we can see field named as use_tfa with type array:


But in API response for /me action, this field is presented as usa_tfa and in boolean type:

 

[XF Bug Bot]

Thank you for reporting this issue, it has now been resolved. We are aiming to include any changes that have been made in a future XF release (2.2.9).

Change log:

Correctly mark the use_tfa field as a boolean value in the API documentation

There may be a delay before changes are rolled out to the XenForo Community.

 

[PaulB]

Does that fix also resolve the typo on line 2031 of User.php? That would be a breaking change if so.

 

[Chris D]

Only just spotted the typo

No changes have been made there yet.

 

[Chris D]

I’ll ping @NixFifty to take a look. Ideally we need to add a use_tfa key to the result for the next version and we’ll remove usa_tfa in 2.3.

 

[Kruzya]

@Chris D, what about a versioning the API methods? By default just use the lower version for compatibility.

 

[Chris D]

We have the ability to do that but a new version for this one particular issue seems a bit OTT. Plus the bug is within the entity itself which means multiple API methods would need to be patched and potentially third party ones too.

So new method versions are probably going to be reserved for significant changes which affect one or few methods only.