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

Complete and update Västtrafik API documentation #1211

New issue
Closed
opened 2026-05-28 06:25:56 +00:00 by b25marem · 4 comments
b25marem commented 2026-05-28 06:25:56 +00:00
Collaborator
Copy link

Description

The Västtrafik API documentation should be complete, clear, and up to date.

Västtrafik API wiki documentation contains unfinished sections and placeholder text.

What should be done

  • Complete the "Fetching data" section
  • Complete the "Data received" section
  • Remove placeholder text such as "Under construction API documentation"
  • Review and improve wording/formatting where needed
  • Verify that the documentation matches the current Västtrafik API usage in the project
## Description The Västtrafik API documentation should be complete, clear, and up to date. Västtrafik API wiki documentation contains unfinished sections and placeholder text. ## What should be done * Complete the "Fetching data" section * Complete the "Data received" section * Remove placeholder text such as "Under construction API documentation" * Review and improve wording/formatting where needed * Verify that the documentation matches the current Västtrafik API usage in the project
b25marem commented 2026-05-28 07:08:58 +00:00
Author
Collaborator
Copy link

Updated the Västtrafik API documentation by replacing unfinished placeholder sections with actual implementation details.

Added documentation for:

  • frontend data fetching flow
  • backend API endpoints
  • OAuth authentication flow
  • token handling and caching
  • simplified JSON response structure
  • frontend usage
  • database preparation for future development
  • environment variables

Also improved the overview and clarified how live traffic data is fetched from the external Västtrafik API.

Updated the Västtrafik API documentation by replacing unfinished placeholder sections with actual implementation details. Added documentation for: * frontend data fetching flow * backend API endpoints * OAuth authentication flow * token handling and caching * simplified JSON response structure * frontend usage * database preparation for future development * environment variables Also improved the overview and clarified how live traffic data is fetched from the external Västtrafik API.
b24idalu commented 2026-05-28 07:24:28 +00:00
Collaborator
Copy link

Content looks good! But I assume that there should be no big "coding field", or whatever it is called, here?
image

Content looks good! But I assume that there should be no big "coding field", or whatever it is called, here? ![image](/attachments/a01f1f86-a204-452f-b9bf-b63a30dd96c7)
image.png
62 KiB
b25marem commented 2026-05-28 07:45:05 +00:00
Author
Collaborator
Copy link

Fixed

Fixed
b24idalu commented 2026-05-28 07:46:38 +00:00
Collaborator
Copy link

Nice work, page seems done now

Nice work, page seems done now
👍 1
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
b25marem
b24idalu
2 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#1211
No description provided.