docs: убрать типографское тире и невидимый Unicode из текстов API

Made-with: Cursor
This commit is contained in:
Denozordec
2026-04-04 00:31:56 +07:00
parent a754e1d9f2
commit fbe9cd3f3c
4 changed files with 50 additions and 50 deletions
+14 -14
View File
@@ -5,9 +5,9 @@ info:
description: |
REST API управления префиксами, модулями ingest, ревизиями конфигурации BIRD и задачами (async jobs).
**Соглашения:** префикс `/v1`; идентификаторы UUID v7 или ULID (строки); время ISO 8601 UTC.
Ошибки `application/problem+json` ([RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)).
Пагинация списков `cursor` + `limit`; ответ содержит `items`, `next_cursor`, `has_more`.
**Соглашения:** префикс `/v1`; идентификаторы - UUID v7 или ULID (строки); время - ISO 8601 UTC.
Ошибки - `application/problem+json` ([RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)).
Пагинация списков - `cursor` + `limit`; ответ содержит `items`, `next_cursor`, `has_more`.
**Роли** (матрица доступа): `viewer`, `editor`, `operator`, `node`. Нода использует отдельные пути и ключ с ролью `node`.
@@ -24,7 +24,7 @@ tags:
- name: System
description: Liveness, readiness и метаданные сборки. Обычно без чувствительных данных; доступ может быть шире.
- name: Modules
description: Экземпляры модулей префиксов (AS, CDN, домены, статические IP-диапазоны) и вложенные записи. Чтение viewer+; изменение editor+.
description: Экземпляры модулей префиксов (AS, CDN, домены, статические IP-диапазоны) и вложенные записи. Чтение - viewer+; изменение - editor+.
- name: DoH profiles
description: Профили DNS-over-HTTPS для модулей типа домены. Секрет в ответах не возвращается.
- name: Communities
@@ -42,7 +42,7 @@ tags:
- name: Node
description: "API для evobgp-node (бандлы ревизий и enrollment). Отдельный ключ или mTLS, роль node."
- name: Settings
description: Глобальные настройки и feature flags; изменение только operator.
description: Глобальные настройки и feature flags; изменение - только operator.
security:
- bearerAuth: []
@@ -563,7 +563,7 @@ components:
type: integer
bgp_speaker_id:
type: ["string", "null"]
description: "`null` политика для всех спикеров."
description: "`null` - политика для всех спикеров."
additionalProperties: true
BgpSpeaker:
@@ -600,7 +600,7 @@ components:
PrefixSnapshotItem:
type: object
description: Элемент материализованного снимка префиксов (детали по реализации).
description: Элемент материализованного снимка префиксов (детали - по реализации).
additionalProperties: true
Job:
@@ -684,7 +684,7 @@ components:
RevisionDiff:
type: object
description: |
Сравнение двух ревизий. Конкретный формат (JSON Patch, табличный diff и т.д.) задаётся реализацией контракт может уточняться.
Сравнение двух ревизий. Конкретный формат (JSON Patch, табличный diff и т.д.) задаётся реализацией - контракт может уточняться.
additionalProperties: true
NodeEnrollRequest:
@@ -878,7 +878,7 @@ paths:
summary: Создать модуль
description: |
Создаёт экземпляр модуля. Поле `type` задаёт вид (`AS_PREFIXES`, `CDN_CIDRS`, `DOMAINS`, `IP_RANGES`).
`module_id` в других путях идентификатор экземпляра, не имя типа.
`module_id` в других путях - идентификатор экземпляра, не имя типа.
operationId: createModule
parameters:
- $ref: "#/components/parameters/TenantId"
@@ -959,7 +959,7 @@ paths:
delete:
tags: [Modules]
summary: Удалить модуль
description: Мягкое удаление или перевод в `enabled=false` конкретное поведение задаётся реализацией.
description: Мягкое удаление или перевод в `enabled=false` - конкретное поведение задаётся реализацией.
operationId: deleteModule
parameters:
- $ref: "#/components/parameters/IdempotencyKey"
@@ -1391,7 +1391,7 @@ paths:
summary: Запустить ingest
description: |
Запуск обновления данных модуля (CDN / DoH / AS в зависимости от типа).
Для `IP_RANGES` данные обычно только в БД: сервер может вернуть **204** (no-op) или **400**, если refresh не поддерживается поведение фиксируется в реализации.
Для `IP_RANGES` данные обычно только в БД: сервер может вернуть **204** (no-op) или **400**, если refresh не поддерживается - поведение фиксируется в реализации.
Рекомендуется передавать `Idempotency-Key`.
operationId: postModuleRefresh
parameters:
@@ -1454,7 +1454,7 @@ paths:
post:
tags: [DoH profiles]
summary: Создать DoH-профиль
description: URL и таймауты; секрет через vault id или отдельный вызов установки секрета.
description: URL и таймауты; секрет - через vault id или отдельный вызов установки секрета.
operationId: createDohProfile
parameters:
- $ref: "#/components/parameters/TenantId"
@@ -1948,7 +1948,7 @@ paths:
operationId: getRevisionPreview
responses:
"200":
description: Текст или структурированное представление формат задаётся реализацией.
description: Текст или структурированное представление - формат задаётся реализацией.
content:
application/json:
schema:
@@ -2222,7 +2222,7 @@ paths:
summary: Скачать подписанный бандл
description: |
Архив с `manifest.json` и подписью (например Ed25519). Целостность по SHA-256 в манифесте.
`Content-Type` `application/octet-stream` или multipart; детали в реализации.
`Content-Type` - `application/octet-stream` или multipart; детали - в реализации.
operationId: getSpeakerBundle
security:
- bearerAuth: []