Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HoloAPI Base Spec #1

Open
AmaseCocoa opened this issue Sep 1, 2024 · 0 comments
Open

HoloAPI Base Spec #1

AmaseCocoa opened this issue Sep 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@AmaseCocoa
Copy link
Member

AmaseCocoa commented Sep 1, 2024

This is Base specification of Holo API.

API version on this specification: v0 (unstable)

1. Preamble

The Holo API is partially compatible with the Mastodon API. (Peers API, etc.. I don't use Mastodon and have no plans to implement a compatible API. I don't use Mastodon, so I don't plan to implement a compatible API. But if you are interested in keeping it, you can open a Pull Request :D)

Holo supports the full Misskey API for users. (The space under api/admin is not implemented as it is unlikely to be used by Misskey clients relative to the cost of implementation.) but, however, this is not available at this time as implementation will begin after the base API implementation is complete.

Holo uses REST with the exception of the Misskey compatible API (Misskey does not use REST).

Holo Supports Misskey Flavored Markdown (MFM).

The MFM is parsed on the server side and converted to html.

@AmaseCocoa AmaseCocoa added the documentation Improvements or additions to documentation label Sep 1, 2024
@AmaseCocoa AmaseCocoa changed the title api base spec HoloAPI Base Spec Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant