API: Projects

Раздел собран из спецификации OpenAPI продукта: 8 метод(ов). Поверхность — query-api (основной API, база /api/v1). Все методы требуют аутентификации.

Методы раздела

• GET /projects
• POST /projects
• GET /projects/{id}
• PATCH /projects/{id}
• DELETE /projects/{id}
• POST /projects/{id}/demo-reseed
• GET /projects/{id}/demo-status
• POST /projects/demo

GET /projects

List projects in the current org

Аутентификация

Bearer: токен доступа (JWT)

operationId

getProjects

Ответы

Код	Что означает	Тело
200	Projects	ProjectListResponse
401	Missing or invalid credentials (code=unauthorized)	Error

POST /projects

Create a project (admin+)

Аутентификация

Bearer: токен доступа (JWT)

operationId

postProjects

Тело запроса application/json , обязательно

Поле	Тип	Описание
name обязательно	string
timezone необязательно	string	IANA timezone По умолчанию "UTC".

Ответы

Код	Что означает	Тело
201	Created project	Project
401	Missing or invalid credentials (code=unauthorized)	Error
403	Authenticated but not permitted (code=forbidden)	Error
422	Request failed validation (code=validation_failed)	Error

GET /projects/{id}

Get a project

Аутентификация

Bearer: токен доступа (JWT)

operationId

getProjectsId

Параметры

Имя	Где	Тип	Описание
id обязателен	Путь	integer (int32)	Project id.

Ответы

Код	Что означает	Тело
200	Project	Project
401	Missing or invalid credentials (code=unauthorized)	Error
404	Resource not found (code=not_found)	Error

PATCH /projects/{id}

Update a project (admin+)

Аутентификация

Bearer: токен доступа (JWT)

operationId

patchProjectsId

Параметры

Имя	Где	Тип	Описание
id обязателен	Путь	integer (int32)	Project id.

Тело запроса application/json , обязательно

Поле	Тип	Описание
name необязательно	string
timezone необязательно	string	IANA timezone

Ответы

Код	Что означает	Тело
200	Updated project	Project
401	Missing or invalid credentials (code=unauthorized)	Error
403	Authenticated but not permitted (code=forbidden)	Error
404	Resource not found (code=not_found)	Error
422	Request failed validation (code=validation_failed)	Error

DELETE /projects/{id}

Delete a project (admin+)

Аутентификация

Bearer: токен доступа (JWT)

operationId

deleteProjectsId

Параметры

Имя	Где	Тип	Описание
id обязателен	Путь	integer (int32)	Project id.

Ответы

Код	Что означает	Тело
204	Deleted	пусто
401	Missing or invalid credentials (code=unauthorized)	Error
403	Authenticated but not permitted (code=forbidden)	Error
404	Resource not found (code=not_found)	Error

POST /projects/{id}/demo-reseed

Reset demo data and enqueue a fresh seed (admin+)

Аутентификация

Bearer: токен доступа (JWT)

operationId

postProjectsIdDemoReseed

Параметры

Имя	Где	Тип	Описание
id обязателен	Путь	integer (int32)	Project id.

Ответы

Код	Что означает	Тело
202	Seed job enqueued	DemoStatus
401	Missing or invalid credentials (code=unauthorized)	Error
403	Authenticated but not permitted (code=forbidden)	Error
404	Resource not found (code=not_found)	Error
409	Seed already in progress (code `demo_project`)	Error
422	Request failed validation (code=validation_failed)	Error

GET /projects/{id}/demo-status

Demo seeding status (SPA polls it while the demo project fills up)

Аутентификация

Bearer: токен доступа (JWT)

operationId

getProjectsIdDemoStatus

Параметры

Имя	Где	Тип	Описание
id обязателен	Путь	integer (int32)	Project id.

Ответы

Код	Что означает	Тело
200	Status of the latest demo_seed job	DemoStatus
401	Missing or invalid credentials (code=unauthorized)	Error
404	Resource not found (code=not_found)	Error

POST /projects/demo

Create the org demo project if it is missing (admin+)

Аутентификация

Bearer: токен доступа (JWT)

operationId

postProjectsDemo

Atomically creates the organization's demo project and enqueues its initial seed job. The operation is idempotent: if another request has already created the demo project, the existing project is returned. Demo projects do not consume the regular project allowance.

Ответы

Код	Что означает	Тело
200	Existing demo project	Project
201	Demo project created and seed job enqueued	Project
401	Missing or invalid credentials (code=unauthorized)	Error
403	Authenticated but not permitted (code=forbidden)	Error

Источник раздела — docs/api/openapi.yaml репозитория продукта, версия API 1.0.0, OpenAPI 3.0.3, снимок e2d62cf449b2. Расхождение снимка со спецификацией роняет сборку документации.

← Все разделы API Reference