Перейти к основному содержимому

Бот поддержки — справочник эндпоинтов

Актуально для: SimpleTwo 0.9.x · Сгенерировано из кода службы support/

Демон @librarian: вебхуки от messaging и база знаний.

Это карта, а не описание

Файл собран автоматически из объявлений маршрутов, поэтому он не отстаёт от кода, но и не рассказывает, что делает каждый эндпоинт. Описания, примеры запросов и коды ошибок — в статьях раздела API; карта нужна, чтобы увидеть поверхность целиком и найти, где она объявлена.

Пересобрать: python3 site/docs-gen/api-reference.py. Столбец «Аутентификация» выведен из префикса пути — соглашение продукта, а не разбор middleware.

Всего эндпоинтов: 8.

events​

МетодПутьАутентификацияОбъявлен в
POST/events—support/internal/server/server.go

healthz​

МетодПутьАутентификацияОбъявлен в
GET/healthzбез аутентификацииsupport/internal/server/server.go

kb​

МетодПутьАутентификацияОбъявлен в
POST/kb/resync—support/internal/server/server.go

tickets​

МетодПутьАутентификацияОбъявлен в
GET/tickets—support/internal/tickets/api.go
POST/tickets/ack—support/internal/tickets/api.go
GET/tickets/status—support/internal/tickets/api.go
GET/tickets/{id}—support/internal/tickets/api.go
GET/tickets/{id}/attachments/{n}—support/internal/tickets/api.go