Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create temporary manual documentation for new endpoints (url examples with optionnal params) #248

Closed
Monstarrrr opened this issue Jul 3, 2024 · 0 comments
Closed

Create temporary manual documentation for new endpoints (url examples with optionnal params) #248

Monstarrrr opened this issue Jul 3, 2024 · 0 comments
Assignees
@purple-void
Labels
[ backend / [ documentation / Improvements or additions to documentation

Comments

@Monstarrrr
Copy link
Owner

Monstarrrr commented Jul 3, 2024 •
edited
Loading

Problem

The front-end needs clear API documentation to use API endpoints properly and implement them quickly.
The API endpoints aren't well documented by the default API doc generation, so some info needs to be included manually.

Solution

Add temporary info about the endpoints in the form of a list on discord or any channel.
@purple-void purple-void self-assigned this Jul 3, 2024
@purple-void purple-void added [ documentation / Improvements or additions to documentation [ backend / labels Jul 3, 2024
@purple-void purple-void mentioned this issue Jul 5, 2024
Closed
@Monstarrrr Monstarrrr closed this as not planned Won't fix, can't repro, duplicate, stale Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@purple-void purple-void

Labels
[ backend / [ documentation / Improvements or additions to documentation
Projects
Rebutify's MVP
Status: Done
Milestone
No milestone
Development

When branches are created from issues, their pull requests are automatically linked.

feat/248_endpoint_documentation Monstarrrr/rebutify
2 participants
@Monstarrrr @purple-void