add: documentation

2026-06-30 15:45:24 +04:00
parent 540c1f7293
commit ca276d200f
1055 changed files with 47294 additions and 0 deletions
@@ -0,0 +1,55 @@
+# Operations: nubes_dummy
+
+| Operation | Kind | Action | Subresource | ID | Params | Description |
+|---|---|---|---|---|---|---|
+| `create` | `instance` | `create` | `` | `18` | durationMs, failAtStart, failInProgress, whereFail, resourceRealm, bodymessage, mapExample, jsonExample, nestedRefExample, yamlExample, mapFixed, arrayMapFixedExample | Это мануал к операции CREATE сервиса Болванка |
+| `delete` | `instance` | `delete` | `` | `71` |  |  |
+| `modify` | `instance` | `modify` | `` | `92` | durationMs, failAtStart, failInProgress, whereFail, bodymessage, mapExample, jsonExample |  |
+| `redeploy` | `action` | `redeploy` | `` | `240` |  |  |
+| `resume` | `instance` | `resume` | `` | `94` |  |  |
+| `suspend` | `instance` | `suspend` | `` | `93` |  |  |
+
+## Operation: create
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `durationMs` | `integer &gt;= 0` | `ДА` | `0` | перед завершением подождать (sleep) столько миллисекунд | перед завершением подождать (sleep) столько миллисекунд |  | `198` |
+| `failAtStart` | `boolean` | `ДА` | `false` | если true, завершить джоб, ничего не записывая в cmdb | **Операция не будет завершена**<br/>Она будет в постоянном статусе PENDING, однако в Jenkins Job завершится с ошибкой | value_list=false, true | `199` |
+| `failInProgress` | `boolean` | `ДА` | `false` | если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb | если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb | value_list=false, true | `200` |
+| `whereFail` | `integer &gt; 0` | `НЕТ` | `1` | принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write | принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write | value_list=1, 2, 3 | `201` |
+| `resourceRealm` | `string` | `ДА` | `` | Платформа для развертывания | Наименование ресурсной платформы для подключения | func=getAvailableResourceRealms | `242` |
+| `bodymessage` | `string` | `НЕТ` | `` | Дата, уходящая в Vault | Дата, уходящая в Vault |  | `286` |
+| `mapExample` | `map` | `НЕТ` | `` |  |  |  | `321` |
+| `jsonExample` | `json` | `НЕТ` | `` | Для тестирования интерфейса | Для тестирования интерфейса. Сюда можно писать корректный json |  | `322` |
+| `nestedRefExample` | `` | `НЕТ` | `` |  |  |  | `396` |
+| `yamlExample` | `yaml` | `НЕТ` | `` |  |  |  | `447` |
+| `mapFixed` | `map-fixed` | `НЕТ` | `` | Новый тип поля |  |  | `647` |
+| `arrayMapFixedExample` | `array-map-fixed` | `НЕТ` | `` | Array of map-fixed |  |  | `654` |
+
+## Operation: delete
+
+None.
+
+## Operation: modify
+
+| Code | Type | Required | Default | Description | Man | Constraints | ID |
+|---|---|---|---|---|---|---|---|
+| `durationMs` | `integer &gt;= 0` | `ДА` | `0` | перед завершением подождать (sleep) столько миллисекунд | перед завершением подождать (sleep) столько миллисекунд |  | `287` |
+| `failAtStart` | `boolean` | `ДА` | `false` | если true, завершить джоб, ничего не записывая в cmdb |  | value_list=false, true | `288` |
+| `failInProgress` | `boolean` | `ДА` | `false` | если true, корректно начать выполнение джоба, но в процессе завершить аварийно, ничего не записывая в cmdb |  | value_list=false, true | `289` |
+| `whereFail` | `integer &gt; 0` | `НЕТ` | `` | принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write | принимает 1,2,3. Работает с failInProgress. 1 - упасть в prepare. 2 - упасть внутри блока Data fill. 3 - упасть после vault write | value_list=1, 2, 3 | `290` |
+| `bodymessage` | `` | `НЕТ` | `` | Дата, уходящая в Vault | Дата, уходящая в Vault |  | `291` |
+| `mapExample` | `map` | `НЕТ` | `{}` |  |  |  | `373` |
+| `jsonExample` | `` | `НЕТ` | `` |  |  |  | `374` |
+
+## Operation: redeploy
+
+None.
+
+## Operation: resume
+
+None.
+
+## Operation: suspend
+
+None.