University-of-Basel-Studentprojects/Programmierprojekt
Archived
1
0
Fork 0
Code Issues 17 Pull Requests Actions Wiki Activity

Write protocol document #61

New Issue
Closed
opened 2026-04-09 12:40:41 +02:00 by lars.winzer · 9 comments
lars.winzer commented 2026-04-09 12:40:41 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

Task

Summary

The milestone achievement "Product: Protocol Document" requires a dedicated (not in the source code) document listing all commands together with an example.

Context

Documentation

Current Progress

  • Came up with a structure each command should adhere to
  • Wrote the scaffolding for the documentation
  • Included already existing commands in the documentation

Notes

Each command should have the following sections:

  • Title (name of the command itself)
  • Description
  • Required checks (link to each check)
  • Request parameter
  • Success response (as hierarchical table)
  • Possible error responses (excluding defaults and those by checks)
  • Example request and response

Checklist

  • I outlined checkpoints describing phases of my work related to this task
  • I added relevant labels
  • I linked to other issues or branches that must be completed first
## Task <!--The reccommended type is: Task--> ### Summary The milestone achievement "Product: Protocol Document" requires a dedicated (not in the source code) document listing all commands together with an example. ### Context Documentation ### Current Progress - [x] Came up with a structure each command should adhere to - [x] Wrote the scaffolding for the documentation - [x] Included already existing commands in the documentation ### Notes Each command should have the following sections: * Title (name of the command itself) * Description * Required checks (link to each check) * Request parameter * Success response (as hierarchical table) * Possible error responses (excluding defaults and those by checks) * Example request and response ### Checklist - [x] I outlined checkpoints describing phases of my work related to this task - [x] I added relevant labels - [x] I linked to other issues or branches that must be completed first
lars.winzer commented 2026-04-09 12:40:51 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

assigned to @lars.winzer

assigned to @lars.winzer
lars.winzer commented 2026-04-09 12:41:27 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

created branch chore/61-write-protocol-document to address this issue

created branch [`chore/61-write-protocol-document`](/cs108-fs26/Gruppe-13/-/compare/main...chore%2F61-write-protocol-document) to address this issue
lars.winzer commented 2026-04-09 13:29:38 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

marked the checklist item Came up with a structure each command should adhere to as completed

marked the checklist item **Came up with a structure each command should adhere to** as completed
lars.winzer commented 2026-04-09 13:30:03 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

changed the description

changed the description
lars.winzer commented 2026-04-09 13:58:49 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

marked the checklist item Wrote the scaffolding for the documentation as completed

marked the checklist item **Wrote the scaffolding for the documentation** as completed
lars.winzer commented 2026-04-09 13:59:11 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

added 1h 6m of time spent at 2026-04-09 12:00:00 +0200

added 1h 6m of time spent at 2026-04-09 12:00:00 +0200
lars.winzer commented 2026-04-09 14:21:55 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

marked the checklist item Included already existing commands in the documentation as completed

marked the checklist item **Included already existing commands in the documentation** as completed
lars.winzer commented 2026-04-09 14:44:28 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

mentioned in merge request !89

mentioned in merge request !89
lars.winzer commented 2026-04-09 14:46:13 +02:00 (Migrated from git.scicore.unibas.ch)
Copy Link
Copy Source

mentioned in commit c42dc09c0e

mentioned in commit c42dc09c0e056b04bb7de310bb465f51bd0c0a30
lars.winzer (Migrated from git.scicore.unibas.ch) closed this issue 2026-04-09 14:46:14 +02:00
This repo is archived. You cannot comment on issues.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
achievement
Tasks related to milestone achievements
 bug
Issues related to programming errors on both client and server
 ci
Issues related to problems with the gitlab ci (incorrect or missing jobs)
 client
Issues (To-Dos and tasks) related to the client
 commands
Issues and tasks related to commands and thier infrastructure (CommandHandler, CommandParser, ...)
 documentation
Issues related to the documentation (for new or unclear, incorrect or incomplete entries)
 enhancement
Issues related to enhancements (also known as feature-requests)
 game-engine
Issues related to the game engine (incorrect state transitions or move validations)
 linting
Issues related to linting i.e. false detections, too generous linting, ...
 messages
Issues and tasks related to the messages and chats
 network
Issues and tasks related to the network (SessionReader / SessionWriter, Parser, ResponseBody, ...)
 outreach
Issues and tasks related to the outreach website and everything directly related to it
 server
Issues (To-Dos and tasks) related to the server
 task
Issues outlining and discussing a general task or implementation
 templates
Issues related to GitLab templates
 ui
Issues and tasks related to the client-side ui
 unit-test
Issues related to missing or already planned unit tests
 user
Issues and tasks related to the user management
No Label documentation task
Milestone
No items
No Milestone Milestone 4
Assignees
Clear assignees
lars-winzer (Lars Winzer)
No Assignees
1 Participants
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: University-of-Basel-Studentprojects/Programmierprojekt#61
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?