devnote-dev / devnote-dev/ptero-notes

Example response models

Open
#9 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue help wanted
Dominant language
No language data
Stars
37
Forks
6
PR merge metrics
No merged PRs in 30d

Description

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](https://dashflo.net/docs/api/pterodactyl/v1/).

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing application API documentation and the comparable Dashflo API docs linked in the issue. Identify the applicable endpoints and add example JSON response models as references; it is done when each relevant endpoint has a documented example.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.