Skip to content

Commit

Permalink
Updates DocC asides to use > instead of - (#28)
Browse files Browse the repository at this point in the history
* Updates DocC asides to use `>` instead of `-`

* Renames "Attention" aside to "Important"
  • Loading branch information
stevapple committed Aug 24, 2023
1 parent 6a49e0e commit b448642
Show file tree
Hide file tree
Showing 29 changed files with 112 additions and 148 deletions.
8 changes: 4 additions & 4 deletions Sources/Teco/Cdn/V20180606/actions/DescribeIpStatus.swift
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ extension Cdn {
///
/// DescribeIpStatus 用于查询域名所在加速平台的边缘节点、回源节点明细。注意事项:暂不支持查询边缘节点信息并且数据会存在一定延迟。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41954),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41954),使用 CDN 相关API 进行操作。
@inlinable
public func describeIpStatus(_ input: DescribeIpStatusRequest, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeIpStatusResponse> {
self.client.execute(action: "DescribeIpStatus", region: region, serviceConfig: self.config, input: input, logger: logger, on: eventLoop)
Expand All @@ -96,7 +96,7 @@ extension Cdn {
///
/// DescribeIpStatus 用于查询域名所在加速平台的边缘节点、回源节点明细。注意事项:暂不支持查询边缘节点信息并且数据会存在一定延迟。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41954),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41954),使用 CDN 相关API 进行操作。
@inlinable
public func describeIpStatus(_ input: DescribeIpStatusRequest, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) async throws -> DescribeIpStatusResponse {
try await self.client.execute(action: "DescribeIpStatus", region: region, serviceConfig: self.config, input: input, logger: logger, on: eventLoop).get()
Expand All @@ -106,7 +106,7 @@ extension Cdn {
///
/// DescribeIpStatus 用于查询域名所在加速平台的边缘节点、回源节点明细。注意事项:暂不支持查询边缘节点信息并且数据会存在一定延迟。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41954),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41954),使用 CDN 相关API 进行操作。
@inlinable
public func describeIpStatus(domain: String, layer: String? = nil, area: String? = nil, segment: Bool? = nil, showIpv6: Bool? = nil, abbreviationIpv6: Bool? = nil, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeIpStatusResponse> {
self.describeIpStatus(.init(domain: domain, layer: layer, area: area, segment: segment, showIpv6: showIpv6, abbreviationIpv6: abbreviationIpv6), region: region, logger: logger, on: eventLoop)
Expand All @@ -116,7 +116,7 @@ extension Cdn {
///
/// DescribeIpStatus 用于查询域名所在加速平台的边缘节点、回源节点明细。注意事项:暂不支持查询边缘节点信息并且数据会存在一定延迟。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41954),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41954),使用 CDN 相关API 进行操作。
@inlinable
public func describeIpStatus(domain: String, layer: String? = nil, area: String? = nil, segment: Bool? = nil, showIpv6: Bool? = nil, abbreviationIpv6: Bool? = nil, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) async throws -> DescribeIpStatusResponse {
try await self.describeIpStatus(.init(domain: domain, layer: layer, area: area, segment: segment, showIpv6: showIpv6, abbreviationIpv6: abbreviationIpv6), region: region, logger: logger, on: eventLoop)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ extension Cvm {
public let instanceChargeType: String

/// 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。
/// - Note: 若指定实例的付费模式为预付费则该参数必传。
/// > Note: 若指定实例的付费模式为预付费则该参数必传。
public let instanceChargePrepaid: InstanceChargePrepaid?

/// 是否同时切换弹性数据云盘计费模式。取值范围:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ extension Cvm {

/// 实例名称。可任意命名,但不得超过60个字符。
///
/// - Note: 必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置
/// > Note: 必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置
public let instanceName: String?

/// 指定实例的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。
/// - Note: 必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置
/// > Note: 必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置
public let securityGroups: [String]?

/// 给实例绑定用户角色,传空值为解绑操作
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ extension Cvm {
public let instanceChargeType: String

/// 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。
/// - Note: 若指定实例的付费模式为预付费则该参数必传。
/// > Note: 若指定实例的付费模式为预付费则该参数必传。
public let instanceChargePrepaid: InstanceChargePrepaid?

/// 是否同时切换弹性数据云盘计费模式。取值范围:
Expand Down
2 changes: 1 addition & 1 deletion Sources/Teco/Cvm/V20170312/actions/RenewInstances.swift
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ extension Cvm {
public let instanceIds: [String]

/// 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
/// - Note: 包年包月实例该参数为必传参数。
/// > Note: 包年包月实例该参数为必传参数。
public let instanceChargePrepaid: InstanceChargePrepaid?

/// 是否续费弹性数据盘。取值范围:
Expand Down
8 changes: 4 additions & 4 deletions Sources/Teco/Ecdn/V20191012/actions/AddEcdnDomain.swift
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ extension Ecdn {
///
/// 本接口(AddEcdnDomain)用于创建加速域名。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41123),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41123),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable @discardableResult
public func addEcdnDomain(_ input: AddEcdnDomainRequest, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AddEcdnDomainResponse> {
Expand All @@ -118,7 +118,7 @@ extension Ecdn {
///
/// 本接口(AddEcdnDomain)用于创建加速域名。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41123),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41123),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable @discardableResult
public func addEcdnDomain(_ input: AddEcdnDomainRequest, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) async throws -> AddEcdnDomainResponse {
Expand All @@ -129,7 +129,7 @@ extension Ecdn {
///
/// 本接口(AddEcdnDomain)用于创建加速域名。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41123),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41123),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable @discardableResult
public func addEcdnDomain(domain: String, origin: Origin, area: String, projectId: Int64? = nil, ipFilter: IpFilter? = nil, ipFreqLimit: IpFreqLimit? = nil, responseHeader: ResponseHeader? = nil, cacheKey: CacheKey? = nil, cache: Cache? = nil, https: Https? = nil, forceRedirect: ForceRedirect? = nil, tag: [Tag]? = nil, webSocket: WebSocket? = nil, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AddEcdnDomainResponse> {
Expand All @@ -140,7 +140,7 @@ extension Ecdn {
///
/// 本接口(AddEcdnDomain)用于创建加速域名。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41123),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41123),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable @discardableResult
public func addEcdnDomain(domain: String, origin: Origin, area: String, projectId: Int64? = nil, ipFilter: IpFilter? = nil, ipFreqLimit: IpFreqLimit? = nil, responseHeader: ResponseHeader? = nil, cacheKey: CacheKey? = nil, cache: Cache? = nil, https: Https? = nil, forceRedirect: ForceRedirect? = nil, tag: [Tag]? = nil, webSocket: WebSocket? = nil, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) async throws -> AddEcdnDomainResponse {
Expand Down
8 changes: 4 additions & 4 deletions Sources/Teco/Ecdn/V20191012/actions/CreateVerifyRecord.swift
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ extension Ecdn {
///
/// 生成一条子域名解析,提示客户添加到域名解析上,用于泛域名及域名取回校验归属权。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/48118),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/48118),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable
public func createVerifyRecord(_ input: CreateVerifyRecordRequest, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateVerifyRecordResponse> {
Expand All @@ -70,7 +70,7 @@ extension Ecdn {
///
/// 生成一条子域名解析,提示客户添加到域名解析上,用于泛域名及域名取回校验归属权。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/48118),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/48118),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable
public func createVerifyRecord(_ input: CreateVerifyRecordRequest, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) async throws -> CreateVerifyRecordResponse {
Expand All @@ -81,7 +81,7 @@ extension Ecdn {
///
/// 生成一条子域名解析,提示客户添加到域名解析上,用于泛域名及域名取回校验归属权。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/48118),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/48118),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable
public func createVerifyRecord(domain: String, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateVerifyRecordResponse> {
Expand All @@ -92,7 +92,7 @@ extension Ecdn {
///
/// 生成一条子域名解析,提示客户添加到域名解析上,用于泛域名及域名取回校验归属权。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/48118),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/48118),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable
public func createVerifyRecord(domain: String, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) async throws -> CreateVerifyRecordResponse {
Expand Down
8 changes: 4 additions & 4 deletions Sources/Teco/Ecdn/V20191012/actions/DeleteEcdnDomain.swift
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ extension Ecdn {
///
/// 本接口(DeleteEcdnDomain)用于删除指定加速域名。待删除域名必须处于已停用状态。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41122),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41122),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable @discardableResult
public func deleteEcdnDomain(_ input: DeleteEcdnDomainRequest, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEcdnDomainResponse> {
Expand All @@ -58,7 +58,7 @@ extension Ecdn {
///
/// 本接口(DeleteEcdnDomain)用于删除指定加速域名。待删除域名必须处于已停用状态。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41122),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41122),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable @discardableResult
public func deleteEcdnDomain(_ input: DeleteEcdnDomainRequest, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) async throws -> DeleteEcdnDomainResponse {
Expand All @@ -69,7 +69,7 @@ extension Ecdn {
///
/// 本接口(DeleteEcdnDomain)用于删除指定加速域名。待删除域名必须处于已停用状态。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41122),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41122),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable @discardableResult
public func deleteEcdnDomain(domain: String, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEcdnDomainResponse> {
Expand All @@ -80,7 +80,7 @@ extension Ecdn {
///
/// 本接口(DeleteEcdnDomain)用于删除指定加速域名。待删除域名必须处于已停用状态。
///
/// - Attention: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41122),使用 CDN 相关API 进行操作。
/// > Important: 若您的业务已迁移至 CDN 控制台,请参考[ CDN 接口文档](https://cloud.tencent.com/document/api/228/41122),使用 CDN 相关API 进行操作。
@available(*, unavailable, message: "ECDN融合CDN后,接口都用CDN的,此接口已经废弃")
@inlinable @discardableResult
public func deleteEcdnDomain(domain: String, region: TCRegion? = nil, logger: Logger = TCClient.loggingDisabled, on eventLoop: EventLoop? = nil) async throws -> DeleteEcdnDomainResponse {
Expand Down

0 comments on commit b448642

Please sign in to comment.