StrafesNET/maps-service
4
Fork 4
Code Issues 21 Pull Requests Packages Projects Releases Wiki Activity

Add descriptions to OpenAPI arguments that contain "magic numbers" #172

New Issue
Closed
opened 2025-06-07 17:37:59 +00:00 by itzaname · 0 comments
itzaname commented 2025-06-07 17:37:59 +00:00
Owner
Copy Link

I shouldn't have to dig through the source code to figure out what Sort=3 means or StatusID=4 means. OpenAPI spec allows descriptions so document these values there.

Example with Sort

image.png
I shouldn't have to dig through the source code to figure out what Sort=3 means or StatusID=4 means. OpenAPI spec allows descriptions so document these values there. Example with Sort <img width="456" alt="image.png" src="attachments/c0033fea-b0d7-4251-9f3a-c153094d94ff">
image.png
184 KiB
itzaname added the enhancement label 2025-06-07 17:37:59 +00:00
Quaternions was assigned by itzaname 2025-06-07 17:37:59 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
backend
Submissions api related
 bug
Something is not working
 duplicate
This issue or pull request already exists
 enhancement
New feature
 frontend
Website related
 help wanted
Need some help
 invalid
Something is wrong
 question
More information is needed
 validator
Map validation related
 wontfix
This won't be fixed
No Label enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
aidan9382 CI dowoge ic3w0lf22 interpreterK itzaname Quaternions
No Assignees Quaternions
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: StrafesNET/maps-service#172
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?