wjs018

As part of our ongoing effort to make our api self-documenting and validating our api input/output, we have been working through the api endpoints one at a time to make things a bit more consistent and logical. I just finished doing this for our existing /community endpoints and thought I would share the changelog here for awareness and feedback.

As of right now, these changes are only live on my instance and on our new, dedicated testing instance, crust.piefed.social. The self-documenting swagger for 1.2 (a WIP) can be found here.

1.2 Community Endpoints Changelog

• PUT /community
  • input parameter community_id properly documented (was previously erroneously documented as id)
• GET /community/list
  • made next_page nullable if there is no next page
  • this change was backported to 1.1 already
• GET /community/moderate/bans
  • banned_by replaces bannedBy - transitioning everything to snake case
  • banned_user replaces bannedUser - transitioning everything to snake case
  • expired_at replaces expiredAt - transitioning everything to snake case
  • expired_at value of null indicates a permanent ban
  • expired_at only returned if ban has expired
  • expires_at field added, only returned if ban is still in effect
  • expires_at value of null indicates permanent ban
• PUT /community/moderate/unban
  • same field name changes as above (snake_case instead of camelCase)
  • expired_at is now set equal to current time if ban was found (indicating that it was just set to expired) and returned in standard timestamp format found elsewhere in the api (2025-06-07T02:29:07.980084Z)
• POST /community/moderate/ban
  • Input:
    • expires_at replaces expiredAt/expired_at for input
    • expires_at uses standard timestamp format (2025-06-07T02:29:07.980084Z)
    • expires_at is optional
    • expires_at is checked to make sure it is in the future, raises an exception if it is not
    • permanent is new optional boolean field, supercedes expires_at if true
    • If expires_at is not provided and permanent is either false or not provided, then the ban is set to expire in one year
  • Output:
    • same field name changes as above (snake_case instead of camelCase)
    • expires_at value of null indicates permanent ban
    • standardize timestamp format of expires_at
    • only returns expires_at because it is a time in the future (does not return expired_at)

As part of our ongoing effort to make the piefed api self-documenting and validate the input and output, there have been a couple tweaks to the api. I realized that I should probably document them here since not everybody is keeping tabs on every codeberg PR that comes through the repo.

• canAuthUserModerate has been renamed to can_auth_user_moderate in the CommentView schema. This transitioning from camelCase to snake_case will be a theme as I work my way through the endpoints, this is just the first that I ran across.
• The title field in the PersonView schema will now be equal to the user_name instead of null if the user never set a display name. The way this was handled was a bit inconsistent between local and remote users, but now all users should have this behave the same way.
• All of the timestamps in the InstanceWithoutFederationState schema have been standardized to the same format. Previously, these were in the standard iso format, but didn't have the Z at the end.
• The Site schema can now return the site sidebar in html and markdown (if both formats are present). The sidebar field will continue to be html, while the new sidebar_md field will provide the markdown rendition of the sidebar. In the past, the sidebar was only in html, so the markdown version will only become available after an admin updates their instance's sidebar to use markdown instead of html.

That's all the changes that are live up to this point. I will continue to make posts in this community as changes are made to try to keep you all in the loop.

While we are talking about the future, other plans for the future are to have a dedicated development instance for testing bleeding edge code while keeping piefed.social on a more stable branch. In the meantime, feel free to peruse my instance's swagger ui (json version), which is up to date with the api changes as I am working on them (community endpoints are next).