Filter#keywords can be null in API response

[saket]

Steps to reproduce the problem

I'm not sure what the correct steps to reproduce this are, but I just ran into a status that was filtered server-side by mastodon, but does not contain any Filter#keywords value.

Expected behaviour

Filter#keywords should be non-empty as per the API documentation: https://docs.joinmastodon.org/entities/Filter/#keywords

Actual behaviour

Filter#keywords was null

Detailed description

FWIW I noticed that mastodon-android does not mark Filter#keywords as a required field. It was explicitly removed here:

mastodon/mastodon-android@17957b6#diff-fb05f829ceea869fb58eafc6203750f0c7d1a9d3a84b32a4e7903541ef065aa0

Mastodon instance

androiddev.social

Mastodon version

v4.2.1

Technical details

No response

[ClearlyClaire]

The keywords and statuses are only returned when you query the filter. They are left out of the filtered attribute because that information is generally not useful in that context and would cause an unwarranted increase in payload size.

[saket]

Gotcha. Can the documentation be updated to mark them as nullable in that case?

[trwnh]

Please file this against https://github.com/mastodon/documentation

[saket]

Done. Thanks!

mastodon/documentation#1343