mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-21 12:51:30 +00:00
Scott Anderson
a182596d2c
## Description: Add an API backend / database feature request form. ## Please complete the following: - [x] I have added screenshots for all UI updates - [x] I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced - [x] I understand that submitting code with bugs that could have been caught through manual testing blocks releases and new features for all contributors --------- Co-authored-by: Scott Anderson <662325+scottanderson@users.noreply.github.com>
1.4 KiB
1.4 KiB
name, about, title, labels, assignees
| name | about | title | labels | assignees | ||
|---|---|---|---|---|---|---|
| 📝 API/DB Feature Request | Suggest a new backend API or database feature | [Feature] <short description here> |
|
✨ API/Database Feature Request
Summary
Describe the feature being requested. What functionality does it add to the backend or database? What problem does it solve?
📘 Use Case
Explain the use case behind this feature. Who is it for, and why is it needed now?
📥 Example API Request
POST /api/example-endpoint
Content-Type: application/json
Authorization: Bearer <token>
{
"exampleField": "value",
"anotherField": 123
}
📤 Example API Response
// JSON response
{
"id": "abc123",
"status": "success",
"data": {
"result": true,
"timestamp": "2025-04-30T18:00:00Z"
}
}
📦 Database Considerations
-
New Tables: Yes/No If yes, describe the schema or include a rough layout.
-
Modified Tables: Yes/No Describe what changes are needed and why.
-
Migrations Required: Yes/No
-
Indexes Required: Yes/No Include any thoughts on performance or query efficiency.
🔐 Security & Access Control
- Does the endpoint require authentication? Yes/No
- Should it be limited to specific roles (e.g. admin, worker, user)?
- Any sensitive data in the request or response?
📎 Additional Context
Add any screenshots, designs, relevant discussion links, or references to prior issues.