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

Write protocol document outline and document existing commands #245

Merged
lars.winzer merged 6 commits from chore/61-write-protocol-document into main 2026-04-09 14:46:13 +02:00
Conversation 1 Commits 6 Files Changed 2
+11 -1
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 8bcd4dd033 - Show all commits
documents/docs/networking/commands/protocol-document.md
+11 -1
View File
@@ -93,13 +93,23 @@ Description of the command, what it does and when it should be used.
| :------------- | :----- | :---------------------------------- | :-------------------- | | :------------- | :----- | :---------------------------------- | :-------------------- |
| `param1` | `type` | If the parameter is optional or not | Description of param1 | | `param1` | `type` | If the parameter is optional or not | Description of param1 |
### Response ### Success Response
| Field | Type | Description | | Field | Type | Description |
| :------- | :------------------ | :-------------------- | | :------- | :------------------ | :-------------------- |
| `field1` | `type` | Description of field1 | | `field1` | `type` | Description of field1 |
| `field2` | `Collection<type2>` | | | `field2` | `Collection<type2>` | |
| `field3` | `Enum<type3>` | Description of field3 |
| Fields of `type2` | Type | Description | | Fields of `type2` | Type | Description |
| :---------------- | :----- | :-------------------- | | :---------------- | :----- | :-------------------- |
| `field1` | `type` | Description of field1 | | `field1` | `type` | Description of field1 |
| Members of `type` | Description |
| :---------------- | :--------------------- |
| `MEMBER1` | Description of member1 |
### Error Response
| Code | Discription |
| :----------- | :----------------------- |
| `ERROR_CODE` | Description of the error |
--> -->