TelegramAktienBot/documentation/README.md

32 lines
708 B
Markdown

# Dokumentation
## Swagger Documentation
Visit \<API_URL\> + /docs
## API
- `api/openapi.json`
- OpenAPI-Dokumentation
- von APIFlask generiert
- kann in Postman importiert werden
- `api/postman.json`
- Postman Collection
## Database
- `database/structure_database.pdf`
- Relationales Modell der Datenbank
- `database/structure_database.uxf`
- Relationales Modell der Datenbank
- Source Datei des Modells
## Requirements
- `requirements/2022-03-15 Anforderungen an Projekt.pdf`
- Anforderungen an dieses Projekt
## Role-model
Function|Admin|No Admin|
|---|---|---|
|Delete user|yes|only current user|
|Update users|yes|only current user|
|Set admin state|yes|no|
|Show all users|yes|no|