Skip to content

Client API documentation #7

Open
Open
Client API documentation#7
Labels
coverageThis covers undocumented APIsenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is needed

Description

@devnote-dev
devnote-dev
opened on Jun 3, 2023

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.

Activity

  1. devnote-dev
    added
    enhancementNew feature or request
    help wantedExtra attention is needed
    good first issueGood for newcomers
    coverageThis covers undocumented APIs
    on Jun 3, 2023

  2. bellatrick commented on Jun 11, 2023

    @bellatrick
    bellatrick
    on Jun 11, 2023
    Contributor

    Hello, I would love to work on this issue. How do i get started?

  3. devnote-dev commented on Jun 11, 2023

    @devnote-dev
    devnote-dev
    on Jun 11, 2023
    OwnerAuthor

    Hi, thanks for wanting to contribute! For the client API the majority of endpoints have been somewhat documented in the old Dashflo documentation, but a lot of these endpoints have incorrect or outdated information. Assuming you have access to a Pterodactyl instance, you can check the individual endpoints or you can read the client API source code (requests and controllers). The PteroJS API library may also be of help if you're confused about specific objects or typings.

    In terms of structure and formatting, each endpoint scope must have it's own file in the pterodactyl/client/ directory. For example, account endpoints would be under pterodactyl/client/account/account.md, server file endpoints would be under pterodactyl/client/servers/files.md, etc.). Ideally the format used in the wings/ directory is preferable but this can always be changed later on.

    Feel free to message here if you need help with anything. 👍

  4. bellatrick commented on Jun 11, 2023

    @bellatrick
    bellatrick
    on Jun 11, 2023
    Contributor

    Hi, thanks for wanting to contribute! For the client API the majority of endpoints have been somewhat documented in the old Dashflo documentation, but a lot of these endpoints have incorrect or outdated information. Assuming you have access to a Pterodactyl instance, you can check the individual endpoints or you can read the client API source code (requests and controllers). The PteroJS API library may also be of help if you're confused about specific objects or typings.

    In terms of structure and formatting, each endpoint scope must have it's own file in the pterodactyl/client/ directory. For example, account endpoints would be under pterodactyl/client/account/account.md, server file endpoints would be under pterodactyl/client/servers/files.md, etc.). Ideally the format used in the wings/ directory is preferable but this can always be changed later on.

    Feel free to message here if you need help with anything. 👍

    Awesome! I have gone through the code and the old documentation. How'd like to know how to get the API key to test the endpoints. The URL provided in the documentation is currently not available.

  5. devnote-dev commented on Jun 11, 2023

    @devnote-dev
    devnote-dev
    on Jun 11, 2023
    OwnerAuthor

    It would be the URLs in the documentation but with your domain name instead of pterodactyl.test. To get a client API key you need to go to <your.domain>/account/api and create one.

  6. bellatrick commented on Jun 12, 2023

    @bellatrick
    bellatrick
    on Jun 12, 2023
    Contributor

    It would be the URLs in the documentation but with your domain name instead of pterodactyl.test. To get a client API key you need to go to <your.domain>/account/api and create one.

    I can't figure out how to do this. I am assuming I'd have to run the Pterodactyl panel locally on my PC right? I'm currently stuck here.
    image

    If I can't test the endpoints, will going through the source code be sufficient for the documentation?

  7. devnote-dev commented on Jun 12, 2023

    @devnote-dev
    devnote-dev
    on Jun 12, 2023
    OwnerAuthor

    You'd need to get the panel logs to debug the issue, but that may be more effort than it's worth. Reading the source code would still be sufficient and possibly more useful if you need specific details about certain requests like validation rules, exceptions, etc.

  8. bellatrick commented on Jun 12, 2023

    @bellatrick
    bellatrick
    on Jun 12, 2023
    Contributor

    You'd need to get the panel logs to debug the issue, but that may be more effort than it's worth. Reading the source code would still be sufficient and possibly more useful if you need specific details about certain requests like validation rules, exceptions, etc.

    Alright 👍. Will do that

  9. real2two commented on Jun 13, 2023

    @real2two
    real2two
    on Jun 13, 2023
    Contributor

    Here's a useful resource if you need it: https://github.com/pterodactyl/panel/blob/develop/routes/api-client.php (source code)

  10. bellatrick commented on Jun 13, 2023

    @bellatrick
    bellatrick
    on Jun 13, 2023
    Contributor

    Here's a useful resource if you need it: https://github.com/pterodactyl/panel/blob/develop/routes/api-client.php (source code)

    Thank you. This will be very helpful

  11. Tarlsie commented on Jul 7, 2023

    @Tarlsie
    Tarlsie
    on Jul 7, 2023

    Hi do you need help with your API documentation?

  12. devnote-dev commented on Jul 7, 2023

    @devnote-dev
    devnote-dev
    on Jul 7, 2023
    OwnerAuthor

    Yes, any help is appreciated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    coverageThis covers undocumented APIsenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions