Andras/BoundlessFlowCampus2K
4
7
Fork 0
Code Issues 90 Pull requests 7 Projects Releases Packages Wiki Activity Actions

Write endpoint documentation for menuService #1122

New issue
Closed
opened 2026-05-25 07:23:30 +00:00 by a22erigr · 3 comments
a22erigr commented 2026-05-25 07:23:30 +00:00
Collaborator
Copy link

Description

The wiki does not contain documentation about what endpoints the menuService contains and how to use them. This needs to be done.
I created a empty wiki page for it. Here

What should be done

  • Document all the endpoins of the service
  • Write what parameters should be used
  • What is the return value
  • Possible errors and what they mean
## Description The wiki does not contain documentation about what endpoints the menuService contains and how to use them. This needs to be done. I created a empty wiki page for it. [Here ](https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/menu-endpoints) ## What should be done + [ ] Document all the endpoins of the service + [ ] Write what parameters should be used + [ ] What is the return value + [ ] Possible errors and what they mean
c24elipe commented 2026-05-25 09:17:15 +00:00
Collaborator
Copy link

I have now written in the wiki https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Menu-Endpoints

I have now written in the wiki https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Menu-Endpoints
c22abdal commented 2026-05-25 10:59:38 +00:00
Collaborator
Copy link

Review

The wiki page is clear and well structured overall. Endpoint descriptions, parameters, and example responses are easy to follow and provide good API documentation.

# Review The wiki page is clear and well structured overall. Endpoint descriptions, parameters, and example responses are easy to follow and provide good API documentation.
a22erigr commented 2026-05-25 11:13:55 +00:00
Author
Collaborator
Copy link

@c22abdal wrote in #1122 (comment):

Review

The wiki page is clear and well structured overall. Endpoint descriptions, parameters, and example responses are easy to follow and provide good API documentation.

@c22abdal wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/1122#issuecomment-13770: > # [](#review)Review > > The wiki page is clear and well structured overall. Endpoint descriptions, parameters, and example responses are easy to follow and provide good API documentation.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
#1236-edit-mode-txt
#1229-generic-themed-buttons
Add-an-option-to-set-no-image-to-image-view-1227
#1242-prog-bar-colors-fix
#1239-Remove-Vertical-Scroll
Image-view-error-1230
Make-the-card-title-and-header-of-card-uniform-1233
both_teams_week_8
team_2_week_7
team_1_week_7
temp_branch_week_7
team_2_week_6
team_1_week_6
team_2_week_5
team_1_week_5
temp_branch_week_5
team_2_week_4
team_1_week_4
week_4_temp_branch
temp-branch-week-3
team_2_week_3
team_1_week_3
team_2_week_2
team_1_week_2
temp-week-2-merge-branch
team_2_week_1
team_1_week_1
No results found.
Labels
Clear labels   
_CRITICAL_

Only use this label for critical tasks that are project-scope,and must be addressed ASAP.

  
API

   
app

   
backEnd

   
Blocked, waiting for further changes

   
bug

Something is not working

  
cleanup

Issues to cleanup the codebase (restructure folders, remove deprecated or smelly code)

  
close

Issue to close

  
design

   
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
feature request

   
frontEnd

   
help wanted

Need some help

  
invalid

Something is wrong

  
low priority

   
needs input

Issue needs input from product owner or customer

  
needs review

issue is in need of review

  
project documentation

   
question

More information is needed

  
research

   
reviewed

This Issue has been reviewed

  
script

   
security

use this for security-related issues

  
SQL

  
style

   
testing

   
topLevel

Reserved for top-level, project-wide issues.

  
wontfix

This won't be fixed

No labels
_CRITICAL_
API
app
backEnd
Blocked, waiting for further changes
bug
cleanup
close
design
duplicate
enhancement
feature request
frontEnd
help wanted
invalid
low priority
needs input
needs review
project documentation
question
research
reviewed
script
security
SQL
style
testing
topLevel
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
c24elipe
c22abdal
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Andras/BoundlessFlowCampus2K#1122
No description provided.