devnote-dev / ptero-notes Goto Github PK

This is used in the Wings API documentation already, but having a structured way for referencing sources for different endpoints and resources for all the APIs.

Provide documentation and references for the remote API in Pterodactyl, including interactions with the Wings API.

Currently different parts of documentation for the different APIs seem to be having their own variations of markdown formatting. This doesn't really help with consistency, especially when cross-referencing different APIs. It would be good to have a CONTRIBUTING.md file stating the formatting rules along with some other useful information for contributing.

It might also help to have markdown linting, perhaps as part of CI?

A section (probably in the main README) defining the appropriate terminology for the Pterodactyl and Wings APIs, as well as clarifications for incorrect or misinterpreted terms.

With the new guidelines being merged, all of the documents for the Pterodactyl API (and a few of the Wings API documents) need updating to the specification:

Application:

• Locations
• Nests/Eggs
• Nodes
• Users

Client:

• Account
• Backups
• Databases
• Files
• Network
• Schedules
• Servers
• Settings
• Startup
• Users
• Index

Remote:

• Server Backups
• Server Installation
• Servers

A futures.md file which will contain all the planned API changes going from v2 onward. This is often requested by people wanting to use the API in the long term, and there isn't currently an official or unofficial source stating the changes.

This is used in the application API documentation already, but having example JSON models for the applicable endpoints that can be used as references for people using the API, similarly to the Dashflo API docs.

Documentation should be provided for the /auth endpoints which are responsible for user authentication in the panel. It is not part of any specific API and is not classed as it's own separate one, so I think it would be best placed under /pterodactyl/auth. This should also include information and usage of session tokens.

Sources

• routes/auth.php
• app/Http/Requests/Auth
• app/Http/Controllers/Auth

There is a new endpoint on the wings, supposedly as of v1.10.0.

?v=2 Displays additional information.

The panel has an interesting locales endpoint which returns an object containing the localization/translation strings for the frontend. It's currently only used for activity logs but I believe its usage will increase in future versions. Is it worth documenting? It is also an endpoint that doesn't belong to any specific API, so its placement in the documentation is a bit confusing.

https://github.com/pterodactyl/panel/blob/b23f3114e4cb71406e6de17d0dca0d88205f56c1/routes/base.php#L12-L14

Full coverage of the client API is the goal here, there have been attempts here and from the original documentation but ideally this repo should have full coverage of all of the entire API.

Most of the endpoints for the application API has been covered with a few notable ones missing, like servers (for example). Ideally this should be covered entirely.

Having a detailed specification for JWT token generation and the usage in the different APIs (this is partially documented already via the claims sections). This is primarily for the Wings API but also includes a couple of endpoints from the client API.