sebastian/timemanager
Template
1
0
Fork 0
Code Issues 11 Pull Requests Actions Packages Projects Releases Wiki Activity
fea17c3fb9
timemanager/openapi.yaml

3021 lines
82 KiB
YAML
Raw Normal View History

Initial Commit (Frontend)
2023-09-25 11:01:28 +02:00
openapi: 3.0.0
info:
title: API Title
version: '1.0'
servers:
Deploy on docker (not productive yet!)
2023-11-12 16:43:39 +01:00
- url: http://127.0.0.1:8080/api
Initial Commit (Frontend)
2023-09-25 11:01:28 +02:00
paths:
/auth/signin:
post:
operationId: login
summary: Anmeldung
description: Nutzer meldet sich mit Name und Passwort an
tags:
- login
requestBody:
description: Anmeldedaten
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequest'
responses:
'200':
description: Anmeldung erfolgreich
content:
application/json:
schema:
$ref: '#/components/schemas/LoginResponse'
'401':
description: Benutzername/Passwort falsch
content:
application/json:
schema:
type: object
required:
- status
- error
- message
- path
additionalProperties: false
properties:
path:
type: string
description: Pfad auf den versucht wurde zuzugreifen
example: /api/users
error:
type: string
description: Error Cause
example: Unauthorized
status:
type: number
description: Statuscode
example: 401
/auth/signup:
put:
operationId: registrate
summary: Registierung
description: Ein Nutzer registriert sich mit Nutzername, Email und Passwort
tags:
- login
requestBody:
description: Anmeldedaten
content:
'application/json':
schema:
$ref: '#/components/schemas/SignUpRequest'
responses:
'200':
description: Registrierung erfolgreich
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
409:
description: Nutzer existiert bereits
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
errCode:
type: string
description: Fehlergrund
example: "mail"
enum:
- "mail"
- "username"
403:
description: Keine Berechtigung
content:
application/json:
schema:
type: object
required:
- "status"
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
/users:
get:
security:
- API_TOKEN: []
tags:
- users
summary: Alle Nutzer abfragen
description: Zeigt alle registerten Nutzer an
responses:
200:
description: Liste aller registrierten Benutzer
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/UserInfo'
put:
security:
- API_TOKEN: []
tags:
- users
summary: Nutzer hinzufügen
description: Fügt einen Nutzer hinzu
requestBody:
description: Benutzerinformationen
content:
'application/json':
schema:
$ref: '#/components/schemas/UserAddInfo'
responses:
200:
description: Operation erfolgreich
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
401:
description: Nicht angemeldet
403:
description: Keine Berechtigung
409:
description: Nutzer existiert bereits
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
errCode:
type: string
description: Fehlergrund
example: "mail"
enum:
- "mail"
- "username"
/users/{username}:
post:
security:
- API_TOKEN: []
tags:
- users
summary: Benutzer ändern
description: Ändert einen Benutzer
parameters:
- name: username
in: path
description: Benutzername
required: true
schema:
type: string
example: Fawkes100
requestBody:
description: Benutzerinformationen
content:
'application/json':
schema:
$ref: '#/components/schemas/UserUpdateInfo'
responses:
200:
description: Operation erfolgreich
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
401:
description: Nicht angemeldet
403:
description: Keine Berechtigung
404:
description: Falls der Benutzer nicht vorhanden ist
delete:
security:
- API_TOKEN: []
tags:
- users
summary: Benutzer löschen
description: Löscht einen Benutzer
parameters:
- name: username
in: path
description: Benutzername
required: true
schema:
type: string
example: Fawkes100
responses:
200:
description: Operation erfolgreich
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
401:
description: Nicht angemeldet
403:
description: Keine Berechtigung
404:
description: Falls der Benutzer unbekannt ist
/account/change-password:
post:
security:
- API_TOKEN: []
tags:
- account
summary: Passwort ändern
description: Ändert das Passwort
requestBody:
description: Altes und neues Passwort
content:
application/json:
schema:
$ref: "#/components/schemas/PasswordChangeRequest"
responses:
200:
description: Operation erfolgreich
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
401:
description: Nicht angemeldet
409:
description: Nicht angemeldet
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
/account/change-email:
post:
security:
- API_TOKEN: []
tags:
- account
summary: Email ändern
description: Ändert die hinterlegte mailadresse
requestBody:
description: Neue Email und Passwort
content:
application/json:
schema:
$ref: "#/components/schemas/EMailChangeRequest"
responses:
200:
description: Operation erfolgreich
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
401:
description: Nicht angemeldet
409:
description: Nicht angemeldet
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
/account/user-details:
get:
security:
- API_TOKEN: []
tags:
- account
summary: Nutzerinformationen
description: Fragt Nutzerdetails wie Email ab
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
$ref: '#/components/schemas/UserInfo'
409:
description: Invalided Passwort
401:
description: Nicht angemeldet
/account/delete-request:
post:
security:
- API_TOKEN: []
tags:
- account
summary: Eigenen Account löschen
description: Löscht eigenen Account
requestBody:
description: Informationen zur Sicherheitsüberprürfung
content:
'application/json':
schema:
$ref: "#/components/schemas/AccountDeleteRequest"
responses:
200:
description: Operation erfolgreich
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
409:
description: Ungültiges Passwort
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
'401':
description: Nicht angemeldet
/properties/signup:
get:
tags:
- properties
summary: Eigenschaft Registierung abfragen
description: Fragt ab, ob Registrierung aktiviert ist
responses:
200:
description: Operation erfolgreich
content:
application/json:
schema:
$ref: '#/components/schemas/PropertyInfo'
404:
description: Eigenschaft nicht gefunden
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
/settings/update:
post:
security:
- API_TOKEN: []
tags:
- properties
summary: Eigenschaften aktualisieren
description: Aktualisiert Einstellungen
requestBody:
description: Aktualisierte Einstellungen
content:
'application/json':
schema:
$ref: "#/components/schemas/PropertyUpdateRequest"
responses:
200:
description: Operation erfolgreich
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
401:
description: Nicht angemeldet
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
403:
description: Keine Berechtigung
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
/settings:
get:
security:
- API_TOKEN: []
tags:
- properties
summary: Einstellungen auflisten
description: Listet Einstellungen auf
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
$ref: '#/components/schemas/PropertiesInfo'
403:
description: Keine Berechtigung
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
401:
description: Keine Berechtigung
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
Structure Taskgroups in Hierarchies
2023-10-01 21:22:04 +02:00
/taskgroups/all:
Document API
2023-09-25 12:01:24 +02:00
get:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: list all taskgroups of authorized user
description: list all taskgroups of authorized user
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/TaskgroupEntityInfo'
Use backend as taskgroup source and add number active tasks
2023-10-28 11:22:14 +02:00
/taskgroups/tree:
get:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: list all top level taskgroups of authorized user
description: list all taskgroups of authorized user
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/RecursiveTaskgroupInfo'
Structure Taskgroups in Hierarchies
2023-10-01 21:22:04 +02:00
/taskgroups:
get:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: list all top level taskgroups of authorized user
description: list all taskgroups of authorized user
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/TaskgroupEntityInfo'
Document API
2023-09-25 12:01:24 +02:00
put:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: creates taskgroup
description: creates taskgroup
Component for adding Taskgroups
2023-09-25 12:46:45 +02:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskgroupFieldInfo'
Document API
2023-09-25 12:01:24 +02:00
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
$ref: '#/components/schemas/TaskgroupEntityInfo'
409:
description: Taskgroup already exists
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
/taskgroups/{taskgroupID}:
Structure Taskgroups in Hierarchies
2023-10-01 21:22:04 +02:00
get:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: get details of an existing taskgroup
description: get details of an existing taskgroup
parameters:
- name: taskgroupID
in: path
description: internal id of taskgroup
required: true
schema:
type: number
example: 1
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
Taskgroup-Navigation (Issue 13)
2023-10-22 11:39:25 +02:00
type: object
$ref: '#/components/schemas/TaskgroupDetailInfo'
Structure Taskgroups in Hierarchies
2023-10-01 21:22:04 +02:00
403:
description: No permission
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
Document API
2023-09-25 12:01:24 +02:00
post:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: edits taskgroup
description: edits taskgroup
parameters:
- name: taskgroupID
in: path
description: internal id of taskgroup
required: true
schema:
type: number
example: 1
Component for adding Taskgroups
2023-09-25 12:46:45 +02:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskgroupFieldInfo'
Document API
2023-09-25 12:01:24 +02:00
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
403:
description: No permission
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
409:
description: Taskgroup with that new name already exists
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
delete:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: deletes taskgroup
description: deletes taskgroup
parameters:
- name: taskgroupID
in: path
description: internal id of taskgroup
required: true
schema:
type: number
example: 1
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "success"
enum:
- "success"
403:
description: No permission
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
Delete and clear Tasks (Frontend)
2023-10-22 10:08:44 +02:00
/taskgroups/{taskgroupID}/clear:
delete:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: clears tasks
description: Deletes all tasks of that taskgroup
parameters:
- name: taskgroupID
in: path
description: internal id of taskgroup
required: true
schema:
type: number
example: 1
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
Select TaskgroupPaths
2023-11-19 13:19:53 +01:00
/taskgroups/path:
get:
security:
- API_TOKEN: []
tags:
- taskgroup
summary: lists all taskgrouppaths
description: lists all taskgroup-paths
responses:
200:
description: Operation successfull
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TaskgroupPathInfo'
Abstract API Endpoint to filter task fetch also by overdue
2023-10-29 13:13:29 +01:00
/tasks/all/{scope}/{detailed}:
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
get:
security:
- API_TOKEN: []
tags:
- task
summary: edits an existing task
description: edits an existing task
parameters:
Abstract API Endpoint to filter task fetch also by overdue
2023-10-29 13:13:29 +01:00
- name: scope
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
in: path
Abstract API Endpoint to filter task fetch also by overdue
2023-10-29 13:13:29 +01:00
description: defines scope of fetched tasks
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
required: true
schema:
Abstract API Endpoint to filter task fetch also by overdue
2023-10-29 13:13:29 +01:00
type: string
enum:
- FINISHED
- UNFINISHED
- OVERDUE
Upcoming tasks
2023-10-29 17:20:24 +01:00
- UPCOMING
- ACTIVE
Abstract API Endpoint to filter task fetch also by overdue
2023-10-29 13:13:29 +01:00
- name: detailed
in: path
description: determines whether an detailed response is required or not
required: true
schema:
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
type: boolean
example: true
responses:
200:
description: Operation successfull
content:
application/json:
schema:
Abstract API Endpoint to filter task fetch also by overdue
2023-10-29 13:13:29 +01:00
oneOf:
- type: array
items:
$ref: '#/components/schemas/TaskShortInfo'
- type: array
items:
Overdue tasks dashboard
2023-10-29 16:03:58 +01:00
$ref: '#/components/schemas/TaskTaskgroupInfo'
Abstract API Endpoint to filter task fetch also by overdue
2023-10-29 13:13:29 +01:00
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
Create and simple listing of all tasks
2023-10-02 10:35:02 +02:00
/tasks/{taskgroupID}/{status}:
get:
security:
- API_TOKEN: []
tags:
- task
summary: list tasks
description: list tasks
parameters:
- name: taskgroupID
in: path
description: internal id of taskgroup
required: true
schema:
type: number
example: 1
- name: status
in: path
description: scope of listed tasks
required: true
schema:
type: string
enum:
- all
- overdue
- upcoming
example: all
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/TaskEntityInfo'
403:
description: No permission
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
/tasks/{taskgroupID}:
put:
security:
- API_TOKEN: []
tags:
- task
summary: creates a new task
description: creates tasks
parameters:
- name: taskgroupID
in: path
description: internal id of taskgroup
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskFieldInfo'
Calling Edit Task API
2023-10-22 01:10:52 +02:00
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: object
$ref: '#/components/schemas/TaskEntityInfo'
403:
description: No permission
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
409:
description: Task already exist
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
/tasks/{taskID}:
post:
security:
- API_TOKEN: []
tags:
- task
summary: edits an existing task
description: edits an existing task
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskFieldInfo'
Create and simple listing of all tasks
2023-10-02 10:35:02 +02:00
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: object
$ref: '#/components/schemas/TaskEntityInfo'
403:
description: No permission
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
409:
description: Task already exist
content:
'application/json':
schema:
type: object
required:
- status
properties:
status:
type: string
description: Status
example: "failed"
enum:
- "failed"
Delete and clear Tasks (Frontend)
2023-10-22 10:08:44 +02:00
delete:
security:
- API_TOKEN: []
tags:
- task
summary: edits an existing task
description: edits an existing task
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
Design TaskOverview
2023-10-22 20:42:57 +02:00
get:
security:
- API_TOKEN: []
tags:
- task
summary: gets taskdetails
description: loads information about a given task
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/TaskEntityInfo"
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
Finishing Task from Taskoverview
2023-10-28 18:29:34 +02:00
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
/tasks/{taskID}/finish:
post:
security:
- API_TOKEN: []
tags:
- task
summary: finishs task
description: finish tasks
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
responses:
200:
description: Anfrage erfolgreich
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
Design TaskOverview
2023-10-22 20:42:57 +02:00
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
Display Subtasks in TaskDetail Component
2024-03-16 11:29:55 +01:00
/tasks/{taskID}/subtasks:
Ui Support for Creating Subtasks
2024-03-16 10:57:50 +01:00
put:
security:
- API_TOKEN: []
tags:
- task
description: Create Subtask
summary: Creates Subtask
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskFieldInfo'
responses:
200:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/TaskEntityInfo'
403:
description: No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Task not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
400:
description: Invalid start/end date
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
Display Subtasks in TaskDetail Component
2024-03-16 11:29:55 +01:00
get:
security:
- API_TOKEN: []
tags:
- task
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
responses:
200:
description: Operation successfull
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TaskEntityInfo'
403:
description: No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Task not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
Ui Support for Creating Subtasks
2024-03-16 10:57:50 +01:00
Delete Schedules
2023-10-23 21:35:42 +02:00
/schedules:
get:
security:
- API_TOKEN: []
tags:
- schedule
description: gets all schedules of user
summary: gets all schedules of user
responses:
200:
description: request successfull
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleInfo'
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
/schedules/{taskID}:
Design TaskOverview
2023-10-22 20:42:57 +02:00
get:
security:
- API_TOKEN: []
tags:
- schedule
description: gets schedules of task
summary: gets schedules of task
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
responses:
200:
description: operation successfull
content:
application/json:
schema:
type: array
items:
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
$ref: '#/components/schemas/ScheduleInfo'
Design TaskOverview
2023-10-22 20:42:57 +02:00
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
issue-20 (#46) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/46
2023-11-12 13:18:53 +01:00
/schedules/{taskID}/basic:
Include basic schedules of tasks
2023-10-23 19:56:16 +02:00
put:
security:
- API_TOKEN: []
tags:
- schedule
description: creates a basic schedule for a task
summary: creates basic schedule for task
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BasicScheduleFieldInfo'
issue-20 (#46) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/46
2023-11-12 13:18:53 +01:00
Include basic schedules of tasks
2023-10-23 19:56:16 +02:00
responses:
200:
description: operation successfull
content:
application/json:
schema:
type: object
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
$ref: '#/components/schemas/ScheduleInfo'
Include basic schedules of tasks
2023-10-23 19:56:16 +02:00
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
issue-20 (#46) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/46
2023-11-12 13:18:53 +01:00
/schedules/{taskID}/advanced:
put:
security:
- API_TOKEN: []
tags:
- schedule
description: creates a advanced schedule for a task
summary: creates advanced schedule for task
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedScheduleFieldInfo'
responses:
200:
description: operation successfull
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/ScheduleInfo'
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
/schedules/{scheduleID}/basic:
Delete Schedules
2023-10-23 21:35:42 +02:00
post:
security:
- API_TOKEN: []
tags:
- schedule
description: reschedules a task
summary: reschedules task
parameters:
- name: scheduleID
in: path
description: internal id of schedule
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BasicScheduleFieldInfo'
issue-20 (#46) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/46
2023-11-12 13:18:53 +01:00
Delete Schedules
2023-10-23 21:35:42 +02:00
responses:
200:
description: operation successfull
content:
application/json:
schema:
type: object
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
$ref: '#/components/schemas/ScheduleInfo'
Delete Schedules
2023-10-23 21:35:42 +02:00
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
issue-20 (#46) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/46
2023-11-12 13:18:53 +01:00
/schedules/{scheduleID}/advanced:
post:
security:
- API_TOKEN: []
tags:
- schedule
description: reschedules a task
summary: reschedules task
parameters:
- name: scheduleID
in: path
description: internal id of schedule
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedScheduleFieldInfo'
responses:
200:
description: operation successfull
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/ScheduleInfo'
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
/schedules/{scheduleID}:
Delete Schedules
2023-10-23 21:35:42 +02:00
delete:
security:
- API_TOKEN: []
tags:
- schedule
description: deletes a schedule
summary: deletes schedule
parameters:
- name: scheduleID
in: path
description: internal id of schedule
required: true
schema:
type: number
example: 1
responses:
200:
description: operation successfull
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/SimpleStatusResponse'
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
/schedules/{date}/{startable}:
Adapt Backend and OpenAPI description to fetch all schedules
2023-10-24 08:47:02 +02:00
get:
security:
- API_TOKEN: []
tags:
- schedule
description: get all schedules of today
summary: get today's schedules
Stop and Finish TaskSchedules
2023-10-26 09:40:36 +02:00
parameters:
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
- name: date
in: path
description: determines the scheduled dates of the schedules
required: true
schema:
type: string
format: date
nullable: true
- name: startable
Stop and Finish TaskSchedules
2023-10-26 09:40:36 +02:00
in: path
description: determines whether only schedules that can be started should be included or all schedules of today
required: true
schema:
type: boolean
example: true
Adapt Backend and OpenAPI description to fetch all schedules
2023-10-24 08:47:02 +02:00
responses:
200:
description: Operation successfull
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleInfo'
Start now
2023-10-24 19:58:12 +02:00
/schedules/{taskID}/now:
post:
security:
- API_TOKEN: []
tags:
- schedule
description: schedule task now
summary: schedule task now
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
responses:
200:
description: Operation successfull
content:
application/json:
schema:
type: object
Start task now from Taskoverview in Dashboard
2023-10-28 15:33:46 +02:00
$ref: '#/components/schemas/ScheduleInfo'
Start now
2023-10-24 19:58:12 +02:00
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Taskgroup does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
409:
description: Task is already running
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
Visualize Active Schedule and schedules todo
2023-10-25 20:25:04 +02:00
/schedules/active:
get:
security:
- API_TOKEN: []
tags:
- schedule
description: get active schedule
summary: get active schedule
responses:
200:
description: operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleInfo'
404:
description: there is no active schedule
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
/schedules/{scheduleID}/activate:
post:
security:
- API_TOKEN: []
tags:
- schedule
description: activates schedule
summary: activates schedule
parameters:
- name: scheduleID
in: path
description: internal id of schedule
required: true
schema:
type: number
example: 1
responses:
200:
description: Operation successfull
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/ScheduleActivateInfo'
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Schedule does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
409:
description: Task is already running
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
Stop and Finish TaskSchedules
2023-10-26 09:40:36 +02:00
/schedules/{scheduleID}/stop/{finish}:
post:
security:
- API_TOKEN: []
tags:
- schedule
parameters:
- name: scheduleID
in: path
description: internal id of schedule
required: true
schema:
type: number
example: 1
- name: finish
in: path
description: internal id of schedule
required: true
schema:
type: boolean
example: True
responses:
200:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/TaskScheduleStopResponse"
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Schedule does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
400:
description: Operation not valid
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
Include Working Status in Frontend Dashboard
2023-11-11 19:12:07 +01:00
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
/schedules/{taskID}/forgotten:
post:
security:
- API_TOKEN: []
tags:
- schedule
description: Registers forgotten schedule
summary: registers forgotten schedule
parameters:
- name: taskID
in: path
description: internal id of task
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ForgottenActivityRequest'
responses:
200:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/TaskScheduleStopResponse'
403:
description: No permission
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
404:
description: Schedule does not exist
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
400:
description: Operation not valid
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
List missed Schedules
2023-10-29 10:16:08 +01:00
/schedules/missed:
get:
security:
- API_TOKEN: []
tags:
- schedule
description: Registers forgotten schedule
summary: registers forgotten schedule
responses:
200:
description: Operation successfull
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleInfo'
403:
description: User not found/No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
Forget all missed schedules
2023-10-29 11:16:48 +01:00
/schedules/{scheduleIDs}/all:
delete:
security:
- API_TOKEN: []
tags:
- schedule
description: deletes multiple schedules at once
summary: deletes multiple schedules
parameters:
- name: scheduleIDs
in: path
description: internal ids of schedules to delete
required: true
schema:
type: array
items:
type: number
responses:
200:
description: Operation successfull
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SimpleStatusResponse'
403:
description: No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Schedule not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
issue-20 (#46) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/46
2023-11-12 13:18:53 +01:00
/schedules/{scheduleID}/details:
get:
security:
- API_TOKEN: []
tags:
- schedule
description: gets details of schedule
summary: load schedule
parameters:
- name: scheduleID
in: path
description: internal id of schedule
required: true
schema:
type: number
example: 1
responses:
200:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleInfo'
403:
description: No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Schedule not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
Implement Aborting and setting Manual Stop Time on Task-Schedules
2024-03-14 07:23:44 +01:00
/schedules/{scheduleID}/stopManual:
post:
security:
- API_TOKEN: []
tags:
- schedule
description: gets details of schedule
summary: load schedule
parameters:
- name: scheduleID
in: path
description: internal id of schedule
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManualScheduleStopInfo'
responses:
200:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleInfo'
403:
description: No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Schedule not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
issue-20 (#46) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/46
2023-11-12 13:18:53 +01:00
Include Working Status in Frontend Dashboard
2023-11-11 19:12:07 +01:00
/history/workingStatus:
get:
security:
- API_TOKEN: []
tags:
- history
description: get number of worked minutes today
summary: get number of active minutes
responses:
200:
description: operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleStatus'
404:
description: User not found
content:
'application/json':
schema:
type: object
$ref: "#/components/schemas/SimpleStatusResponse"
Build data of series by data provided through historyService
2023-11-19 14:52:33 +01:00
/statistics/taskgroup-activity/{taskgroupID}/{startingDate}/{endingDate}/{includeSubTaskgroups}:
get:
security:
- API_TOKEN: []
tags:
- history
parameters:
- name: taskgroupID
in: path
description: internal id of taskgroup
required: true
schema:
type: number
example: 1
- name: startingDate
in: path
description: starting date
required: true
schema:
type: string
format: date
- name: endingDate
in: path
description: starting date
required: true
schema:
type: string
format: date
- name: includeSubTaskgroups
in: path
description: determines whether to include subtaskgroups or not
required: true
schema:
type: boolean
example: false
responses:
200:
description: Operation successfull
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TaskgroupActivityInfo'
403:
description: No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Schedule not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
Implement Schedule History
2023-12-20 20:53:37 +01:00
/history/schedules/{date}:
get:
security:
- API_TOKEN: []
tags:
- history
description: Get schedules of the past
summary: List past schedules
parameters:
- name: date
in: path
description: date
required: true
schema:
type: string
format: date
responses:
200:
description: Operatio successfull
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleInfo'
Frontend to update ntfy data
2024-03-14 14:44:06 +01:00
/ntfy:
get:
security:
- API_TOKEN: []
tags:
- ntfy
description: Get ntfy information
summary: Get ntfy information
responses:
200:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/NtfyInformation'
404:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
post:
security:
- API_TOKEN: []
tags:
- ntfy
description: Edit ntfy information
summary: Edit ntfy information
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NtfyInformation'
responses:
200:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
Implement Backend Components for Creating Daily Taskseries
2024-03-15 08:57:54 +01:00
/tasks/{taskID}/taskseries/daily:
post:
security:
- API_TOKEN: []
tags:
- taskseries
description: Creates a daily repeating task
summary: daily repeating task creation
parameters:
- name: taskID
in: path
description: internal id of taskgroup
required: true
schema:
type: number
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskRepeatDayInfo'
responses:
200:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
403:
description: No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Task not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
400:
description: Invalid deadlineStrategy
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
Frontend Form for generating repeating tasks weekly
2024-03-16 09:30:48 +01:00
/tasks/taskseries/weekly:
post:
security:
- API_TOKEN: []
tags:
- taskseries
description: Creates a daily repeating task
summary: daily repeating task creation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskRepeatWeekInfo'
responses:
200:
description: Operation successfull
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
403:
description: No permission
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
404:
description: Task not found
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleStatusResponse'
Frontend to update ntfy data
2024-03-14 14:44:06 +01:00
Include Working Status in Frontend Dashboard
2023-11-11 19:12:07 +01:00
Initial Commit (Frontend)
2023-09-25 11:01:28 +02:00
components:
securitySchemes:
API_TOKEN:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
Delete and clear Tasks (Frontend)
2023-10-22 10:08:44 +02:00
SimpleStatusResponse:
required:
- status
additionalProperties: false
properties:
status:
type: string
description: Response Status der Request
example: "failed"
enum:
- success
- failed
Initial Commit (Frontend)
2023-09-25 11:01:28 +02:00
LoginRequest:
required:
- username
- password
additionalProperties: false
properties:
username:
type: string
description: Benutzername des Users
example: user
password:
type: string
description: Password des Users
example: pa$$word
format: password
LoginResponse:
required:
- status
additionalProperties: true
properties:
status:
type: string
description: Status
example: successfull
jwt:
type: string
description: JWT Token
example: jwttoken
UserAddInfo:
required:
- username
- email
- password
- admin
additionalProperties: false
properties:
username:
type: string
description: Benutzername
example: "FawKes100"
email:
type: string
description: "Mailadresse"
example: "mail@fawkes100.de"
format: "email"
password:
type: string
description: Passwort
example: "pa$$word"
format: password
admin:
type: boolean
description: Adminstatus
example: true
SignUpRequest:
required:
- username
- email
- password
additionalProperties: false
properties:
username:
type: string
description: Benutzername
example: "FawKes100"
email:
type: string
description: "Mailadresse"
example: "mail@fawkes100.de"
format: "email"
password:
type: string
description: Passwort
example: "pa$$word"
format: password
UserInfo:
required:
- username
- email
- admin
additionalProperties: false
properties:
username:
type: string
description: Benutzername
example: "covvacmap"
email:
type: string
description: "Mailadresse"
example: mail@fawkes100.de
admin:
type: boolean
description: Adminrechte erteilt
example: true
UserUpdateInfo:
description: Felder eines Benutzers die zu ändern sind
additionalProperties: false
properties:
password:
type: string
description: Zu setzendes Password des Nutzers
example: "Pa$$word"
admin:
type: boolean
description: Adminrechte erteilt
example: true
email:
type: string
description: "Email-Adresse des Nutzers"
example: mail@fawkes100.de
PasswordChangeRequest:
required:
- oldPassword
- newPassword
additionalProperties: false
properties:
oldPassword:
type: string
description: Bisheriges Passwort des Nutzers
example: "Pa$$word1"
newPassword:
type: string
description: Neues Passwort des Nutzers
example: "Pa$$word"
EMailChangeRequest:
required:
- password
- email
additionalProperties: false
properties:
password:
type: string
description: Passwort des Nutzers zu Sicherheitsüberpürfung
example: "Pa$$word1"
email:
type: string
description: Zusetzende Emailadresse des Nutzers
example: test@fawkes100.de
AccountDeleteRequest:
required:
- password
additionalProperties: false
properties:
password:
type: string
description: Passwort zur Sicherheitsüberprürfung
example: "Pa$$word1"
PropertyInfo:
required:
- property
- status
additionalProperties: false
properties:
property:
type: string
description: Name der Eigenschaft
example: "Registration disabled"
status:
type: boolean
description: Zustand der Eigenschaft
example: false
PropertyUpdateRequest:
required:
- settings
additionalProperties: false
properties:
settings:
type: array
items:
$ref: '#/components/schemas/PropertyInfo'
PropertiesInfo:
required:
- settings
additionalProperties: false
properties:
settings:
type: array
items:
Document API
2023-09-25 12:01:24 +02:00
$ref: '#/components/schemas/PropertyInfo'
TaskgroupEntityInfo:
required:
- taskgroupID
- taskgroupName
additionalProperties: false
properties:
taskgroupID:
type: number
description: internal id of taskgroup
example: 1
taskgroupName:
type: string
description: name of taskgroup
example: Taskgroup 1
maxLength: 255
minLength: 1
TaskgroupFieldInfo:
required:
- name
Structure Taskgroups in Hierarchies
2023-10-01 21:22:04 +02:00
- parentID
Document API
2023-09-25 12:01:24 +02:00
additionalProperties: false
properties:
name:
type: string
description: name of taskgroup
example: Taskgroup 1
maxLength: 255
Structure Taskgroups in Hierarchies
2023-10-01 21:22:04 +02:00
minLength: 1
parentID:
type: number
description: internal id of parent Taskgroup
example: 1
Taskgroup-Navigation (Issue 13)
2023-10-22 11:39:25 +02:00
TaskgroupDetailInfo:
required:
- children
- ancestors
- taskgroupInfo
additionalProperties: false
properties:
children:
type: array
items:
$ref: '#/components/schemas/TaskgroupEntityInfo'
ancestors:
type: array
items:
$ref: '#/components/schemas/TaskgroupEntityInfo'
taskgroupInfo:
type: object
$ref: '#/components/schemas/TaskgroupEntityInfo'
Create and simple listing of all tasks
2023-10-02 10:35:02 +02:00
TaskEntityInfo:
required:
- taskID
- taskName
- eta
- startDate
- deadline
- overdue
Delete and clear Tasks (Frontend)
2023-10-22 10:08:44 +02:00
- finished
Add information on workedTime, added Scheduler Component
2023-10-23 15:44:46 +02:00
- workTime
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
- finishable
Include status of task in taskdashboard
2023-11-18 10:21:37 +01:00
- hasActiveSchedules
Fix Status Color of Tasks
2023-12-18 14:07:05 +01:00
- hasPlannedSchedules
Disable daily task repetition when task is already part of a series
2024-03-16 09:37:42 +01:00
- hasTaskSerie
Hide copy function for subtasks (daily)
2024-03-16 14:04:57 +01:00
- hasSubtasks
- hasParent
Create and simple listing of all tasks
2023-10-02 10:35:02 +02:00
additionalProperties: false
properties:
taskID:
type: number
description: internal id of task
example: 1
taskName:
type: string
description: name of task
example: Vorlesung schauen
eta:
type: number
description: expected time to finish task
example: 10
minimum: 0
startDate:
type: string
format: date
description: date from which the task can be started
deadline:
type: string
format: date
description: date until the task has to be finished
overdue:
type: boolean
description: determines whether the task is overdue
example: True
Delete and clear Tasks (Frontend)
2023-10-22 10:08:44 +02:00
finished:
type: boolean
description: determines whether the task is finished
example: True
Add information on workedTime, added Scheduler Component
2023-10-23 15:44:46 +02:00
workTime:
type: number
description: number in minutes that was already worked on this task
example: 10
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
finishable:
type: boolean
description: determines whether the task can be finished
Include status of task in taskdashboard
2023-11-18 10:21:37 +01:00
hasActiveSchedules:
type: boolean
description: determines whether the task has active schedules
Fix Status Color of Tasks
2023-12-18 14:07:05 +01:00
hasPlannedSchedules:
type: boolean
description: determines whether the task has schedules that can be started
Disable daily task repetition when task is already part of a series
2024-03-16 09:37:42 +01:00
hasTaskSerie:
type: boolean
description: determines whether the task is associated with a taskserie
example: false
Hide copy function for subtasks (daily)
2024-03-16 14:04:57 +01:00
hasSubtasks:
type: boolean
description: determines whether a task has subtasks
example: true
hasParent:
type: boolean
description: determines whether a task is a top task or Not
example: false
Overdue tasks dashboard
2023-10-29 16:03:58 +01:00
TaskTaskgroupInfo:
required:
- taskID
- taskName
- eta
- startDate
- deadline
- overdue
- finished
- workTime
- taskgroups
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
- finishable
Overdue tasks dashboard
2023-10-29 16:03:58 +01:00
additionalProperties: false
properties:
taskID:
type: number
description: internal id of task
example: 1
taskName:
type: string
description: name of task
example: Vorlesung schauen
eta:
type: number
description: expected time to finish task
example: 10
minimum: 0
startDate:
type: string
format: date
description: date from which the task can be started
deadline:
type: string
format: date
description: date until the task has to be finished
overdue:
type: boolean
description: determines whether the task is overdue
example: True
finished:
type: boolean
description: determines whether the task is finished
example: True
workTime:
type: number
description: number in minutes that was already worked on this task
example: 10
taskgroups:
type: array
items:
$ref: '#/components/schemas/TaskgroupEntityInfo'
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
finishable:
type: boolean
description: determines whether the task can be finished
Create and simple listing of all tasks
2023-10-02 10:35:02 +02:00
TaskFieldInfo:
required:
- taskName
- eta
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
- finishable
Create and simple listing of all tasks
2023-10-02 10:35:02 +02:00
additionalProperties: false
properties:
taskName:
type: string
description: name of task
example: Vorlesung schauen
eta:
type: number
description: expected time to finish task
example: 10
minimum: 0
startDate:
type: string
format: date
description: date from which the task can be started
deadline:
type: string
format: date
Design TaskOverview
2023-10-22 20:42:57 +02:00
description: date until the task has to be finished
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
finishable:
type: boolean
description: determines whether the task can be finished
Design TaskOverview
2023-10-22 20:42:57 +02:00
BasicScheduleEntityInfo:
required:
- scheduleID
- scheduleDate
additionalProperties: false
properties:
scheduleID:
type: number
description: internal id of schedule
example: 1
scheduleDate:
type: string
format: date
description: date on which the task is scheduled
startTime:
type: string
format: date-time
description: date on which the task schedule was started
finishedTime:
type: string
format: date-time
description: date on which the tasks schedule was finished
Add information on workedTime, added Scheduler Component
2023-10-23 15:44:46 +02:00
activeTime:
type: number
description: number in minutes that the schedule was active
example: 10
Design TaskOverview
2023-10-22 20:42:57 +02:00
BasicScheduleFieldInfo:
required:
- scheduleDate
additionalProperties: false
properties:
scheduleDate:
type: string
format: date
description: date on which the task is scheduled
Delete Schedules
2023-10-23 21:35:42 +02:00
ScheduleInfo:
required:
- scheduleID
- scheduleType
Adapt Backend and OpenAPI description to fetch all schedules
2023-10-24 08:47:02 +02:00
- startTime
- finishTime
- activeMinutes
Deliver Schedule Path Info when fetching Schedules
2023-10-24 19:22:56 +02:00
- task
- taskgroupPath
Delete Schedules
2023-10-23 21:35:42 +02:00
additionalProperties: false
properties:
scheduleID:
type: number
description: internal id of schedule
example: 1
scheduleType:
type: string
description: type of schedule
example: BASIC
enum:
- BASIC
- MODERATE
- ADVANCED
Adapt Backend and OpenAPI description to fetch all schedules
2023-10-24 08:47:02 +02:00
startTime:
type: string
format: date-time
description: date on which the task schedule was started
finishedTime:
type: string
format: date-time
description: date on which the tasks schedule was finished
activeMinutes:
type: number
description: number in minutes that the schedule was active
example: 10
Deliver Schedule Path Info when fetching Schedules
2023-10-24 19:22:56 +02:00
task:
type: object
$ref: '#/components/schemas/TaskShortInfo'
taskgroupPath:
type: array
items:
$ref: '#/components/schemas/TaskgroupEntityInfo'
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
BasicScheduleInfo:
allOf:
- $ref: '#/components/schemas/ScheduleInfo'
- type: object
required:
- scheduleDate
additionalProperties: false
properties:
scheduleDate:
type: string
format: date
Deliver Schedule Path Info when fetching Schedules
2023-10-24 19:22:56 +02:00
TaskShortInfo:
required:
- taskID
- taskName
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
- finishable
Deliver Schedule Path Info when fetching Schedules
2023-10-24 19:22:56 +02:00
additionalProperties: false
properties:
taskID:
type: number
description: internal id of task
example: 1
taskName:
type: string
description: name of task
Visualize Active Schedule and schedules todo
2023-10-25 20:25:04 +02:00
example: "Vorlesung zusammenfassen"
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
finishable:
type: boolean
description: determines whether the task can be finished
Visualize Active Schedule and schedules todo
2023-10-25 20:25:04 +02:00
ScheduleActivateInfo:
required:
- startTime
additionalProperties: false
properties:
startTime:
type: string
format: date-time
Stop and Finish TaskSchedules
2023-10-26 09:40:36 +02:00
description: point in time at which the schedule was started
TaskScheduleStopResponse:
required:
- workTime
additionalProperties: false
properties:
workTime:
type: number
description: time where the schedule was active
Use backend as taskgroup source and add number active tasks
2023-10-28 11:22:14 +02:00
example: 10
RecursiveTaskgroupInfo:
required:
- taskgroupID
- taskgroupName
- childTaskgroups
- activeTasks
Visualize Overdue Taskgroups
2023-10-28 12:02:00 +02:00
- hasOverdueTask
- amountActiveTasks
Use backend as taskgroup source and add number active tasks
2023-10-28 11:22:14 +02:00
additionalProperties: false
properties:
taskgroupID:
type: number
description: internal id of taskgroup
example: 1
taskgroupName:
type: string
description: name of taskgroup
example: Taskgroup 1
maxLength: 255
minLength: 1
childTaskgroups:
type: array
items:
$ref: '#/components/schemas/RecursiveTaskgroupInfo'
activeTasks:
type: array
items:
$ref: '#/components/schemas/TaskOverviewInfo'
Visualize Overdue Taskgroups
2023-10-28 12:02:00 +02:00
hasOverdueTask:
type: boolean
example: true
description: determines whether the taskgroup has an overdue task or not
amountActiveTasks:
type: number
example: 2
description: determines the number of active tasks that can be scheduled
Use backend as taskgroup source and add number active tasks
2023-10-28 11:22:14 +02:00
TaskOverviewInfo:
required:
- taskID
- taskName
- activeMinutes
- eta
- limit
- overdue
Display TaskPath and not only TaskTitle in Schedules of calendar
2023-11-12 21:41:59 +01:00
- taskgroupPath
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
- finishable
Take subtasks in Dashboard into account (TaskOverview)
2024-03-16 14:18:23 +01:00
- hasSubtasks
Use backend as taskgroup source and add number active tasks
2023-10-28 11:22:14 +02:00
additionalProperties: false
properties:
taskID:
type: number
description: internal id of task
example: 1
taskName:
type: string
description: name of task
example: Vorlesung schauen
eta:
type: number
description: expected time to finish task
example: 10
minimum: 0
limit:
type: string
format: date
description: date until the task has to be finished
overdue:
type: boolean
description: determines whether the task is overdue
example: True
activeTime:
type: number
description: number in minutes that was already worked on this task
example: 10
Display TaskPath and not only TaskTitle in Schedules of calendar
2023-11-12 21:41:59 +01:00
taskgroupPath:
type: array
items:
$ref: '#/components/schemas/TaskgroupEntityInfo'
Unfinish task and allow unfinishable tasks
2023-11-18 09:36:26 +01:00
finishable:
type: boolean
description: determines whether the task can be finished
Take subtasks in Dashboard into account (TaskOverview)
2024-03-16 14:18:23 +01:00
hasSubtasks:
type: boolean
description: determines whether the task has subtasks
Visualize Anouncement for missed schedules
2023-10-28 19:27:13 +02:00
ScheduleStatus:
Load worked minutes when reloading dashboard
2023-10-28 18:54:17 +02:00
required:
- activeMinutes
Visualize Anouncement for missed schedules
2023-10-28 19:27:13 +02:00
- missedSchedules
Load worked minutes when reloading dashboard
2023-10-28 18:54:17 +02:00
additionalProperties: false
properties:
activeMinutes:
type: number
example: 1
Visualize Anouncement for missed schedules
2023-10-28 19:27:13 +02:00
description: number of minutes it was worked today
missedSchedules:
type: boolean
description: states whether a schedule was missed or not
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
example: true
ForgottenActivityRequest:
required:
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
- startTime
- endTime
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
additionalProperties: false
properties:
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
startTime:
Register Forgotten Activities
2023-10-29 09:47:57 +01:00
type: string
schedule-refactor (#45) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/45
2023-11-11 18:56:14 +01:00
format: date
description: time the schedule was started
endTime:
type: string
format: date
description: time the schedule was stopped
issue-20 (#46) Co-authored-by: Sebastian Böckelmann <uqpko@student.kit.edu> Reviewed-on: https://git.fawkes100.de/Sebastian/TimeManager/pulls/46
2023-11-12 13:18:53 +01:00
AdvancedScheduleInfo:
allOf:
- $ref: '#/components/schemas/ScheduleInfo'
- type: object
required:
- scheduleStartTime
- scheduleStopTime
additionalProperties: false
properties:
scheduleStartTime:
type: string
format: date-time
scheduleStopTime:
type: string
format: date-time
AdvancedScheduleFieldInfo:
required:
- scheduleStartTime
- scheduleStopTime
additionalProperties: false
properties:
scheduleStartTime:
type: string
format: date
scheduleStopTime:
type: string
Select TaskgroupPaths
2023-11-19 13:19:53 +01:00
format: date
TaskgroupPathInfo:
required:
Build data of series by data provided through historyService
2023-11-19 14:52:33 +01:00
- taskgroupPath
- directChildren
Fix statistics
2023-12-20 12:06:36 +01:00
- rootTasktroup
Select TaskgroupPaths
2023-11-19 13:19:53 +01:00
additionalProperties: false
properties:
Build data of series by data provided through historyService
2023-11-19 14:52:33 +01:00
taskgroupPath:
type: string
description: TaskgroupPath
directChildren:
Select TaskgroupPaths
2023-11-19 13:19:53 +01:00
type: array
items:
Build data of series by data provided through historyService
2023-11-19 14:52:33 +01:00
$ref: '#/components/schemas/TaskgroupEntityInfo'
Fix statistics
2023-12-20 12:06:36 +01:00
rootTasktroup:
type: object
$ref: '#/components/schemas/TaskgroupEntityInfo'
Build data of series by data provided through historyService
2023-11-19 14:52:33 +01:00
TaskgroupActivityInfo:
required:
- date
- activeMinutes
additionalProperties: false
properties:
date:
type: string
format: date
activeMinutes:
type: number
description: Number of minutes the task was active
Implement Schedule History
2023-12-20 20:53:37 +01:00
example: 122
Implement Aborting and setting Manual Stop Time on Task-Schedules
2024-03-14 07:23:44 +01:00
ManualScheduleStopInfo:
required:
- duration
additionalProperties: false
properties:
duration:
type: number
description: duration in minutes
Frontend to update ntfy data
2024-03-14 14:44:06 +01:00
example: 10
NtfyInformation:
required:
- ntfy_host
- ntfy_topic
additionalProperties: false
properties:
ntfy_host:
type: string
description: host of ntfy service
example: https://ntfy.fawkes100.de
ntfy_topic:
type: string
description: topic of ntfy service
example: Topicname
ntfy_user:
type: string
description: username of ntfy account for publishing news
example: password
ntfy_token:
type: string
Implement Backend Components for Creating Daily Taskseries
2024-03-15 08:57:54 +01:00
description: token to ntfy useraccount
TaskRepeatDayInfo:
required:
- offset
- deadlineStrategy
Frontend Components for Creating Daily Repeating Tasks
2024-03-15 09:43:38 +01:00
- endingDate
Implement Backend Components for Creating Daily Taskseries
2024-03-15 08:57:54 +01:00
additionalProperties: false
properties:
offset:
type: number
description: number repeating days
example: 7
minimum: 1
deadlineStrategy:
type: string
enum:
- DEADLINE_EQUAL_START
Frontend Components for Creating Daily Repeating Tasks
2024-03-15 09:43:38 +01:00
- DEADLINE_FIT_START
endingDate:
type: string
format: date
Frontend Form for generating repeating tasks weekly
2024-03-16 09:30:48 +01:00
description: Date until the tasks repeat
TaskRepeatWeekDayInfo:
required:
- offset
- taskID
additionalProperties: false
properties:
offset:
type: number
description: number repeating days
example: 7
minimum: 1
taskID:
type: number
description: internal identifier of task
example: 1
TaskRepeatWeekInfo:
required:
- weekDayInfos
- deadlineStrategy
- endDate
additionalProperties: false
properties:
deadlineStrategy:
type: string
enum:
- DEADLINE_EQUAL_START
- DEADLINE_FIT_START
endDate:
type: string
format: date
description: Date until the tasks repeat
weekDayInfos:
type: array
items:
$ref: '#/components/schemas/TaskRepeatWeekDayInfo'
maxLength: 7
minLength: 1
Reference in New Issue Copy Permalink