Automatic commit when publishing documentation. Filling generated md-…

…files with method descriptions
Tinkoff · Feb 22, 2023 · 7885f21 · 7885f21
1 parent 226e1c3
commit 7885f21
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 0 deletions.
diff --git a/src/docs/contracts/common.proto b/src/docs/contracts/common.proto
@@ -21,6 +21,7 @@ enum InstrumentType {
   INSTRUMENT_TYPE_FUTURES = 5; //Фьючерс.
   INSTRUMENT_TYPE_SP = 6; //Структурная нота.
   INSTRUMENT_TYPE_OPTION = 7; //Опцион.
+  INSTRUMENT_TYPE_CLEARING_CERTIFICATE = 8; //Clearing certificate.
 }
 
 //Денежная сумма в определенной валюте

diff --git a/src/docs/contracts/instruments.proto b/src/docs/contracts/instruments.proto
@@ -130,6 +130,8 @@ message TradingDay {
   google.protobuf.Timestamp clearing_end_time = 13; // Время окончания основного клиринга в часовом поясе UTC.
   google.protobuf.Timestamp premarket_start_time = 14; // Время начала премаркета в часовом поясе UTC.
   google.protobuf.Timestamp premarket_end_time = 15; // Время окончания премаркета в часовом поясе UTC.
+  google.protobuf.Timestamp closing_auction_start_time = 16; // Время начала аукциона закрытия в часовом поясе UTC.
+  google.protobuf.Timestamp opening_auction_end_time = 17; // Время окончания аукциона открытия в часовом поясе UTC.
 }
 
 //Запрос получения инструмента по идентификатору.

diff --git a/src/docs/contracts/marketdata.proto b/src/docs/contracts/marketdata.proto
@@ -315,6 +315,14 @@ enum CandleInterval {
   CANDLE_INTERVAL_15_MIN = 3; //15 минут.
   CANDLE_INTERVAL_HOUR = 4; //1 час.
   CANDLE_INTERVAL_DAY = 5; //1 день.
+  CANDLE_INTERVAL_2_MIN = 6; //2 минуты.
+  CANDLE_INTERVAL_3_MIN = 7; //3 минуты.
+  CANDLE_INTERVAL_10_MIN = 8; //10 минут.
+  CANDLE_INTERVAL_30_MIN = 9; //30 минут.
+  CANDLE_INTERVAL_2_HOUR = 10; //2 часа.
+  CANDLE_INTERVAL_4_HOUR = 11; //4 часа.
+  CANDLE_INTERVAL_WEEK = 12; //1 неделя.
+  CANDLE_INTERVAL_MONTH = 13; //1 месяц.
 }
 
 //Список свечей.

diff --git a/src/docs/contracts/operations.proto b/src/docs/contracts/operations.proto
@@ -78,6 +78,8 @@ message Operation {
   OperationType operation_type = 13; //Тип операции.
   repeated OperationTrade trades = 14; //Массив сделок.
   string asset_uid = 16;	//Идентификатор актива
+  string position_uid	= 17; //position_uid-идентификатора инструмента.
+  string instrument_uid	= 18; //Уникальный идентификатор инструмента.
 }
 
 //Сделка по операции.
@@ -470,6 +472,7 @@ message OperationItem {
   string figi = 32; //Figi.
   string instrument_type = 33; //Тип инструмента.
   InstrumentType instrument_kind	= 34; //Тип инструмента.
+  string position_uid	= 35; //position_uid-идентификатора инструмента.
   MoneyValue payment = 41; //Сумма операции.
   MoneyValue price = 42; //Цена операции за 1 инструмент.
   MoneyValue commission = 43; //Комиссия.

diff --git a/src/docs/errors.md b/src/docs/errors.md
@@ -87,6 +87,13 @@
 30092|INVALID_ARGUMENT|trading unavailable on weekends|Торги недоступны по нерабочим дням.|
 30093|INVALID_ARGUMENT|missing parameter: 'figi' or 'instrument_id'|Один из параметров *figi* или *instrument_id* является обязательным.|
 30094|INVALID_ARGUMENT|options trading is not available at the moment|Выставление заявок по опционам недоступно.|
+30095|INVALID_ARGUMENT|the request was not executed by the exchange|Заявка не исполнена биржей.|
+30096|INVALID_ARGUMENT|the order was rejected, try again later|Заявка отклонена, попробуйте повторить позже.|
+30097|INVALID_ARGUMENT|inappropriate trading session|Сейчас эта сессия не идёт.|
+30098|INVALID_ARGUMENT|currently, there is no trading on this financial instrument|Торги по этому финансовому инструменту сейчас не проводятся.|
+30099|INVALID_ARGUMENT|the price is outside the limits for this instrument|Цена вне лимитов по инструменту или цена сделки вне лимита.|
+30100|INVALID_ARGUMENT|the price must be positive|Цена должна быть положительной.|
+30101|INVALID_ARGUMENT|to trade this financial instrument, pass the test|Для торговли этим инструментом пройдите тестирование.|
 40002|PERMISSION_DENIED|insufficient privileges|Недостаточно прав для совершения операции. </br>Токен доступа имеет уровень прав read-only, либо у токена нет доступа к указанному счету.</br>Подробнее: [Виды токенов](https://tinkoff.github.io/investAPI/index#_2)|
 40003|UNAUTHENTICATED|authentication token is missing or invalid|Токен доступа не найден или не активен. </br>Вы можете выпустить новый токен по ссылке [Настройки](https://www.tinkoff.ru/invest/settings/)|
 40004|PERMISSION_DENIED|Working with orders is not available with this account|Выставление заявок недоступно с текущего аккаунта.|

diff --git a/src/docs/errors/api_errors.json b/src/docs/errors/api_errors.json
@@ -424,6 +424,41 @@
     "type": "INVALID_ARGUMENT",
     "description": "Выставление заявок по опционам недоступно."
   },
+  "30095": {
+    "message": "the request was not executed by the exchange",
+    "type": "INVALID_ARGUMENT",
+    "description": "Заявка не исполнена биржей."
+  },
+  "30096": {
+    "message": "the order was rejected, try again later",
+    "type": "INVALID_ARGUMENT",
+    "description": "Заявка отклонена, попробуйте повторить позже."
+  },
+  "30097": {
+    "message": "inappropriate trading session",
+    "type": "INVALID_ARGUMENT",
+    "description": "Сейчас эта сессия не идёт."
+  },
+  "30098": {
+    "message": "currently, there is no trading on this financial instrument",
+    "type": "INVALID_ARGUMENT",
+    "description": "Торги по этому финансовому инструменту сейчас не проводятся."
+  },
+  "30099": {
+    "message": "the price is outside the limits for this instrument",
+    "type": "INVALID_ARGUMENT",
+    "description": "Цена вне лимитов по инструменту или цена сделки вне лимита."
+  },
+  "30100": {
+    "message": "the price must be positive",
+    "type": "INVALID_ARGUMENT",
+    "description": "Цена должна быть положительной."
+  },
+  "30101": {
+    "message": "to trade this financial instrument, pass the test",
+    "type": "INVALID_ARGUMENT",
+    "description": "Для торговли этим инструментом пройдите тестирование."
+  },
   "40002": {
     "message": "insufficient privileges",
     "type": "PERMISSION_DENIED",

diff --git a/src/docs/instruments.md b/src/docs/instruments.md
@@ -281,6 +281,8 @@
 | clearing_end_time |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Время окончания основного клиринга в часовом поясе UTC. |
 | premarket_start_time |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Время начала премаркета в часовом поясе UTC. |
 | premarket_end_time |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Время окончания премаркета в часовом поясе UTC. |
+| closing_auction_start_time |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Время начала аукциона закрытия в часовом поясе UTC. |
+| opening_auction_end_time |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Время окончания аукциона открытия в часовом поясе UTC. |
  <!-- end Fields -->
  <!-- end HasFields -->
 

diff --git a/src/docs/marketdata.md b/src/docs/marketdata.md
@@ -792,6 +792,14 @@ subscribeCandles | Изменения статуса подписки на св
 | CANDLE_INTERVAL_15_MIN | 3 | 15 минут. |
 | CANDLE_INTERVAL_HOUR | 4 | 1 час. |
 | CANDLE_INTERVAL_DAY | 5 | 1 день. |
+| CANDLE_INTERVAL_2_MIN | 6 | 2 минуты. |
+| CANDLE_INTERVAL_3_MIN | 7 | 3 минуты. |
+| CANDLE_INTERVAL_10_MIN | 8 | 10 минут. |
+| CANDLE_INTERVAL_30_MIN | 9 | 30 минут. |
+| CANDLE_INTERVAL_2_HOUR | 10 | 2 часа. |
+| CANDLE_INTERVAL_4_HOUR | 11 | 4 часа. |
+| CANDLE_INTERVAL_WEEK | 12 | 1 неделя. |
+| CANDLE_INTERVAL_MONTH | 13 | 1 месяц. |
 
 
  <!-- range .Enums -->

diff --git a/src/docs/operations.md b/src/docs/operations.md
@@ -147,6 +147,8 @@ Server-side stream обновлений информации по изменен
 | operation_type |  [OperationType](#operationtype) | Тип операции. |
 | trades | Массив объектов [OperationTrade](#operationtrade) | Массив сделок. |
 | asset_uid |  [string](#string) | Идентификатор актива |
+| position_uid |  [string](#string) | position_uid-идентификатора инструмента. |
+| instrument_uid |  [string](#string) | Уникальный идентификатор инструмента. |
  <!-- end Fields -->
  <!-- end HasFields -->
 
@@ -650,6 +652,7 @@ Server-side stream обновлений информации по изменен
 | figi |  [string](#string) | Figi. |
 | instrument_type |  [string](#string) | Тип инструмента. |
 | instrument_kind |  [InstrumentType](#instrumenttype) | Тип инструмента. |
+| position_uid |  [string](#string) | position_uid-идентификатора инструмента. |
 | payment |  [MoneyValue](#moneyvalue) | Сумма операции. |
 | price |  [MoneyValue](#moneyvalue) | Цена операции за 1 инструмент. |
 | commission |  [MoneyValue](#moneyvalue) | Комиссия. |