Site and Misc Endpoint Updates
Site and Misc Endpoint Updates
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 tocan_auth_user_moderate
in theCommentView
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 thePersonView
schema will now be equal to theuser_name
instead ofnull
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 theZ
at the end. - The
Site
schema can now return the site sidebar in html and markdown (if both formats are present). Thesidebar
field will continue to be html, while the newsidebar_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).