API: publish
POST /api/v1/publish/article
Заголовок раздела «POST /api/v1/publish/article»Publish Article
Publish one article to its Hugo instance (real the publishing hub flow, async).
404s if the article/instance is unknown; 400 if the instance has no the publishing hub config (so a publish that can never succeed isn’t accepted).
Авторизация: нужен Authorization: Bearer <token>
| Параметр | Где | Обязателен | Тип | Описание |
|---|---|---|---|---|
Idempotency-Key | header | нет | string | Optional. |
Тело запроса: application/json — схема PublishArticleRequest
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
article_guid | integer | да | |
instance_id | string | да |
Пример:
{ "article_guid": 31567, "instance_id": "example-prod-hugo-vps"}Ответы:
| Код | Смысл | Тело |
|---|---|---|
202 | Successful Response | TaskAccepted |
401 | Missing or invalid authentication credentials | ErrorResponse |
422 | Validation Error | HTTPValidationError |
POST /api/v1/publish/batch
Заголовок раздела «POST /api/v1/publish/batch»Publish Batch
Авторизация: нужен Authorization: Bearer <token>
| Параметр | Где | Обязателен | Тип | Описание |
|---|---|---|---|---|
Idempotency-Key | header | нет | string | Optional. |
Тело запроса: application/json — схема PublishBatchRequest
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
article_guids | массив integer | да | |
instance_id | string | да |
Пример:
{ "article_guids": [ 31567, 31568 ], "instance_id": "example-prod-hugo-vps"}Ответы:
| Код | Смысл | Тело |
|---|---|---|
202 | Successful Response | TaskAccepted |
401 | Missing or invalid authentication credentials | ErrorResponse |
422 | Validation Error | HTTPValidationError |
POST /api/v1/publish/deploy
Заголовок раздела «POST /api/v1/publish/deploy»Deploy
Авторизация: нужен Authorization: Bearer <token>
| Параметр | Где | Обязателен | Тип | Описание |
|---|---|---|---|---|
Idempotency-Key | header | нет | string | Optional. |
Тело запроса: application/json — схема DeployRequest
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
full_rebuild | boolean | нет | |
instance_id | string | да |
Пример:
{ "full_rebuild": false, "instance_id": "example-prod-hugo-vps"}Ответы:
| Код | Смысл | Тело |
|---|---|---|
202 | Successful Response | TaskAccepted |
401 | Missing or invalid authentication credentials | ErrorResponse |
422 | Validation Error | HTTPValidationError |