msumshk/TakeoutSaaS.TenantApi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 完善参数注释与StyleCop配置

Browse Source
This commit is contained in:
MSuMshk
2025-12-04 12:45:26 +08:00
parent 8e4c2b0e45
commit 37e7d721f3
213 changed files with 695 additions and 446 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/Api/TakeoutSaaS.AdminApi/Controllers/TenantPackagesController.cs
View File

@@ -1,8 +1,7 @@
using System.ComponentModel.DataAnnotations;
using MediatR;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using System.ComponentModel.DataAnnotations;
using TakeoutSaaS.Application.App.Tenants.Commands;
using TakeoutSaaS.Application.App.Tenants.Dto;
using TakeoutSaaS.Application.App.Tenants.Queries;
@@ -23,6 +22,9 @@ public sealed class TenantPackagesController(IMediator mediator) : BaseApiContro
/// <summary>
/// 分页查询租户套餐。
/// </summary>
/// <param name="query">查询条件。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>租户套餐分页结果。</returns>
[HttpGet]
[PermissionAuthorize("tenant-package:read")]
[ProducesResponseType(typeof(ApiResponse<PagedResult<TenantPackageDto>>), StatusCodes.Status200OK)]
@@ -38,6 +40,9 @@ public sealed class TenantPackagesController(IMediator mediator) : BaseApiContro
/// <summary>
/// 查看套餐详情。
/// </summary>
/// <param name="tenantPackageId">套餐 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>套餐详情或未找到。</returns>
[HttpGet("{tenantPackageId:long}")]
[PermissionAuthorize("tenant-package:read")]
[ProducesResponseType(typeof(ApiResponse<TenantPackageDto>), StatusCodes.Status200OK)]
@@ -56,6 +61,9 @@ public sealed class TenantPackagesController(IMediator mediator) : BaseApiContro
/// <summary>
/// 创建套餐。
/// </summary>
/// <param name="command">创建命令。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>创建后的套餐。</returns>
[HttpPost]
[PermissionAuthorize("tenant-package:create")]
[ProducesResponseType(typeof(ApiResponse<TenantPackageDto>), StatusCodes.Status200OK)]
@@ -71,6 +79,10 @@ public sealed class TenantPackagesController(IMediator mediator) : BaseApiContro
/// <summary>
/// 更新套餐。
/// </summary>
/// <param name="tenantPackageId">套餐 ID。</param>
/// <param name="command">更新命令。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>更新后的套餐或未找到。</returns>
[HttpPut("{tenantPackageId:long}")]
[PermissionAuthorize("tenant-package:update")]
[ProducesResponseType(typeof(ApiResponse<TenantPackageDto>), StatusCodes.Status200OK)]
@@ -92,6 +104,9 @@ public sealed class TenantPackagesController(IMediator mediator) : BaseApiContro
/// <summary>
/// 删除套餐。
/// </summary>
/// <param name="tenantPackageId">套餐 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>删除结果。</returns>
[HttpDelete("{tenantPackageId:long}")]
[PermissionAuthorize("tenant-package:delete")]
[ProducesResponseType(typeof(ApiResponse<bool>), StatusCodes.Status200OK)]