integrate/README.md

43 lines
888 B
Markdown
Raw Normal View History

2022-03-02 16:10:17 +01:00
# integrate
2022-03-06 12:31:12 +01:00
integrate all the api's
2022-03-02 16:10:17 +01:00
## Development
### Getting Started
```
2022-03-02 16:22:11 +01:00
make init
2022-04-22 18:34:48 +02:00
make up
# wait a moment for containers to start
2022-03-02 16:22:11 +01:00
make test
make run
2022-04-22 18:34:48 +02:00
make down
2022-03-03 16:36:08 +01:00
```
2022-04-29 14:13:54 +02:00
# notes
**Provider:** a leading system with userdata and a notification channel integrate can connect with (e.g. Authentik)
**Apps:** Have API that integrate can interact with and e.g. can create user (e.g. Nextcloud, Wekan)
## challenges
* How to handle errors in connected Apps
* Apps can have different unique constrains than the Provider
e.g. Wekan requires a unique Mail addr and authentik doesn't
the specifig module for the apps api needs to know how to handle these errors
* User in App could already exist
*
2022-03-03 16:36:08 +01:00
https://pydantic-docs.helpmanual.io/
2022-03-06 12:31:12 +01:00
https://jsontopydantic.com/
2022-04-22 18:34:48 +02:00
https://pydantic-docs.helpmanual.io/datamodel_code_generator/
https://docs.python.org/3/library/unittest.mock.html