Remote API documentation

[real2two]

Remote API documentation

I decided start documenting Pterodactyl Panel's remote API routes.

Quick side note: I might be missing some optional parameters Pterodactyl Panel sends to Wings on my documentation, but I didn't include them because Wings never uses them.

Todo

• Explain headers in README.md.
• Replace 'example body's with actual example values, instead of the type.
• Responses, including errors.
• Provide example response models. Example response models #9 (edit: besides one route I couldn't figure out.)

[devnote-dev]

Please mark the PR as a draft then update it when it's ready for review.

[real2two]

I'm going to note that I might be missing some optional parameters/body on some routes. I'll try to fix anything I can find, but I can't guarantee anything.

[devnote-dev]

That's fine, when it's ready for review I'll go through the whole API.

[real2two]

I couldn't find this remote API route in Pterodactyl Panel's develop branch, which is pretty interesting.

POST /servers/:server/archive - The function's name is "SetArchiveStatus".
https://github.com/pterodactyl/wings/blob/bd26d6eefddcdbdc14779ae61b1ff126820241da/remote/servers.go#L104

[real2two]

I gave up response examples for GET /api/remote/backups/:backup, because I couldn't figure out how to get S3 to properly work on Pterodactyl Panel.

I decided to leave the response example as "WIP.", but everything else is complete, unless there are any small issues I need to change.

[real2two]

Please read this:

• I placed events in activity_events.md. I didn't provide any descriptions for each event.
• I have no idea what data.parts[].etag and data.parts[].part_number does in POST /api/remote/backups/:backup, so I added "???" as a placeholder description, so you might want to check that out.