fix(wxapi): 修复代码分析工具检测出的 API 定义问题

This commit is contained in:
Fu Diwei
2021-06-10 15:44:47 +08:00
parent 320b9177db
commit 1eb42807c1
23 changed files with 43 additions and 39 deletions

View File

@@ -9,7 +9,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public class CVOCRIdCardRequest : CVOCRCommonRequest
{
/// <summary>
/// <para>获取或设置图片识别模式。</para>
/// 获取或设置图片识别模式。
/// <para>默认值photo</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]

View File

@@ -23,7 +23,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public long? EndTimestamp { get; set; }
/// <summary>
/// <para>获取或设置排序方式。</para>
/// 获取或设置排序方式。
/// <para>默认值ASC</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("sort_type")]

View File

@@ -85,7 +85,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
}
/// <summary>
/// <para>获取或设置营销规则类型。</para>
/// 获取或设置营销规则类型。
/// <para>默认值RULE_TYPE_PAY_MEMBER_CARD</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("type")]

View File

@@ -9,7 +9,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public class CardPayGiftCardBatchGetRequest : WechatApiRequest
{
/// <summary>
/// <para>获取或设置营销规则类型。</para>
/// 获取或设置营销规则类型。
/// <para>默认值RULE_TYPE_PAY_MEMBER_CARD</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("type")]

View File

@@ -9,7 +9,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public class CgibinTicketGetTicketRequest : WechatApiRequest
{
/// <summary>
/// <para>获取或设置票据类型。</para>
/// 获取或设置票据类型。
/// <para>默认值jsapi</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]

View File

@@ -10,6 +10,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
{
/// <summary>
/// 获取或设置文件格式。
/// <para>默认值mp3</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]

View File

@@ -17,6 +17,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
/// <summary>
/// 获取或设置输入状态。
/// <para>默认值Typing</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("command")]
[System.Text.Json.Serialization.JsonPropertyName("command")]

View File

@@ -41,7 +41,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string MidasEnv { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置平台标识。</para>
/// 获取或设置平台标识。
/// <para>默认值android</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("pf")]

View File

@@ -20,7 +20,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string OpenId { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置返回国家地区语言版本。</para>
/// 获取或设置返回国家地区语言版本。
/// <para>默认值zh_CN</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("lang")]

View File

@@ -14,7 +14,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string OpenId { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置返回国家地区语言版本。</para>
/// 获取或设置返回国家地区语言版本。
/// <para>默认值zh_CN</para>
/// </summary>
public string Language { get; set; } = "zh_CN";

View File

@@ -23,7 +23,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string RealName { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置需要校验的证件类型。</para>
/// 获取或设置需要校验的证件类型。
/// <para>默认值1</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("cred_type")]

View File

@@ -23,7 +23,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string NotifyUrl { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置协议版本号。</para>
/// 获取或设置协议版本号。
/// <para>默认值1</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("version")]

View File

@@ -42,25 +42,25 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public long SKUId { get; set; }
/// <summary>
/// 获取或设置 SKU 数量。
/// 获取或设置商品数量。
/// </summary>
[Newtonsoft.Json.JsonProperty("sku_cnt")]
[System.Text.Json.Serialization.JsonPropertyName("sku_cnt")]
public int SKUCount { get; set; }
public int Count { get; set; }
/// <summary>
/// 获取或设置正在售后流程中的 SKU 数量。
/// 获取或设置正在售后流程中的商品数量。
/// </summary>
[Newtonsoft.Json.JsonProperty("on_aftersale_sku_cnt")]
[System.Text.Json.Serialization.JsonPropertyName("on_aftersale_sku_cnt")]
public int OnAftersaleSKUCount { get; set; }
public int OnAftersaleCount { get; set; }
/// <summary>
/// 获取或设置已完成售后流程的 SKU 数量。
/// 获取或设置已完成售后流程的商品数量。
/// </summary>
[Newtonsoft.Json.JsonProperty("finish_aftersale_sku_cnt")]
[System.Text.Json.Serialization.JsonPropertyName("finish_aftersale_sku_cnt")]
public int FinishAftersaleSKUCount { get; set; }
public int FinishAftersaleCount { get; set; }
/// <summary>
/// 获取或设置商品标题。
@@ -107,13 +107,6 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
[System.Text.Json.Serialization.JsonPropertyName("prepay_id")]
public string PrepayId { get; set; } = default!;
/// <summary>
/// 获取或设置微信支付交易单号。
/// </summary>
[Newtonsoft.Json.JsonProperty("transaction_id")]
[System.Text.Json.Serialization.JsonPropertyName("transaction_id")]
public string? TransactionId { get; set; }
/// <summary>
/// 获取或设置预支付时间。
/// </summary>
@@ -123,6 +116,13 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
[System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Converters.CommonDateTimeOffsetConverter))]
public DateTimeOffset PrepayTime { get; set; }
/// <summary>
/// 获取或设置微信支付交易单号。
/// </summary>
[Newtonsoft.Json.JsonProperty("transaction_id")]
[System.Text.Json.Serialization.JsonPropertyName("transaction_id")]
public string? TransactionId { get; set; }
/// <summary>
/// 获取或设置付款时间。
/// </summary>
@@ -164,7 +164,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public int DiscountedFee { get; set; }
/// <summary>
/// 获取或设置是否有优惠(单位:分)
/// 获取或设置是否有优惠。
/// </summary>
[Newtonsoft.Json.JsonProperty("is_discounted")]
[System.Text.Json.Serialization.JsonPropertyName("is_discounted")]
@@ -367,7 +367,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public long OrderId { get; set; }
/// <summary>
/// 获取或设置商家自定义 ID
/// 获取或设置商家自定义订单号
/// </summary>
[Newtonsoft.Json.JsonProperty("out_order_id")]
[System.Text.Json.Serialization.JsonPropertyName("out_order_id")]

View File

@@ -17,14 +17,14 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
/// </summary>
[Newtonsoft.Json.JsonProperty("media_id")]
[System.Text.Json.Serialization.JsonPropertyName("media_id")]
public string? MediaId { get; set; }
public string MediaId { get; set; } = default!;
/// <summary>
/// 获取或设置支付专用 MediaId。
/// </summary>
[Newtonsoft.Json.JsonProperty("pay_media_id")]
[System.Text.Json.Serialization.JsonPropertyName("pay_media_id")]
public string? PayMediaId { get; set; }
public string PayMediaId { get; set; } = default!;
/// <summary>
/// 获取或设置图片临时 URL。

View File

@@ -21,7 +21,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string OpenId { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置返回国家地区语言版本。</para>
/// 获取或设置返回国家地区语言版本。
/// <para>默认值zh_CN</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]

View File

@@ -23,7 +23,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string Signature { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置用户登录态签名的哈希方法。</para>
/// 获取或设置用户登录态签名的哈希方法。
/// <para>默认值hmac_sha256</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]

View File

@@ -43,7 +43,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string Signature { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置用户登录态签名的哈希方法。</para>
/// 获取或设置用户登录态签名的哈希方法。
/// <para>默认值hmac_sha256</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]

View File

@@ -43,7 +43,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string Signature { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置用户登录态签名的哈希方法。</para>
/// 获取或设置用户登录态签名的哈希方法。
/// <para>默认值hmac_sha256</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]

View File

@@ -23,7 +23,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
public string Signature { get; set; } = string.Empty;
/// <summary>
/// <para>获取或设置用户登录态签名的哈希方法。</para>
/// 获取或设置用户登录态签名的哈希方法。
/// <para>默认值hmac_sha256</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]

View File

@@ -11,8 +11,8 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
/// <summary>
/// 获取或设置直播间 ID。
/// </summary>
[Newtonsoft.Json.JsonProperty("roomId")]
[System.Text.Json.Serialization.JsonPropertyName("roomId")]
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public long RoomId { get; set; }
}
}

View File

@@ -31,6 +31,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
/// <summary>
/// 获取或设置设备类型。
/// <para>默认值:@_all</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("device")]
[System.Text.Json.Serialization.JsonPropertyName("device")]
@@ -38,6 +39,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
/// <summary>
/// 获取或设置下载代码包类型。
/// <para>默认值:@_all</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("is_download_code")]
[System.Text.Json.Serialization.JsonPropertyName("is_download_code")]
@@ -45,6 +47,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
/// <summary>
/// 获取或设置网络环境类型。
/// <para>默认值:@_all</para>
/// </summary>
[Newtonsoft.Json.JsonProperty("networktype")]
[System.Text.Json.Serialization.JsonPropertyName("networktype")]

View File

@@ -8,13 +8,13 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
public class WechatApiClientOptions
{
/// <summary>
/// <para>获取或设置请求超时时间(单位:毫秒)。</para>
/// 获取或设置请求超时时间(单位:毫秒)。
/// <para>默认值30000</para>
/// </summary>
public int Timeout { get; set; } = 30 * 1000;
/// <summary>
/// <para>获取或设置微信 API 域名。</para>
/// 获取或设置微信 API 域名。
/// <para>默认值:<see cref="WechatApiEndpoints.DEFAULT"/></para>
/// </summary>
public string? Endpoints { get; set; } = WechatApiEndpoints.DEFAULT;

View File

@@ -8,15 +8,14 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
public abstract class WechatApiRequest : IWechatRequest
{
/// <summary>
/// <para>获取或设置请求超时时间(单位:毫秒)。</para>
/// <para>如果不指定将使用构造 <see cref="WechatApiClient"/> 时的 <see cref="WechatApiClientOptions.Timeout"/> 参数,这在需要指定特定耗时请求(比如上传或下载文件)的超时时间时很有用。</para>
/// 获取或设置请求超时时间(单位:毫秒)。如果不指定将使用构造 <see cref="WechatApiClient"/> 时的 <see cref="WechatApiClientOptions.Timeout"/> 参数,这在需要指定特定耗时请求(比如上传或下载文件)的超时时间时很有用。
/// </summary>
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public virtual int? Timeout { get; set; }
/// <summary>
/// <para>获取或设置微信 AccessToken。</para>
/// 获取或设置微信 AccessToken。
/// <para>注意:部分开放平台的接口中该字段表示授权方 AccessToken。</para>
/// </summary>
[Newtonsoft.Json.JsonIgnore]