Skip to main content

ProjectSecretsController

@lowcode/api


Class: ProjectSecretsController

Defined in: apps/api/src/modules/project-secrets/project-secrets.controller.ts:28

Контроллер управления секретами проекта.

Базовый маршрут: /projects/:projectId/secrets

Constructors​

Constructor​

new ProjectSecretsController(projectSecretsService): ProjectSecretsController

Defined in: apps/api/src/modules/project-secrets/project-secrets.controller.ts:29

Parameters​

projectSecretsService​

ProjectSecretsService

Returns​

ProjectSecretsController

Methods​

createSecret()​

createSecret(user, projectId, dto): Promise<ProjectSecretEntity>

Defined in: apps/api/src/modules/project-secrets/project-secrets.controller.ts:50

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

Parameters​

user​

RequestUser

projectId​

string

dto​

CreateProjectSecretDto

Returns​

Promise<ProjectSecretEntity>

Route​

POST /projects/:projectId/secrets


deleteSecret()​

deleteSecret(user, projectId, key): Promise<void>

Defined in: apps/api/src/modules/project-secrets/project-secrets.controller.ts:79

Удалить секрет проекта.

Parameters​

user​

RequestUser

projectId​

string

key​

string

Returns​

Promise<void>

Route​

DELETE /projects/:projectId/secrets/:key


getRuntimeSecrets()​

getRuntimeSecrets(user, projectId): Promise<{ secrets: Record<string, string>; }>

Defined in: apps/api/src/modules/project-secrets/project-secrets.controller.ts:93

Получить секреты для runtime-preview.

Parameters​

user​

RequestUser

projectId​

string

Returns​

Promise<{ secrets: Record<string, string>; }>

Route​

GET /projects/:projectId/secrets/runtime


listSecrets()​

listSecrets(user, projectId): Promise<ProjectSecretEntity[]>

Defined in: apps/api/src/modules/project-secrets/project-secrets.controller.ts:37

Получить список ключей секретов проекта.

Parameters​

user​

RequestUser

projectId​

string

Returns​

Promise<ProjectSecretEntity[]>

Route​

GET /projects/:projectId/secrets


updateSecret()​

updateSecret(user, projectId, key, dto): Promise<ProjectSecretEntity>

Defined in: apps/api/src/modules/project-secrets/project-secrets.controller.ts:64

Обновить значение секрета.

Parameters​

user​

RequestUser

projectId​

string

key​

string

dto​

UpdateProjectSecretDto

Returns​

Promise<ProjectSecretEntity>

Route​

PATCH /projects/:projectId/secrets/:key