Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The documentation for Suggestion entity is outdated #1398

Open
anosidium opened this issue Jan 28, 2024 · 4 comments
Open

The documentation for Suggestion entity is outdated #1398

anosidium opened this issue Jan 28, 2024 · 4 comments
Labels
API The Mastodon core API

Comments

@anosidium
Copy link

anosidium commented Jan 28, 2024

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+.

@andypiper
Copy link
Sponsor Member

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

@trwnh
Copy link
Member

trwnh commented Feb 4, 2024

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

@ClearlyClaire
Copy link
Contributor

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 mastodon/mastodon#29108

@andypiper
Copy link
Sponsor Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API The Mastodon core API
Projects
None yet
Development

No branches or pull requests

4 participants