PieFed API & mobile app dev

POST /api/alpha/upload/image - upload an image, get a url back. Use that to construct markdown/html as you wish. Uploaded images are associated with the current user and count towards their quota (50 MB by default, tweakable by instance admin)

Hi devs and API enthusiasts!

I am created a piefed interface as a fun personal project but every time I try to create a post I get the following error:

For reasons unrelated to the api, rimu recently pushed piefed.social to the main branch for now. The piefed.social swagger page was acting as the home to the stable branch api docs, so that was no longer available anywhere. To remedy the situation in a more permanent fashion I created an instance whose sole purpose is to just live on the stable branch and serve the swagger docs.

GET /api/alpha/user/me - retrieves all the information about the current user, including all the things they’ve blocked, communities they have joined and communities they moderate.

POST /api/alpha/domain/block

There's a massive backlog of awesome stuff that really needs to be released so I'll be doing that within the next week or two.

I have taken a pass over another set of endpoints, this time the /user endpoints. Overall, there were less changes to these endpoints compared to previous groups I have done. Most of the work for this group focused on the /user/notifications endpoint. This is because marshmallow (the python library doing the schema validation for us) doesn't allow any kind of polymorphism in its schemata, thereby preventing the use of the anyOf part of the OpenAPI spec. So, I had to define a base notification schema and then tried to document the optional fields to indicate what fields would be present for which type of notification.

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.

Another post from me as I continue to work through endpoints. This endpoint is present in 1.1, but it is undocumented. AFAIK, only Boost has made use of it so far, so this might be of particular relevance for them. The updated swagger is available here for your perusal. If you have already experimented with this endpoint from 1.1, I have included the changelog below. So far, this is the only feed endpoint in the api, documented or otherwise. I am sure more will be added in the future.

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.

There is a NEW endpoint /api/alpha/post/replies. In the past comments/list was used to get lists of comments for a variety of situations, making it hard to debug, have many many parameters and it's response overly verbose. That endpoint will remain there, unchanged, for compatibility reasons. You can continue using it if this new endpoint is not to your liking.

Also /api/alpha/post/list now has a topic_id and a feed_id parameter, to get posts in those topics and feeds.

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.

Hello! I am getting 400 errors when hitting the piefed.social. Hitting other piefed instances appear to work.

GET /api/alpha/user was already returning default_sort_type but it now also returns default_comment_sort_type (for sorting comments, not posts). It was also returning show_nsfw and it now also returns show_nsfl.

At the bottom of https://codeberg.org/rimu/pyfedi/src/branch/main/app/api/alpha/routes.py#L869 you can see a bunch of endpoints that are not implemented. There are others we could do with too, like endpoints for feeds and topics...