Skip to content

Commit

Permalink
docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
grigoriev-semyon committed Sep 17, 2023
1 parent 94ceb11 commit 59fd4ff
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@

![Auth Schema](https://github.com/profcomff/auth-api/assets/5656720/ab2730be-054a-454c-ab76-5475e615bb64)

## Функционал
1. Управление категориями, параметрами, источниками данных.
2. Управление правами доступа к информации
3. Получение/изменение пользовательской информации через HTTP
4. Потоковое изменение пользовательской информации на основе данных передаваемых OAuth методами входа

- Про понятия использоованные в этом пункте можно почитать ниже(см. Основные абстракции)

## Запуск

1. Перейдите в папку проекта
Expand Down Expand Up @@ -36,13 +44,17 @@
Kafka worker нужен для того, чтобы разгребать поступающие от OAuth
методов авторизации AuthAPI пользовательские данные

## ENV-file description
## ENV-variables description

:star2: Все параметры для Kafka являются необязательными

- `DB_DSN=postgresql://postgres@localhost:5432/postgres` – Данные для подключения к БД
- `KAFKA_DSN` - URL для подключение к Kafka
- `KAFKA_LOGIN` - логин для подключения к Kafka
- `KAFKA_PASSWORD` - пароль для подключения к Kafka
- `KAFKA_TOPICS` - Kafka топики, из которых читается информация
- `KAFKA_GROUP_ID` - Группа, от имени которой происходит чтение топиков
- Остальные общие для всех АПИ параметры описаны [тут](https://github.com/profcomff/.github/wiki/%255Bbackend%255D-%25D0%259D%25D0%25B0%25D1%2581%25D1%2582%25D1%2580%25D0%25BE%25D0%25B9%25D0%25BA%25D0%25B8-%25D0%25BF%25D1%2580%25D0%25B8%25D0%25BB%25D0%25BE%25D0%25B6%25D0%25B5%25D0%25BD%25D0%25B8%25D1%258F)

## Основные абстракции

Expand Down Expand Up @@ -70,12 +82,6 @@ Kafka worker нужен для того, чтобы разгребать пос
| Личная информация | Email | GitHub | email5@github.email |
| Личная информация | Телефон | User | +79094242 |

## Функционал
1. Управление категориями, параметрами, источниками данных.
2. Управление правами доступа к информации
3. Получение/изменение пользовательской информации через HTTP
4. Потоковое изменение пользовательской информации на основе данных передаваемых OAuth методами входа


## Сценарий использования

Expand Down

0 comments on commit 59fd4ff

Please sign in to comment.