Document Akkoma API #678

Merged

floatingghost merged 4 commits from Oneric/akkoma:doc-akkomapi into develop 2024-02-16 12:20:12 +00:00

Conversation 2 Commits 4 Files changed 5 +174 -7

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

Owner

Copy link

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

Owner

Copy link

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

floatingghost commented 2024-02-16 12:20:07 +00:00

Owner

Copy link

thanks a lot! docs are good~

thanks a lot! docs are good~

floatingghost merged commit 874ee73a87 into develop 2024-02-16 12:20:12 +00:00

floatingghost deleted branch doc-akkomapi 2024-02-16 12:20:12 +00:00

floatingghost referenced this pull request from a commit 2024-02-16 12:20:13 +00:00

Merge pull request 'Document Akkoma API' (#678) from Oneric/akkoma:doc-akkomapi into develop

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

approved, awaiting change

  

broken setup

Issue arose from a misconfiguration by the admin, custom patches, manual db edits or similar

  

bug

Something is not working

  

cannot reproduce

  

configuration

This requires config changes

  

documentation

This is about human-readable docs

  

duplicate

This issue or pull request already exists

  

enhancement

New feature

  

extremely low priority

  

feature request

Something new?

  

Fix it yourself

Support has been attempted

  

help wanted

Need some help

  

invalid

Something is wrong

  

mastodon_api

  

needs change/feedback

Issue or PR is stalled on response from the author or a third party

  

needs docs

  

needs tests

  

not a bug

  

not our bug

Bug in a dependency of ours (meaning we can't just fix it), or in another AP implementation or client interfacing with Akkoma (which needs to be fixed on their end)

  

planned

  

pleroma_api

  

privacy

  

question

More information is needed

  

static_fe

  

triage

  

wontfix

This won't be fixed

No labels

approved, awaiting change

broken setup

bug

cannot reproduce

configuration

documentation

duplicate

enhancement

extremely low priority

feature request

Fix it yourself

help wanted

invalid

mastodon_api

needs change/feedback

needs docs

needs tests

not a bug

not our bug

planned

pleroma_api

privacy

question

static_fe

triage

wontfix

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

AkkomaGang/akkoma!678

No description provided.