TD-608: Add border api headers (#20)

* TD-608: Add border api headers

* Add newline

openapi/components/parameters/deadline.yaml

@@ -0,0 +1,11 @@
+name: X-Request-Deadline
+in: header
+description: Максимальное время обработки запроса
+required: false
+schema:
+  description: Максимальное время обработки запроса
+  type: string
+  maxLength: 40
+  minLength: 1
+  example: 10s
+  

openapi/components/parameters/requestID.yaml

@@ -0,0 +1,11 @@
+name: X-Request-ID
+in: header
+description: Уникальный идентификатор запроса к системе
+required: true
+schema:
+  description: Уникальный идентификатор запроса к системе
+  type: string
+  minLength: 1
+  maxLength: 32
+  example: 30672daac16a1f3c5e770a5a09626d1f
+  

openapi/docs/api.md

@@ -10,6 +10,15 @@ API-ключей, используемых для авторизации зап
 
 [OAS3]: https://swagger.io/specification/
 
+## Идентификатор запроса
+
+При любом обращении к API в заголовке `X-Request-ID` соответствующего запроса необходимо
+передать его уникальный идентификатор:
+
+```
+    X-Request-ID: 37d735d4-0f42-4f05-89fa-eaa478fb5aa9
+```
+
 ## Формат содержимого
 
 Любой запрос к API должен выполняться в кодировке UTF-8 и с указанием
@@ -18,3 +27,23 @@ API-ключей, используемых для авторизации зап
 ```
 Content-Type: application/json; charset=utf-8
 ```
+
+## Максимальное время обработки запроса
+
+При любом обращении к API в заголовке `X-Request-Deadline` соответствующего запроса можно
+передать параметр отсечки по времени, определяющий максимальное время ожидания завершения
+операции по запросу:
+
+```
+    X-Request-Deadline: 10s
+```
+
+По истечении указанного времени система прекращает обработку запроса. Рекомендуется указывать
+значение не более одной минуты, но не менее трёх секунд.
+
+`X-Request-Deadline` может:
+
+* задаваться в формате `date-time` согласно
+    [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339);
+* задаваться в относительных величинах: в миллисекундах (`150000ms`), секундах (`540s`) или
+    минутах (`3.5m`).

openapi/paths/apiKey.yaml

@@ -4,6 +4,8 @@ get:
   tags:
     - apiKeys
   parameters:
+    - $ref: '../components/parameters/requestID.yaml'
+    - $ref: '../components/parameters/deadline.yaml'
     - $ref: '../components/parameters/partyId.yaml'
     - $ref: '../components/parameters/apiKeyId.yaml'
   responses:

openapi/paths/apiKeyStatus.yaml

@@ -8,6 +8,8 @@ put:
   tags:
     - apiKeys
   parameters:
+    - $ref: '../components/parameters/requestID.yaml'
+    - $ref: '../components/parameters/deadline.yaml'
     - $ref: '../components/parameters/partyId.yaml'
     - $ref: '../components/parameters/apiKeyId.yaml'
   requestBody:

openapi/paths/apiKeys.yaml

@@ -4,6 +4,8 @@ get:
   tags:
     - apiKeys
   parameters:
+    - $ref: '../components/parameters/requestID.yaml'
+    - $ref: '../components/parameters/deadline.yaml'
     - $ref: '../components/parameters/partyId.yaml'
     - name: status
       description: |

openapi/paths/revokeApiKey.yaml

@@ -8,6 +8,8 @@ get:
   tags:
     - apiKeys
   parameters:
+    - $ref: '../components/parameters/requestID.yaml'
+    - $ref: '../components/parameters/deadline.yaml'
     - $ref: '../components/parameters/partyId.yaml'
     - $ref: '../components/parameters/apiKeyId.yaml'
     - $ref: '../components/parameters/apiKeyRevokeToken.yaml'