Skip to content

Commit

Permalink
梳理注释
Browse files Browse the repository at this point in the history 
Signed-off-by: Vicente.Yu <^@^>
  • Loading branch information
Vicente.Yu committed Oct 23, 2023
1 parent 2ef3c2d commit 56a7986
Show file tree
Hide file tree
Showing 89 changed files with 4,212 additions and 3,723 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# FeishuNetSdk


## 自建应用用法
### 配置
```csharp
Expand Down
11 changes: 10 additions & 1 deletion src/Approval.Spec/PostApprovalOpenapiV1MessageUpdateBodyDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,16 @@ public record PostApprovalOpenapiV1MessageUpdateBodyDto
public string MessageId { get; set; } = string.Empty;

/// <summary>
/// <para>状态类型，用于更新第一个action文字内容，枚举：<br> APPROVED:已同意<br>REJECTED:已拒绝<br>CANCELLED:已撤回<br>FORWARDED:已转交<br>ROLLBACK:已回退<br>ADD:已加签<br>DELETED:已删除<br>PROCESSED:已处理<br>CUSTOM:自定义按钮状态</para>
/// <para>状态类型，用于更新第一个action文字内容，枚举：</para>
/// <para>APPROVED:已同意</para>
/// <para>REJECTED:已拒绝</para>
/// <para>CANCELLED:已撤回</para>
/// <para>FORWARDED:已转交</para>
/// <para>ROLLBACK:已回退</para>
/// <para>ADD:已加签</para>
/// <para>DELETED:已删除</para>
/// <para>PROCESSED:已处理</para>
/// <para>CUSTOM:自定义按钮状态</para>
/// <para>必填：是</para>
/// </summary>
[JsonProperty("status")]
Expand Down
13 changes: 10 additions & 3 deletions src/Approval.Spec/PostApprovalOpenapiV2ApprovalCreateBodyDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 创建审批定义 请求体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create)用于通过接口创建简单的审批定义，可以灵活指定定义的基础信息、表单和流程等。创建成功后，不支持从审批管理后台删除该定义。不推荐企业自建应用使用，如有需要尽量联系管理员在审批管理后台创建定义。</para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create)用于通过接口创建简单的审批定义，可以灵活指定定义的基础信息、表单和流程等。创建成功后，不支持从审批管理后台删除该定义。不推荐企业自建应用使用，如有需要尽量联系管理员在审批管理后台创建定义。</para>
/// <para>接口谨慎调用，创建后的审批定义无法停用/删除</para>
/// <para>接口ID：6907569743420686338</para>
/// <para>文档地址：https://open.feishu.cn/document/server-docs/historic-version/approval/v2/feishu-store-app-integration/create-an-approval-definition</para>
Expand Down Expand Up @@ -91,7 +91,11 @@ public record Node
public string Name { get; set; } = string.Empty;

/// <summary>
/// <para>审批类型枚举<br>- AND 会签<br>- OR 或签<br>- SEQUENTIAL 依次审批<br>当 node_type 为依次审批时，审批人必须为『发起人自选』</para>
/// <para>审批类型枚举</para>
/// <para>- AND 会签</para>
/// <para>- OR 或签</para>
/// <para>- SEQUENTIAL 依次审批</para>
/// <para>当 node_type 为依次审批时，审批人必须为『发起人自选』</para>
/// <para>必填：是</para>
/// </summary>
[JsonProperty("node_type")]
Expand Down Expand Up @@ -198,7 +202,10 @@ public record ConfigSuffix
public record I18nResource
{
/// <summary>
/// <para>语言：<br>zh-CN - 中文<br>en-US - 英文<br>ja-JP - 日文</para>
/// <para>语言：</para>
/// <para>zh-CN - 中文</para>
/// <para>en-US - 英文</para>
/// <para>ja-JP - 日文</para>
/// <para>必填：是</para>
/// </summary>
[JsonProperty("locale")]
Expand Down
2 changes: 1 addition & 1 deletion src/Approval.Spec/PostApprovalOpenapiV2ApprovalCreateResponseDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 创建审批定义 响应体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create)用于通过接口创建简单的审批定义，可以灵活指定定义的基础信息、表单和流程等。创建成功后，不支持从审批管理后台删除该定义。不推荐企业自建应用使用，如有需要尽量联系管理员在审批管理后台创建定义。</para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create)用于通过接口创建简单的审批定义，可以灵活指定定义的基础信息、表单和流程等。创建成功后，不支持从审批管理后台删除该定义。不推荐企业自建应用使用，如有需要尽量联系管理员在审批管理后台创建定义。</para>
/// <para>接口谨慎调用，创建后的审批定义无法停用/删除</para>
/// <para>接口ID：6907569743420686338</para>
/// <para>文档地址：https://open.feishu.cn/document/server-docs/historic-version/approval/v2/feishu-store-app-integration/create-an-approval-definition</para>
Expand Down
6 changes: 4 additions & 2 deletions src/Approval.Spec/PostApprovalOpenapiV2ApprovalGetBodyDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 查看审批定义 请求体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get)根据 Approval Code 获取某个审批定义的详情，用于构造创建审批实例的请求。</para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get)根据 Approval Code 获取某个审批定义的详情，用于构造创建审批实例的请求。</para>
/// <para>接口ID：6907569744330358785</para>
/// <para>文档地址：https://open.feishu.cn/document/server-docs/historic-version/approval/v2/feishu-native-approval/obtain-single-approval-form</para>
/// <para>JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuADNyUjLwQjM14CM0ITN</para>
Expand All @@ -17,7 +17,9 @@ public record PostApprovalOpenapiV2ApprovalGetBodyDto
public string ApprovalCode { get; set; } = string.Empty;

/// <summary>
/// <para>zh-CN - 中文<br>en-US - 英文 <br>ja-JP - 日文</para>
/// <para>zh-CN - 中文</para>
/// <para>en-US - 英文</para>
/// <para>ja-JP - 日文</para>
/// <para>必填：否</para>
/// </summary>
[JsonProperty("locale")]
Expand Down
30 changes: 24 additions & 6 deletions src/Approval.Spec/PostApprovalOpenapiV2ApprovalGetResponseDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 查看审批定义 响应体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get)根据 Approval Code 获取某个审批定义的详情，用于构造创建审批实例的请求。</para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get)根据 Approval Code 获取某个审批定义的详情，用于构造创建审批实例的请求。</para>
/// <para>接口ID：6907569744330358785</para>
/// <para>文档地址：https://open.feishu.cn/document/server-docs/historic-version/approval/v2/feishu-native-approval/obtain-single-approval-form</para>
/// <para>JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuADNyUjLwQjM14CM0ITN</para>
Expand All @@ -17,7 +17,11 @@ public record PostApprovalOpenapiV2ApprovalGetResponseDto
public string ApprovalName { get; set; } = string.Empty;

/// <summary>
/// <para>审批定义状态<br>ACTIVE -已启用<br>INACTIVE -已停用<br>DELETED -已删除<br>UNKNOWN -未知</para>
/// <para>审批定义状态</para>
/// <para>ACTIVE -已启用</para>
/// <para>INACTIVE -已停用</para>
/// <para>DELETED -已删除</para>
/// <para>UNKNOWN -未知</para>
/// <para>必填：是</para>
/// </summary>
[JsonProperty("status")]
Expand Down Expand Up @@ -164,7 +168,8 @@ public record Node
public string Name { get; set; } = string.Empty;

/// <summary>
/// <para>是否发起人自选节点<br>true - 发起审批时需要提交审批人</para>
/// <para>是否发起人自选节点</para>
/// <para>true - 发起审批时需要提交审批人</para>
/// <para>必填：是</para>
/// </summary>
[JsonProperty("need_approver")]
Expand All @@ -185,7 +190,11 @@ public record Node
public string? CustomNodeId { get; set; }

/// <summary>
/// <para>审批方式<br>AND -会签<br>OR - 或签<br>SEQUENTIAL -依次审批<br>CC_NODE -抄送节点</para>
/// <para>审批方式</para>
/// <para>AND -会签</para>
/// <para>OR - 或签</para>
/// <para>SEQUENTIAL -依次审批</para>
/// <para>CC_NODE -抄送节点</para>
/// <para>必填：是</para>
/// </summary>
[JsonProperty("node_type")]
Expand All @@ -202,14 +211,23 @@ public record Node
public record Viewer
{
/// <summary>
/// <para>可见人类型，分别有：<br>TENANT：租户内可见<br>DEPARTMENT：指定部门<br> USER：指定用户<br> ROLE：指定角色<br> USER_GROUP：指定用户组<br>NONE：任何人都不可见</para>
/// <para>可见人类型，分别有：</para>
/// <para>TENANT：租户内可见</para>
/// <para>DEPARTMENT：指定部门</para>
/// <para>USER：指定用户</para>
/// <para>ROLE：指定角色</para>
/// <para>USER_GROUP：指定用户组</para>
/// <para>NONE：任何人都不可见</para>
/// <para>必填：是</para>
/// </summary>
[JsonProperty("type")]
public string Type { get; set; } = string.Empty;

/// <summary>
/// <para>在可见人类型为DEPARTMENT时，open_id为部门的open_id<br>在可见人类型为USER时，open_id为用户的open_id<br>在可见人类型为ROLE时，open_id为角色的open_id<br>在可见人类型为USER_GROUP时，open_id为用户组的open_id</para>
/// <para>在可见人类型为DEPARTMENT时，open_id为部门的open_id</para>
/// <para>在可见人类型为USER时，open_id为用户的open_id</para>
/// <para>在可见人类型为ROLE时，open_id为角色的open_id</para>
/// <para>在可见人类型为USER_GROUP时，open_id为用户组的open_id</para>
/// <para>必填：否</para>
/// </summary>
[JsonProperty("open_id")]
Expand Down
21 changes: 15 additions & 6 deletions src/Approval.Spec/PostApprovalOpenapiV2CcSearchBodyDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 抄送列表查询 请求体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc)该接口通过不同条件查询审批系统中符合条件的审批抄送列表。</para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc)该接口通过不同条件查询审批系统中符合条件的审批抄送列表。</para>
/// <para>接口ID：6907568073252700162</para>
/// <para>文档地址：https://open.feishu.cn/document/server-docs/historic-version/approval/v2/approval-search/cc-list-query</para>
/// <para>JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuUjMxYjL1ITM24SNyEjN</para>
Expand Down Expand Up @@ -31,14 +31,16 @@ public record PostApprovalOpenapiV2CcSearchBodyDto
public string? InstanceCode { get; set; }

/// <summary>
/// <para>审批实例第三方 id<br>注：和 approval_code 取并集</para>
/// <para>审批实例第三方 id</para>
/// <para>注：和 approval_code 取并集</para>
/// <para>必填：否</para>
/// </summary>
[JsonProperty("instance_external_id")]
public string? InstanceExternalId { get; set; }

/// <summary>
/// <para>审批定义分组第三方 id<br>注：和 instance_code 取并集</para>
/// <para>审批定义分组第三方 id</para>
/// <para>注：和 instance_code 取并集</para>
/// <para>必填：否</para>
/// </summary>
[JsonProperty("group_external_id")]
Expand All @@ -52,7 +54,11 @@ public record PostApprovalOpenapiV2CcSearchBodyDto
public string? CcTitle { get; set; }

/// <summary>
/// <para>审批抄送状态<br>READ: 已读<br>UNREAD: 未读<br>注：若不设置，查询全部状态<br>若不在集合中，报错</para>
/// <para>审批抄送状态</para>
/// <para>READ: 已读</para>
/// <para>UNREAD: 未读</para>
/// <para>注：若不设置，查询全部状态</para>
/// <para>若不在集合中，报错</para>
/// <para>必填：否</para>
/// </summary>
[JsonProperty("read_status")]
Expand Down Expand Up @@ -80,14 +86,17 @@ public record PostApprovalOpenapiV2CcSearchBodyDto
public string? Locale { get; set; }

/// <summary>
/// <para>查询偏移量<br>注：不得超过10000</para>
/// <para>查询偏移量</para>
/// <para>注：不得超过10000</para>
/// <para>必填：否</para>
/// </summary>
[JsonProperty("offset")]
public int? Offset { get; set; }

/// <summary>
/// <para>查询限制量<br>注：不得超过200<br>不设置默认查询10条数据</para>
/// <para>查询限制量</para>
/// <para>注：不得超过200</para>
/// <para>不设置默认查询10条数据</para>
/// <para>必填：否</para>
/// </summary>
[JsonProperty("limit")]
Expand Down
2 changes: 1 addition & 1 deletion src/Approval.Spec/PostApprovalOpenapiV2CcSearchResponseDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 抄送列表查询 响应体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc)该接口通过不同条件查询审批系统中符合条件的审批抄送列表。</para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc)该接口通过不同条件查询审批系统中符合条件的审批抄送列表。</para>
/// <para>接口ID：6907568073252700162</para>
/// <para>文档地址：https://open.feishu.cn/document/server-docs/historic-version/approval/v2/approval-search/cc-list-query</para>
/// <para>JSON地址：https://open.feishu.cn/document_portal/v1/document/get_detail?fullPath=%2fukTMukTMukTM%2fuUjMxYjL1ITM24SNyEjN</para>
Expand Down
5 changes: 2 additions & 3 deletions src/Approval.Spec/PostApprovalOpenapiV2ExternalInstanceCreateBodyDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 三方审批实例同步 请求体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create)<br></para>
/// <para>审批中心不负责审批的流转，审批的流转在三方系统，三方系统在审批流转后生成的审批实例、审批任务、审批抄送数据同步到审批中心。<br></para>
/// <para><br></para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create)</para>
/// <para>审批中心不负责审批的流转，审批的流转在三方系统，三方系统在审批流转后生成的审批实例、审批任务、审批抄送数据同步到审批中心。</para>
/// <para>用户可以在审批中心中浏览三方系统同步过来的实例、任务、抄送信息，并且可以跳转回三方系统进行更详细的查看和操作，其中实例信息在【已发起】列表，任务信息在【待审批】和【已审批】列表，抄送信息在【抄送我】列表</para>
/// <para><img src="//sf3-cn.feishucdn.com/obj/open-platform-opendoc/9dff4434afbeb0ef69de7f36b9a6e995_z5iwmTzEgg.png" alt="" style="zoom:17%;" /></para>
/// <para><img src="//sf3-cn.feishucdn.com/obj/open-platform-opendoc/ca6e0e984a7a6d64e1b16a0bac4bf868_tfqjCiaJQM.png" alt="" style="zoom:17%;" /></para>
Expand Down
2 changes: 1 addition & 1 deletion src/Approval.Spec/PostApprovalOpenapiV2ExternalListBodyDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 获取三方审批任务状态 请求体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list)该接口用于获取三方审批的状态。用户传入查询条件，接口返回满足条件的审批实例的状态。</para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list)该接口用于获取三方审批的状态。用户传入查询条件，接口返回满足条件的审批实例的状态。</para>
/// <para>该接口支持多种参数的组合， 包括如下组合：</para>
/// <para>1. 通过 instance_ids 获取指定实例的任务状态</para>
/// <para>2. 通过 user_ids 获取指定用户的任务状态</para>
Expand Down
2 changes: 1 addition & 1 deletion src/Approval.Spec/PostApprovalOpenapiV2ExternalListResponseDto.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace FeishuNetSdk.Approval.Spec;
/// <summary>
/// 获取三方审批任务状态 响应体
/// <para>:::html为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list)该接口用于获取三方审批的状态。用户传入查询条件，接口返回满足条件的审批实例的状态。</para>
/// <para>为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list)该接口用于获取三方审批的状态。用户传入查询条件，接口返回满足条件的审批实例的状态。</para>
/// <para>该接口支持多种参数的组合， 包括如下组合：</para>
/// <para>1. 通过 instance_ids 获取指定实例的任务状态</para>
/// <para>2. 通过 user_ids 获取指定用户的任务状态</para>
Expand Down
Loading

0 comments on commit 56a7986

Please sign in to comment.