Document Akkoma API

Oneric commented

2024-01-31 23:45:50 +00:00

Member

Together with the various documentation fixes and additions from my other PRs, i believe all API-related Akkoma additions are now properly documented, though it’s possible I missed something (+ some few undocumented pre-Akkoma features like the dashboard).

Note that the example response for PUT /api/v1/akkoma/preferred_frontend was generated by modifying the source to accept any PUT request and hardcoding plerofma-fe/stable due to issues actually using this API endpoint normally; see #677

Together with the various documentation fixes and additions from my other PRs, i believe all API-related Akkoma additions are now properly documented, though it’s possible I missed something *(+ some few undocumented pre-Akkoma features like the dashboard)*. Note that the example response for `PUT /api/v1/akkoma/preferred_frontend` was generated by modifying the source to accept any PUT request and hardcoding `plerofma-fe/stable` due to issues actually using this API endpoint normally; see https://akkoma.dev/AkkomaGang/akkoma/issues/677

Oneric force-pushed doc-akkomapi from 134f16d16b to 7bc67f5dd5

2024-02-02 22:41:52 +00:00

Compare

~~katafrakt referenced this pull request 2024-02-03 13:29:31 +00:00~~

Fix OpenAPI spec for preferred_frontend endpoint #680

Oneric force-pushed doc-akkomapi from 7bc67f5dd5 to a325357f57

2024-02-15 15:07:57 +00:00

Compare

Oneric commented

2024-02-15 15:10:51 +00:00

Author

Member

i believe all API-related Akkoma additions are now properly documented, though it’s possible I missed something

yup, the bubble timeline API was not yet documented and as it turns out the documented identification name was outdated too. Added two more commits (+rebase) to take care of both

(side note: i really don’t like how Forgejo only ever displays the initially pushed commits in the conversation overview; making it easy to accidentally review an old version and not immediately notice newly added commits)

> i believe all API-related Akkoma additions are now properly documented, though **it’s possible I missed something** yup, the bubble timeline API was not yet documented and as it turns out the documented identification name was outdated too. Added two more commits (+rebase) to take care of both *(side note: i really don’t like how Forgejo only ever displays the initially pushed commits in the conversation overview; making it easy to accidentally review an old version and not immediately notice newly added commits)*

Oneric force-pushed doc-akkomapi from a325357f57 to cda597a05c

2024-02-15 15:26:21 +00:00

Compare