Файлы конфигурации

Управление конфигурационными файлами окружения проекта через REST API. Конфиги используются для хранения файлов настроек приложений. Все методы требуют токен аутентификации.

POST /v1/project/:projectId/environment/config

Создаёт новый конфигурационный файл в окружении проекта. Обязательное имя name (до 255 символов) должно быть уникальным в рамках проекта — при совпадении возвращается ошибка конфликта; необязательное поле data задаёт исходное содержимое, которое платформа автоматически кодирует в base64. Количество конфигов в проекте ограничено: при превышении лимита возвращается ошибка. В ответе приходит созданный объект EnvironmentConfigResponse.

Параметры:

Body:

Пример запроса:

{
    "name": ".env",
    "data": "DATABASE_URL=postgresql://localhost:5432/mydb\nAPP_ENV=production"
}

Ответ:

{
    "id": "660e8400-e29b-41d4-a716-446655440020",
    "name": ".env",
    "data": "DATABASE_URL=postgresql://localhost:5432/mydb\nAPP_ENV=production",
    "createdAt": "2024-01-15T10:30:00+00:00",
    "updatedAt": "2024-01-15T10:30:00+00:00"
}

Ошибки:

• 404 Not Found — Проект не найден
• 409 Conflict — Конфиг с таким именем уже существует
• 400 Bad Request — Превышен лимит на количество конфигов или невалидные параметры

PUT /v1/environment/config/:configId

Обновляет содержимое существующего конфигурационного файла. В теле запроса передаётся только новое значение data — оно обязательно и не может быть пустой строкой; параметров для переименования конфига метод не предоставляет. Новое содержимое кодируется в base64, а в ответе возвращается обновлённый объект с изменённой датой updatedAt.

Параметры:

Body:

Пример запроса:

{
    "data": "DATABASE_URL=postgresql://localhost:5432/newdb\nAPP_ENV=staging"
}

Ответ:

{
    "id": "660e8400-e29b-41d4-a716-446655440020",
    "name": ".env",
    "data": "DATABASE_URL=postgresql://localhost:5432/newdb\nAPP_ENV=staging",
    "createdAt": "2024-01-15T10:30:00+00:00",
    "updatedAt": "2024-01-15T11:00:00+00:00"
}

Ошибки:

• 404 Not Found — Конфиг не найден
• 400 Bad Request — Невалидные параметры

GET /v1/environment/config/:configId

Возвращает конфигурационный файл по его UUID в виде объекта EnvironmentConfigResponse. Ответ содержит имя файла и его содержимое data, которое автоматически декодируется из base64 при получении, а также даты создания и обновления.

Параметры:

Ответ:

{
    "id": "660e8400-e29b-41d4-a716-446655440020",
    "name": ".env",
    "data": "DATABASE_URL=postgresql://localhost:5432/mydb\nAPP_ENV=production",
    "createdAt": "2024-01-15T10:30:00+00:00",
    "updatedAt": "2024-01-15T10:30:00+00:00"
}

Ошибки:

• 404 Not Found — Конфиг не найден

GET /v1/project/:projectId/environment/configs

Возвращает все конфигурационные файлы проекта — массив объектов EnvironmentConfigResponse. Каждый элемент содержит имя конфига, его содержимое (декодируется из base64 при получении) и даты создания и обновления.

Параметры:

Ответ:

[
    {
        "id": "660e8400-e29b-41d4-a716-446655440020",
        "name": ".env",
        "data": "DATABASE_URL=postgresql://localhost:5432/mydb\nAPP_ENV=production",
        "createdAt": "2024-01-15T10:30:00+00:00",
        "updatedAt": "2024-01-15T10:30:00+00:00"
    }
]

Ошибки:

• 404 Not Found — Проект не найден

DELETE /v1/environment/config/:configId

Удаляет конфигурационный файл по его UUID. Успешное удаление подтверждается пустым ответом без тела, объект конфига не возвращается. При обращении к несуществующему конфигу возвращается ошибка «не найден».

Параметры:

Ответ: 204 No Content — пустой ответ при успешном удалении.

Ошибки:

• 404 Not Found — Конфиг не найден