documentation icon indicating copy to clipboard operation
documentation copied to clipboard

The documentation for `Suggestion` entity is outdated

Open anosidium opened this issue 1 year ago • 4 comments

Please update the documentation for Suggestion entity as it is outdated as it broke my Mastodon client, Oliphaunt. I found out that there are new cases for source attribute:

  • featured
  • most_followed
  • most_interactions
  • friends_of_friends
  • similar_to_recently_followed

I don't know if there are any other new cases but these are the ones that I have found.

And the source attribute is now an array of String instead of just a String.

I am not too sure which Mastodon version these changes are effective but I think it might be from 4.3.0+, maybe 4.2.3+.

anosidium avatar Jan 28 '24 17:01 anosidium

Thanks for raising this as a documentation task. I think this was changed in this patch.

andypiper avatar Jan 30 '24 23:01 andypiper

Possibility of getting this changed upstream as it currently represents a breaking API change

trwnh avatar Feb 04 '24 02:02 trwnh

I unfortunately missed this change when reviewing #28314

We will restore the source attribute to a string consistent with what is currently described, and move the new attribute to sources.

See https://github.com/mastodon/mastodon/pull/29108

ClearlyClaire avatar Feb 06 '24 17:02 ClearlyClaire

Leaving this open, as we now need to document the sources attribute for the Suggestion entity.

andypiper avatar Feb 09 '24 21:02 andypiper