LIL-57, LIL-59, LIL-62 docs markdown fixes

remotes/origin/hasaccess
nikita 8 years ago
parent a9f23be3a7
commit b57b69402f
  1. 2
      docs/README.md
  2. 12
      docs/api.md
  3. BIN
      docs/entities-diagram.png
  4. 13
      docs/overview.md
  5. 4
      docs/paymentwall.md
  6. 2
      docs/roles.md

@ -1,3 +1,5 @@
# Index
### [Обзор архитектуры](overview.md) ### [Обзор архитектуры](overview.md)
### [Описание API](api.md) ### [Описание API](api.md)
### [Работа с сервисом оплат Paymentwall](paymentwall.md) ### [Работа с сервисом оплат Paymentwall](paymentwall.md)

@ -1,13 +1,13 @@
#REST API # REST API
##Авторизация ## Авторизация
HTTP заголовок: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 HTTP заголовок: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
Токен возвращается в ответ на `/auth` Токен возвращается в ответ на `/auth`
##Статус коды ответов ## Статус коды ответов
Успех: 2ХХ Ошибка сервера: 5ХХ Ошибка входящего запроса (включая ошибки бизнес-логики): 4ХХ В ответе возвращается тип ошибки {"error": "E_VALIDATION"} Успех: 2ХХ Ошибка сервера: 5ХХ Ошибка входящего запроса (включая ошибки бизнес-логики): 4ХХ В ответе возвращается тип ошибки {"error": "E_VALIDATION"}
##Общие ошибки: ## Общие ошибки:
* E_VALIDATION Ошибка входящих параметров * E_VALIDATION Ошибка входящих параметров
* E_SESSION_EXPIRED Сессия истекла, пользователя нужно направить на форму авторизации * E_SESSION_EXPIRED Сессия истекла, пользователя нужно направить на форму авторизации
@ -16,10 +16,10 @@ HTTP заголовок: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXV
* E_NOT_FOUND Сущность не найдена * E_NOT_FOUND Сущность не найдена
* E_ACCESS Не достаточно прав для просмотра * E_ACCESS Не достаточно прав для просмотра
##Формат ответа ## Формат ответа
Ответ от сервера возвращается в JSON. Значение null описывает не установленное значение имеющегося поле. В UI должно выводиться как «Не установлено», прочерк и тп, в инпутах каститься в пустую строку Ответ от сервера возвращается в JSON. Значение null описывает не установленное значение имеющегося поле. В UI должно выводиться как «Не установлено», прочерк и тп, в инпутах каститься в пустую строку
##Работа с файлами ## Работа с файлами
Работа с файлами происходит единообразно в данных формы (multipart/form-data): Работа с файлами происходит единообразно в данных формы (multipart/form-data):
* загрузка/обновление: POST/PUT {param: text, ..., file: file} * загрузка/обновление: POST/PUT {param: text, ..., file: file}

Binary file not shown.

After

Width:  |  Height:  |  Size: 161 KiB

@ -1,7 +1,7 @@
##Обзор архитектуры ## Обзор архитектуры
###Backend ### Backend
Представляет из себя веб-приложение на Python с использованием Представляет из себя веб-приложение на Python с использованием
следующих фреймворков и технологий: Django-2.0.1 следующих фреймворков и технологий: Django-2.0.1
@ -11,7 +11,7 @@ CRUD для целей доступа к персистентным хранил
Данные хранятся в СУБД PostgreSQL 9.6.6 Данные хранятся в СУБД PostgreSQL 9.6.6
###Клиент проекта ### Клиент проекта
Имеются два клиента проекта: одностраничное приложение (SPA), Имеются два клиента проекта: одностраничное приложение (SPA),
реализующее интерфейс администратора, и серверное приложение для посетителей ресурса реализующее интерфейс администратора, и серверное приложение для посетителей ресурса
@ -34,7 +34,7 @@ CRUD для целей доступа к персистентным хранил
* react-0.14.7 * react-0.14.7
* webpack-1.12 * webpack-1.12
##Интеграции ## Интеграции
* Транзакционные письма Mailgun `django-anymail 1.2` * Транзакционные письма Mailgun `django-anymail 1.2`
* Рассылки писем Mailchimp `python-mailchimp 2.0` * Рассылки писем Mailchimp `python-mailchimp 2.0`
@ -42,5 +42,6 @@ CRUD для целей доступа к персистентным хранил
* Получение оплат Paymentwall `paymentwall-python 1.0` * Получение оплат Paymentwall `paymentwall-python 1.0`
* Авторизация в FB Facebook `django-facebook 6.0` * Авторизация в FB Facebook `django-facebook 6.0`
###Диаграмма сущностей проекта ### Диаграмма сущностей проекта
[Диаграмма сущностей проекта.png](https://lh4.googleusercontent.com/GNC1S1-ylduVcPPym4vfV4lrYrkTLB0lFfcevHd6paOv3NRvsB9L0pE9FIRked7d1qk6-h-sxk8RHg=w2560-h1312-rw)
![Диаграмма сущностей проекта.png](entities-diagram.png)

@ -1,4 +1,4 @@
#Paymentwall # Paymentwall
Для получения оплат от пользователей с помощью различных платежных систем используется [Paymentwall Checkout API](https://docs.paymentwall.com/integration/checkout-home) Для получения оплат от пользователей с помощью различных платежных систем используется [Paymentwall Checkout API](https://docs.paymentwall.com/integration/checkout-home)
Функциональные возможности: Функциональные возможности:
@ -8,7 +8,7 @@
* Управление купонами в Личном кабинет * Управление купонами в Личном кабинет
##Flow ## Flow
1. Пользователь на сайте выбирает продукт для приобретения 1. Пользователь на сайте выбирает продукт для приобретения
2. В БД сохраняется информации о приобретаемом продукте и начальном статусе оплаты: `pending` 2. В БД сохраняется информации о приобретаемом продукте и начальном статусе оплаты: `pending`

@ -1,4 +1,4 @@
#Роли и права # Роли и права
* guest - Незарегистрированный посетитетель * guest - Незарегистрированный посетитетель
* user - Зарегистрированный посетитель * user - Зарегистрированный посетитель

Loading…
Cancel
Save