docs: 完善身份模块文档注释与字段说明

This commit is contained in:
2025-12-12 11:08:39 +08:00
parent 715cbb3d36
commit 641598de86
36 changed files with 409 additions and 37 deletions

View File

@@ -9,19 +9,78 @@ namespace TakeoutSaaS.Application.Identity.Commands;
/// </summary>
public sealed record UpdateMenuCommand : IRequest<MenuDefinitionDto?>
{
/// <summary>
/// 菜单 ID。
/// </summary>
public long Id { get; init; }
/// <summary>
/// 父级菜单 ID。
/// </summary>
public long ParentId { get; init; }
/// <summary>
/// 菜单名称。
/// </summary>
public string Name { get; init; } = string.Empty;
/// <summary>
/// 路由路径。
/// </summary>
public string Path { get; init; } = string.Empty;
/// <summary>
/// 前端组件路径。
/// </summary>
public string Component { get; init; } = string.Empty;
/// <summary>
/// 显示标题。
/// </summary>
public string Title { get; init; } = string.Empty;
/// <summary>
/// 图标。
/// </summary>
public string? Icon { get; init; }
/// <summary>
/// 是否外链。
/// </summary>
public bool IsIframe { get; init; }
/// <summary>
/// 外链地址。
/// </summary>
public string? Link { get; init; }
/// <summary>
/// 是否缓存。
/// </summary>
public bool KeepAlive { get; init; }
/// <summary>
/// 排序序号。
/// </summary>
public int SortOrder { get; init; }
/// <summary>
/// 访问所需权限。
/// </summary>
public IReadOnlyCollection<string> RequiredPermissions { get; init; } = [];
/// <summary>
/// 元信息权限。
/// </summary>
public IReadOnlyCollection<string> MetaPermissions { get; init; } = [];
/// <summary>
/// 元信息角色。
/// </summary>
public IReadOnlyCollection<string> MetaRoles { get; init; } = [];
/// <summary>
/// 按钮权限集合。
/// </summary>
public IReadOnlyCollection<MenuAuthItemDto> AuthList { get; init; } = [];
}