refactor(readme.md): add new information about functions of the project

This commit is contained in:
Angelina Tingaeva 2023-11-29 12:14:47 +05:00
parent 64c730ad18
commit 9f662ed620

View File

@ -7,21 +7,36 @@
| поля json Asana | поля json Яндекс Трекер | Описание поля | | поля json Asana | поля json Яндекс Трекер | Описание поля |
| ------ | ------ | ------ | | ------ | ------ | ------ |
| "gid" | "id" | "Идентификатор" | | "gid" | "id" | "Идентификатор" |
| "name" | "name" | "Наименование" | | "name" | "summary" | "Наименование" |
| "notes" | "descriptions" | "Описание задачи" | | "notes" | "descriptions" | "Описание задачи" |
| "created_at" | "createdAt" | "Дата создания задачи" | | "created_at" | "createdAt" | "Дата создания задачи" |
| "due_on" | "deadline" | "Срок завершения задачи- дэдлайн" | | "due_on" | "deadline" | "Срок завершения задачи- дэдлайн" |
| "assignee" | "assignee" | "Логин или идентификатор исполнителя" | | "assignee" | "assignee" | "Логин или идентификатор исполнителя" |
| "section" | "milestone" | "Категория" |
| "memberships" | "memberships" | "Участники задачи" |
| " - " | "parent" | "Связка с родительской задачей" |
| "completed" | "status" | "Степень завершения" |
## Бонусом - можно получить ключевую информацию об участниках задач в Asana ## Бонусом - можно получить ключевую информацию об участниках задач в Asana
- ✨ Name ✨ - ✨ Name ✨
- ✨ ID (GID - по версии Asana) ✨ - ✨ ID (GID - по версии Asana) ✨
## Созданные файлы: ## Созданный файл:
| ✨ output.csv ✨ | выгруженные данные по участникам задач в Asana | | ✨ users.mapping.asana2ya.csv ✨ | выгруженные данные по участникам задач в Asana |
> файл нужен для подгрузки в поле assignee.
## Для подгрузки задач в Яндекс Трекер используются:
- ```bash
base_url: 'https://api.tracker.yandex.net/v2/issues/_import'
```
- headers:
- ✨ 'Host': 'api.tracker.yandex.net' ✨
- ✨ 'Authorization': 'OAuth <token>' ✨
- ✨ 'X-Org-ID': <ID>
- ✨ 'Content-Type': 'appication/json' ✨
## При получении ответов от API:
- ✨ при статусе 201 - 'Задача успешно создана в ЯндексТрекер' ✨
- ✨ в ином случае (при ошибке) - 'Ошибка при создании задачи в ЯндексТрекер:' ✨