Нотификация в изменениях API

Чтобы узнавать об изменениях в документации и api, вы можете подписаться на нотификации об изменении документации в github. Для этого

• установите любой RSS reader (например, RSS Feed Reader для chromium или FeedBro для Firefox)
• добавьте https://github.com/moysklad/api-remap-1.2-doc/commits/master.atom
• при любом изменении документации придёт нотификация и можно посмотреть, что именно изменилось.

Запуск локальной версии документации

Чтобы локально развернуть копию документации:

1. Установить docker CE и docker-compose, следуя инструкциям на https://docs.docker.com/ для своей ОС
2. Склонировать репозиторий https://github.com/moysklad/doc.git
3. В командной строке, перейдите в папку репозитория
4. Выполните команды docker-compose build docker-compose up

Локальная версия документации будет доступна по адресу http://localhost:4567

Основная версия документации доступна по адресу https://moysklad.github.io/api-remap-1.2-doc/api/remap/1.2/ru/

Описание репозитория и структуры документации

В ветке master находится версия документации, развернутая на продуктовом сервере. После мерджа измений в мастер будет запущен скрипт, и сделанные изменения станут доступны пользователям.

В папке source/includes находятся .md-файлы документации.

Оформление нового раздела

Для добавления нового раздела необходимо создать .md-файл в папке source/includes. Имя файла должно начинаться с _. Для отображения нового раздела в боковом меню в source/index.html.md в раздел includes нужно прописать название нового раздела (должно совпадать с названием .md-файла).

Пример разметки страницы:

## Заголовок раздела

### Название сущности
Описание сущности

#### Атрибуты сущности
Описание атрибутов сущности
+ **attribute** - описание аттрибута

#### Атрибуты доступные для фильтрации
При необходимости

#### Атрибуты доступные для сортировки
При необходимости

### Получить Сущности

**Параметры**

| Параметр | Описание            |
| ------------------------------ |:---------------------------|
|parameter |  Описание параметра |

> Получить Сущности

curl -X GET
  "https://api.moysklad.ru/api/remap/1.2/entity/some_entity"
  -H "Authorization: Basic <Credentials>"
  -H "Accept-Encoding: gzip"


> Response 200 (application/json)
Успешный запрос. Результат - JSON представление списка Сущностей

JSON ответа от сервера