Me again, here to document some more upcoming api changes as the self-documentation adventure continues. This time, it is the /topic/list endpoint. Similar to feeds, this endpoint exists in 1.1, but it was undocumented. This has led to it not being widely used yet, so I have taken the liberty to make a series of changes to it to help it be more consistent with other endpoints. This has mostly taken the form of field name changes. In the end, this endpoint now looks and functions very similarly to /feed/list by design.
Here is the updated swagger running on crust, and here is the codeberg PR if you prefer to look things over there.
If you have made use of this endpoint in its 1.1 form, I have included a changelog compared to 1.1 below. Let me know if there are any questions/feedback/requested changes.
Changes from 1.1:
- Added
include_communities request parameter. Functions exactly the same way as the /feed/list endpoint.
- Dropped
version field
- Multiple field name changes for better consistency with other endpoints. I have summarized them in the table below:
| Old field name |
New Field name |
num_communities |
communities_count |
name |
title |
machine_name |
name |
parent_id |
parent_topic_id |
show_posts_in_children |
show_posts_from_children |
Again, pinging @rmayayo@lemmy.world to let you know about these tweaks since I believe you are using the 1.1 version of this endpoint.