@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/ListPluginClassesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPluginClassesRequest extends $dara.Model {
   /**
    * @remarks
-   * The alias keyword for a fuzzy search.
+   * The plug-in alias. Fuzzy match is supported.
    * 
    * @example
    * OAuth2 认证
@@ -13,11 +13,10 @@ export class ListPluginClassesRequest extends $dara.Model {
   aliasLike?: string;
   /**
    * @remarks
-   * The traffic direction. Valid values: 
-   * 
-   * *   OutBound
-   * *   InBound
-   * *   Both
+   * The inbound or outbound direction. Valid values:
+   * - OutBound: outbound.
+   * - InBound: inbound.
+   * - Both: both directions.
    * 
    * @example
    * InBound
@@ -25,7 +24,7 @@ export class ListPluginClassesRequest extends $dara.Model {
   direction?: string;
   /**
    * @remarks
-   * Specifies whether to exclude built-in plugins.
+   * Specifies whether to exclude built-in plug-ins.
    * 
    * @example
    * true
@@ -41,7 +40,7 @@ export class ListPluginClassesRequest extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The instance type. Valid values: **AI** and **API**.
+   * The gateway type filter. Currently, **AI** and **API** gateway types are supported.
    * 
    * @example
    * API
@@ -49,7 +48,7 @@ export class ListPluginClassesRequest extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * Indicates whether the plugin is installed.
+   * Specifies whether the plug-in is installed.
    * 
    * @example
    * false
@@ -57,7 +56,7 @@ export class ListPluginClassesRequest extends $dara.Model {
   installed?: boolean;
   /**
    * @remarks
-   * The plugin name for a fuzzy search.
+   * The plug-in name. Fuzzy match is supported.
    * 
    * @example
    * oauth
@@ -81,11 +80,10 @@ export class ListPluginClassesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The plugin source. Valid values: 
-   * 
-   * *   HigressOfficial
-   * *   HigressCommunity
-   * *   Custom
+   * The plug-in source. Valid values:
+   * - HigressOfficial: Higress official.
+   * - HigressCommunity: Higress community.
+   * - Custom: custom.
    * 
    * @example
    * HigressOfficial
@@ -93,7 +91,7 @@ export class ListPluginClassesRequest extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * The type of the plugin.
+   * The plug-in type.
    * 
    * @example
    * Auth

package/src/models/ListPluginClassesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
-   * The alias of the plugin.
+   * The plug-in alias.
    * 
    * @example
    * OAuth2 认证
@@ -13,7 +13,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   alias?: string;
   /**
    * @remarks
-   * The description of the plugin.
+   * The plug-in description.
    * 
    * @example
    * 基于 OAuth2 实现身份认证和鉴权。
@@ -21,7 +21,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Indicates whether the plugin is installed.
+   * Indicates whether the plug-in is installed.
    * 
    * @example
    * true
@@ -29,7 +29,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   installed?: boolean;
   /**
    * @remarks
-   * The plugin name.
+   * The plug-in name.
    * 
    * @example
    * oauth
@@ -37,7 +37,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The plugin type ID.
+   * The plug-in type ID.
    * 
    * @example
    * pls-d4ghv6em1hkixxxxxxxx
@@ -45,7 +45,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   pluginClassId?: string;
   /**
    * @remarks
-   * The plugin ID.
+   * The plug-in ID.
    * 
    * @example
    * pl-cvu6r4um1hkoxxxxxxxx
@@ -53,7 +53,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   pluginId?: string;
   /**
    * @remarks
-   * The publishing status.
+   * The publish status.
    * 
    * @example
    * Success
@@ -61,7 +61,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   publishStatus?: string;
   /**
    * @remarks
-   * The source of the plugin.
+   * The plug-in source.
    * 
    * @example
    * HigressOfficial
@@ -69,7 +69,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * The minimum version of the gateway supported by the plugin.
+   * The minimum gateway version supported by the plug-in.
    * 
    * @example
    * 2.0.0
@@ -77,7 +77,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   supportedMinGatewayVersion?: string;
   /**
    * @remarks
-   * The type of the plugin.
+   * The plug-in type.
    * 
    * @example
    * Auth
@@ -85,7 +85,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The version.
+   * The plug-in version.
    * 
    * @example
    * 1.0.0
@@ -135,7 +135,7 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
 export class ListPluginClassesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The plugin details.
+   * The result objects.
    */
   items?: ListPluginClassesResponseBodyDataItems[];
   /**
@@ -195,7 +195,7 @@ export class ListPluginClassesResponseBodyData extends $dara.Model {
 export class ListPluginClassesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * 200
@@ -203,12 +203,12 @@ export class ListPluginClassesResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The response data.
    */
   data?: ListPluginClassesResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The error message.
    * 
    * @example
    * success
@@ -216,7 +216,7 @@ export class ListPluginClassesResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request
+   * The request ID.
    * 
    * @example
    * 61EBF577-1601-51E1-B136-9CD6xxxxxxxx

package/src/models/ListPluginsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPluginsRequest extends $dara.Model {
   /**
    * @remarks
-   * The resource attachment ID.
+   * The ID of the attached resource.
    * 
    * @example
    * api-cuip2pum1hksng6oni3g
@@ -13,15 +13,15 @@ export class ListPluginsRequest extends $dara.Model {
   attachResourceId?: string;
   /**
    * @remarks
-   * The resource attachment type.
+   * The type of the attachment point supported by the policy.
    * 
    * - HttpApi: HttpApi.
    * - Operation: Operation of HttpApi.
-   * - GatewayRoute: Gateway route.
-   * - GatewayService: Gateway service.
-   * - GatewayServicePort: Gateway service port.
-   * - Domain: Gateway domain.
-   * - Gateway: Gateway.
+   * - GatewayRoute: gateway route.
+   * - GatewayService: gateway service.
+   * - GatewayServicePort: gateway service port.
+   * - Domain: gateway domain name.
+   * - Gateway: gateway.
    * 
    * @example
    * HttpApi
@@ -29,7 +29,7 @@ export class ListPluginsRequest extends $dara.Model {
   attachResourceType?: string;
   /**
    * @remarks
-   * The gateway instance ID for filtering.
+   * The ID of the gateway instance used to filter results.
    * 
    * @example
    * gw-csrhgn6m1hkt65qbxxgg
@@ -37,7 +37,7 @@ export class ListPluginsRequest extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The instance type. Valid values: **AI** and **API**.
+   * The gateway type used to filter results. Valid values: **AI** and **API**.
    * 
    * @example
    * AI
@@ -45,7 +45,7 @@ export class ListPluginsRequest extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * Specifies whether to include built-in AI plug-ins in the returned results. Default: false.
+   * Specifies whether the response includes built-in AI plugins installed by the system. Default value: false.
    * 
    * @example
    * false
@@ -53,7 +53,7 @@ export class ListPluginsRequest extends $dara.Model {
   includeBuiltinAiGateway?: boolean;
   /**
    * @remarks
-   * The page number to return. Pages start from 1. Default value: 1.
+   * The page number.
    * 
    * @example
    * 1
@@ -61,7 +61,7 @@ export class ListPluginsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: 10.
+   * The page size.
    * 
    * @example
    * 10
@@ -69,7 +69,7 @@ export class ListPluginsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The plug-in type ID for filtering.
+   * The ID of the plugin type used to filter results.
    * 
    * @example
    * pls-dn82a9djd8z****
@@ -77,7 +77,7 @@ export class ListPluginsRequest extends $dara.Model {
   pluginClassId?: string;
   /**
    * @remarks
-   * The plug-in type name for filtering.
+   * The name of the plugin type used to filter results.
    * 
    * @example
    * key-auth
@@ -85,7 +85,7 @@ export class ListPluginsRequest extends $dara.Model {
   pluginClassName?: string;
   /**
    * @remarks
-   * Specifies whether the returned results should include plug-in attachment information corresponding to the attachResourceId.
+   * Specifies whether the response includes the plugin attachment information corresponding to attachResourceId.
    * 
    * @example
    * false

package/src/models/ListPluginsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPluginsResponseBodyDataItemsAttachmentInfo extends $dara.Model {
   /**
    * @remarks
-   * Indicates if enabled.
+   * Indicates whether the plugin is enabled.
    * 
    * @example
    * false
@@ -13,7 +13,7 @@ export class ListPluginsResponseBodyDataItemsAttachmentInfo extends $dara.Model
   enable?: string;
   /**
    * @remarks
-   * The attachment ID.
+   * The plugin attachment ID.
    * 
    * @example
    * pa-ct2irn6m1hkreaen0t40
@@ -45,7 +45,7 @@ export class ListPluginsResponseBodyDataItemsAttachmentInfo extends $dara.Model
 export class ListPluginsResponseBodyDataItemsGatewayInfo extends $dara.Model {
   /**
    * @remarks
-   * The instance ID.
+   * The gateway ID.
    * 
    * @example
    * gw-cq7og15lhtxx6qasrj60
@@ -53,7 +53,7 @@ export class ListPluginsResponseBodyDataItemsGatewayInfo extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The instance name.
+   * The gateway name.
    * 
    * @example
    * apitest-gw
@@ -109,7 +109,7 @@ export class ListPluginsResponseBodyDataItemsPluginClassInfo extends $dara.Model
   executeStage?: string;
   /**
    * @remarks
-   * The name of the plug-in.
+   * The plugin name.
    * 
    * @example
    * key-rate-limit
@@ -117,7 +117,7 @@ export class ListPluginsResponseBodyDataItemsPluginClassInfo extends $dara.Model
   name?: string;
   /**
    * @remarks
-   * The plug-in type ID.
+   * The plugin type ID.
    * 
    * @example
    * pls-cqebrgh46ppatmpri
@@ -125,7 +125,7 @@ export class ListPluginsResponseBodyDataItemsPluginClassInfo extends $dara.Model
   pluginClassId?: string;
   /**
    * @remarks
-   * The source of the plug-in.
+   * The plugin source.
    * 
    * @example
    * HigressOfficial
@@ -141,7 +141,7 @@ export class ListPluginsResponseBodyDataItemsPluginClassInfo extends $dara.Model
   version?: string;
   /**
    * @remarks
-   * The description of the version.
+   * The version description.
    * 
    * @example
    * 版本描述
@@ -185,22 +185,22 @@ export class ListPluginsResponseBodyDataItemsPluginClassInfo extends $dara.Model
 export class ListPluginsResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
-   * The attachment information.
+   * The plugin attachment information.
    */
   attachmentInfo?: ListPluginsResponseBodyDataItemsAttachmentInfo;
   /**
    * @remarks
-   * The gateway instance information.
+   * The gateway information.
    */
   gatewayInfo?: ListPluginsResponseBodyDataItemsGatewayInfo;
   /**
    * @remarks
-   * The plug-in type information.
+   * The plugin type information.
    */
   pluginClassInfo?: ListPluginsResponseBodyDataItemsPluginClassInfo;
   /**
    * @remarks
-   * The plug-in ID.
+   * The plugin ID.
    * 
    * @example
    * pl-cvu6r4um1hko3b3ti0a0
@@ -245,7 +245,7 @@ export class ListPluginsResponseBodyDataItems extends $dara.Model {
 export class ListPluginsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The list of plug-in information.
+   * The plugin list.
    */
   items?: ListPluginsResponseBodyDataItems[];
   /**
@@ -266,7 +266,7 @@ export class ListPluginsResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 10
@@ -305,7 +305,7 @@ export class ListPluginsResponseBodyData extends $dara.Model {
 export class ListPluginsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -313,12 +313,12 @@ export class ListPluginsResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response payload.
+   * The returned data.
    */
   data?: ListPluginsResponseBodyData;
   /**
    * @remarks
-   * The status message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/ListPoliciesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPoliciesRequest extends $dara.Model {
   /**
    * @remarks
-   * The attachment point ID.
+   * The ID of the attachment point.
    * 
    * @example
    * api-cq7l5s5lhtgi6qasrdc0
@@ -13,21 +13,16 @@ export class ListPoliciesRequest extends $dara.Model {
   attachResourceId?: string;
   /**
    * @remarks
-   * The types of attachment points supported by the policy. Valid values:
+   * The type of attachment point supported by the policy.
    * 
-   * - HttpApi
-   * 
-   * - Operation
-   * 
-   * - GatewayRoute
-   * 
-   * - GatewayService
-   * 
-   * - GatewayServicePort
-   * 
-   * - Domain
-   * 
-   * - Gateway
+   * Valid values:
+   * - HttpApi: HTTP API.
+   * - Operation: Operation of an HTTP API.
+   * - GatewayRoute: Gateway route.
+   * - GatewayService: Gateway service.
+   * - GatewayServicePort: Gateway service port.
+   * - Domain: Gateway domain name.
+   * - Gateway: Gateway.
    * 
    * @example
    * HttpApi
@@ -59,7 +54,7 @@ export class ListPoliciesRequest extends $dara.Model {
   withAttachments?: boolean;
   /**
    * @remarks
-   * Specifies whether it is a system policy.
+   * Specifies whether the policy is a system policy.
    * 
    * @example
    * true

package/src/models/ListPoliciesResponseBody.ts

@@ -19,7 +19,7 @@ export class ListPoliciesResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -27,7 +27,7 @@ export class ListPoliciesResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 18
@@ -66,7 +66,7 @@ export class ListPoliciesResponseBodyData extends $dara.Model {
 export class ListPoliciesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response code.
    * 
    * @example
    * Ok
@@ -74,12 +74,12 @@ export class ListPoliciesResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response payload.
+   * The response data.
    */
   data?: ListPoliciesResponseBodyData;
   /**
    * @remarks
-   * The status message.
+   * The response message.
    * 
    * @example
    * success
@@ -87,7 +87,7 @@ export class ListPoliciesResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID for API call tracing.
+   * The request ID, which is used to trace the API call chain.
    * 
    * @example
    * 393E2630-DBE7-5221-AB35-9E740675491A

package/src/models/ListPolicyClassesRequest.ts

@@ -13,7 +13,7 @@ export class ListPolicyClassesRequest extends $dara.Model {
   attachResourceId?: string;
   /**
    * @remarks
-   * The type of resource that the policy can be attached to. Valid values:
+   * The type of the resource to which the policy can be attached. Valid values:
    * - HttpApi: HttpApi.
    * - Operation: an operation of an HttpApi.
    * - GatewayRoute: a gateway route.

package/src/models/ListSecretReferencesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSecretReferencesRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number. The value starts from 1. Default value: 1.
+   * The page number. Pages start from 1. Default value: 1.
    * 
    * @example
    * 1

package/src/models/ListSecretReferencesResponseBody.ts

@@ -135,7 +135,7 @@ export class ListSecretReferencesResponseBodyDataItemsConsumerConfig extends $da
 export class ListSecretReferencesResponseBodyDataItemsMcpServerConfig extends $dara.Model {
   /**
    * @remarks
-   * The HTTP API ID.
+   * HTTP API ID。
    * 
    * @example
    * api-d2vv43em201hxxxxxxxx
@@ -185,17 +185,17 @@ export class ListSecretReferencesResponseBodyDataItemsMcpServerConfig extends $d
 export class ListSecretReferencesResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
-   * The information about the plug-in that references the current key.
+   * The plug-in information that references the current secret.
    */
   pluginConfig?: ListSecretReferencesResponseBodyDataItemsPluginConfig;
   /**
    * @remarks
-   * The service information that references the current key.
+   * The service information that references the current secret.
    */
   serviceConfig?: ListSecretReferencesResponseBodyDataItemsServiceConfig;
   /**
    * @remarks
-   * The consumer information that references the current key.
+   * The consumer information that references the current secret.
    */
   consumerConfig?: ListSecretReferencesResponseBodyDataItemsConsumerConfig;
   /**
@@ -208,12 +208,12 @@ export class ListSecretReferencesResponseBodyDataItems extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * MCP service information that references the current key.
+   * The MCP server information that references the current secret.
    */
   mcpServerConfig?: ListSecretReferencesResponseBodyDataItemsMcpServerConfig;
   /**
    * @remarks
-   * The type of resource.
+   * The resource type.
    * 
    * @example
    * Plugin
@@ -286,7 +286,7 @@ export class ListSecretReferencesResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 25
@@ -325,7 +325,7 @@ export class ListSecretReferencesResponseBodyData extends $dara.Model {
 export class ListSecretReferencesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -333,7 +333,7 @@ export class ListSecretReferencesResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned data.
+   * The response data.
    */
   data?: ListSecretReferencesResponseBodyData;
   /**

package/src/models/ListSecretsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSecretsRequest extends $dara.Model {
   /**
    * @remarks
-   * Gateway type for filtering secrets of specific gateway type
+   * The gateway type used to filter results. Valid values: **AI** and **API**.
    * 
    * @example
    * AI
@@ -13,7 +13,7 @@ export class ListSecretsRequest extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * Secret name for fuzzy matching, supports filtering secrets by name
+   * The key name. Fuzzy match is supported.
    * 
    * @example
    * my_secret
@@ -21,7 +21,7 @@ export class ListSecretsRequest extends $dara.Model {
   nameLike?: string;
   /**
    * @remarks
-   * Page number
+   * The page number.
    * 
    * @example
    * 1
@@ -29,7 +29,7 @@ export class ListSecretsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Number of items per page
+   * The page size. Valid values: 1 to 100. Default value: 10.
    * 
    * @example
    * 10