Страницы

Get Project Pages

get

Получение списка страниц проекта.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired
Query parameters
skipintegerOptional

Количество пропускаемых записей

Default: 0
limitinteger · min: 1 · max: 100Optional

Максимальное количество записей

Default: 100
Responses
chevron-right
200

Successful Response

application/json

Схема ответа с данными страницы

idintegerRequired
project_idintegerRequired
namestringRequired
titlestringRequired
slugstringRequired
iconany ofRequired
stringOptional
or
nullOptional
statusstring · enumRequired

Статус страницы

Possible values:
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get
/api/projects/{project_id}/pages

Create Page

post

Создание новой страницы в проекте.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired
Body

Схема для создания новой страницы

namestring · min: 1 · max: 255Required

Название страницы

titlestring · min: 1 · max: 255Required

Заголовок страницы

slugstring · min: 1 · max: 255Required

URL slug страницы

iconany ofOptional

Иконка страницы

string · max: 100Optional
or
nullOptional
Responses
post
/api/projects/{project_id}/pages

Check Slug Availability

get

Проверка доступности slug в рамках проекта.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired
Query parameters
slugstring · min: 1 · max: 255Required
Responses
chevron-right
200

Successful Response

application/json

Схема ответа на проверку доступности slug

slugstringRequired
availablebooleanRequired
messageany ofOptional
stringOptional
or
nullOptional
get
/api/projects/{project_id}/check-slug

Get Page

get

Получение страницы по ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
page_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json

Схема ответа с данными страницы

idintegerRequired
project_idintegerRequired
namestringRequired
titlestringRequired
slugstringRequired
iconany ofRequired
stringOptional
or
nullOptional
statusstring · enumRequired

Статус страницы

Possible values:
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get
/api/pages/{page_id}

Delete Page

delete

Удаление страницы.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
page_idintegerRequired
Responses
delete
/api/pages/{page_id}

No content

Update Page

patch

Обновление страницы.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
page_idintegerRequired
Body

Схема для обновления страницы

nameany ofOptional

Название страницы

string · min: 1 · max: 255Optional
or
nullOptional
titleany ofOptional

Заголовок страницы

string · min: 1 · max: 255Optional
or
nullOptional
slugany ofOptional

URL slug страницы

string · min: 1 · max: 255Optional
or
nullOptional
iconany ofOptional

Иконка страницы

string · max: 100Optional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json

Схема ответа с данными страницы

idintegerRequired
project_idintegerRequired
namestringRequired
titlestringRequired
slugstringRequired
iconany ofRequired
stringOptional
or
nullOptional
statusstring · enumRequired

Статус страницы

Possible values:
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
patch
/api/pages/{page_id}

Update Page Status

patch

Обновление статуса страницы.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
page_idintegerRequired
Body

Схема для обновления статуса страницы

statusstring · enumRequired

Новый статус страницы

Possible values:
Responses
chevron-right
200

Successful Response

application/json

Схема ответа с данными страницы

idintegerRequired
project_idintegerRequired
namestringRequired
titlestringRequired
slugstringRequired
iconany ofRequired
stringOptional
or
nullOptional
statusstring · enumRequired

Статус страницы

Possible values:
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
patch
/api/pages/{page_id}/status

Последнее обновление