Перейти к основному содержимому

EndpointRbac

@mineflow/api-schemas

@mineflow/api-schemas / EndpointRbac

Interface: EndpointRbac

Defined in: packages/api-schemas/src/endpoint-roles.generated.ts:10

RBAC-контракт одного эндпоинта, извлечённый из decorator-метаданных бэка.

Properties​

audit?​

readonly optional audit?: object;

Defined in: packages/api-schemas/src/endpoint-roles.generated.ts:18

@Auditable(entity, action) — пишется в audit_log.

action​

readonly action: string;

entity​

readonly entity: string;

idempotent?​

readonly optional idempotent?: 
  | boolean
  | {
  ttlHours: number;
};

Defined in: packages/api-schemas/src/endpoint-roles.generated.ts:16

@Idempotent() — требует Idempotency-Key. { ttlHours } для коротких TTL.

objectScope?​

readonly optional objectScope?: string;

Defined in: packages/api-schemas/src/endpoint-roles.generated.ts:14

@RequiresObjectScope(param) — имя param'а для object-scope проверки.

public?​

readonly optional public?: boolean;

Defined in: packages/api-schemas/src/endpoint-roles.generated.ts:20

@Public() — без авторизации.

roles?​

readonly optional roles?: readonly SystemRole[];

Defined in: packages/api-schemas/src/endpoint-roles.generated.ts:12

@RequiresRole(...) — роли с доступом. Absent = @Public или нет гейта.