Official, maintained Minehut API documentation

Minehut / Meta

Report bugs or issues and request features and updates for Minehut

31 stars 21 forks source link

Official, maintained Minehut API documentation #55

Open malloryhayr opened 4 years ago

malloryhayr commented 4 years ago

Feature request

Checklist

[x] I have read and agree to the README (found on https://github.com/Minehut/Meta)
[x] This is not a bug report, support request or plugin request
[x] I have searched the Issue Tracker to make sure this is not a duplicate issue
[x] This issue does not contain any sensitive information

Platform

Website

Describe the feature

Maintain official Minehut REST API documentation.

How the feature is useful

This will allow those who wish to build applications using the Minehut REST API to easily access documentation, rather than using unofficial, outdated sources.

Use 👍 and 👎 reactions to indicate you agree or disagree with this suggestion! Feel free to discuss the idea in the comments.

drtshock commented 4 years ago

@ZeroParticle pls

malloryhayr commented 4 years ago

Any update on this?

theminecoder commented 4 years ago

This probably won't come for a decent amount of time. The 'public' API we have isn't exactly intended for public use as it is. Over time there may be a project to clean up the responses and stuff to be more REST friendly but it will take a fair while to get there.

malloryhayr commented 4 years ago

This probably won't come for a decent amount of time. The 'public' API we have isn't exactly intended for public use as it is. Over time there may be a project to clean up the responses and stuff to be more REST friendly but it will take a fair while to get there.

Thanks for the reply. The main reason I'm waiting for API documentation is the updated authentication system.

theminecoder commented 4 years ago

Yeh they new auth system has essentially put us in a position of whether or not we want to start supporting custom uses of the public api or not. If we end up doing so the likely hood is we will need to switch to some form of api token method of authenticating for things other than the website, which none of us have talked about as of yet. Once we have a plan on how to proceed we will update this with more information.

KikoPT1234 commented 3 years ago

Any updates on this issue?

CoreyShupe commented 3 years ago

This probably won't happen until a lot of other things happen. This is low priority for us especially due to authentication changes.