@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/ListGatewayFeaturesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListGatewayFeaturesResponseBodyDataItemsDefinitionValueOptions extends $dara.Model {
   /**
    * @remarks
-   * The key to pass the parameter.
+   * The pass parameter key.
    * 
    * @example
    * KEEP_UNCHANGED
@@ -45,7 +45,7 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinitionValueOptions exte
 export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Model {
   /**
    * @remarks
-   * The default value of the parameter.
+   * The default value.
    * 
    * @example
    * "true"
@@ -69,10 +69,9 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   displayName?: string;
   /**
    * @remarks
-   * The parameter group to which the parameter belongs. Valid values:
-   * 
-   * *   Telemetry: an observability parameter
-   * *   Engine: an engine parameter
+   * The parameter group. Valid values:
+   * - Telemetry: observability parameter.
+   * - Engine: engine parameter.
    * 
    * @example
    * Engine
@@ -81,11 +80,10 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   /**
    * @remarks
    * The input type of the parameter. Valid values:
-   * 
-   * *   Trigger
-   * *   Input
-   * *   SingleSelect
-   * *   MultiSelect
+   * - Trigger: toggle.
+   * - Input: input.
+   * - SingleSelect: single-select.
+   * - MultiSelect: multi-select.
    * 
    * @example
    * Trigger
@@ -93,7 +91,7 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   inputType?: string;
   /**
    * @remarks
-   * The maximum length of the value. This parameter is valid when the value type is string.
+   * The maximum length supported by the parameter value. This is valid only when the value type is string.
    * 
    * @example
    * 64
@@ -101,7 +99,7 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   maxLength?: number;
   /**
    * @remarks
-   * The maximum value of the parameter. This parameter is valid when the value type is int32, int64, or float.
+   * The maximum value supported by the parameter. This is valid only when the value type is int32, int64, or float.
    * 
    * @example
    * 65535
@@ -109,7 +107,7 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   maxValue?: string;
   /**
    * @remarks
-   * The minimum length of the value. This parameter is valid when the value type is string.
+   * The minimum length supported by the parameter value. This is valid only when the value type is string.
    * 
    * @example
    * 8
@@ -117,7 +115,7 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   minLength?: number;
   /**
    * @remarks
-   * The minimum value of the parameter. This parameter is valid when the value type is int32, int64, or float.
+   * The minimum value supported by the parameter. This is valid only when the value type is int32, int64, or float.
    * 
    * @example
    * 100
@@ -141,7 +139,7 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   readOnly?: boolean;
   /**
    * @remarks
-   * The regular expression that the parameter value must fulfill. This parameter is valid when the value type is string.
+   * The regular expression that the parameter value must match. This is valid only when the parameter value type is string.
    * 
    * @example
    * [a-z].*
@@ -154,15 +152,14 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   valueOptions?: ListGatewayFeaturesResponseBodyDataItemsDefinitionValueOptions[];
   /**
    * @remarks
-   * The value type of the parameter. Valid values:
-   * 
-   * *   bool: boolean
-   * *   string
-   * *   int32: integer
-   * *   int64: long integer
-   * *   json
-   * *   array: JSON array
-   * *   float: floating point
+   * The type supported by the parameter value. Valid values:
+   * - bool: Boolean.
+   * - string: String.
+   * - int32: Integer.
+   * - int64: Long integer.
+   * - json: JSON format.
+   * - array: JSON array format.
+   * - float: Float.
    * 
    * @example
    * bool
@@ -170,7 +167,7 @@ export class ListGatewayFeaturesResponseBodyDataItemsDefinition extends $dara.Mo
   valueType?: string;
   /**
    * @remarks
-   * The value unit.
+   * The unit.
    * 
    * @example
    * byte
@@ -271,7 +268,7 @@ export class ListGatewayFeaturesResponseBodyDataItems extends $dara.Model {
 export class ListGatewayFeaturesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The list of parameter configurations.
+   * The list of parameter settings.
    */
   items?: ListGatewayFeaturesResponseBodyDataItems[];
   static names(): { [key: string]: string } {
@@ -301,7 +298,7 @@ export class ListGatewayFeaturesResponseBodyData extends $dara.Model {
 export class ListGatewayFeaturesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -309,12 +306,12 @@ export class ListGatewayFeaturesResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned data.
+   * The response data.
    */
   data?: ListGatewayFeaturesResponseBodyData;
   /**
    * @remarks
-   * The response message returned.
+   * The response message.
    * 
    * @example
    * success

package/src/models/ListGatewayQuotaRulesRequest.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListGatewayQuotaRulesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The rule name keyword, used for fuzzy match.
+   * 
    * @example
    * daily
    */
   keyword?: string;
   /**
+   * @remarks
+   * The maximum number of records to retrieve in a single request. This parameter is not supported.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token. This parameter is not supported.
+   * 
    * @example
    * C4tM8BlBJwHSNyjWpGaci4/7dKNGp1JMgsKtvCagmtY=
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */

package/src/models/ListGatewayQuotaRulesResponseBody.ts

@@ -4,41 +4,65 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListGatewayQuotaRulesResponseBodyDataItems extends $dara.Model {
   /**
+   * @remarks
+   * The period type.
+   * 
    * @example
    * week
    */
   periodType?: string;
   /**
+   * @remarks
+   * The quota dimension.
+   * 
    * @example
    * token
    */
   quotaDimension?: string;
   /**
+   * @remarks
+   * The quota limit.
+   * 
    * @example
    * 1000
    */
   quotaLimit?: number;
   /**
+   * @remarks
+   * The rule ID.
+   * 
    * @example
    * qr-xxxxx
    */
   ruleId?: string;
   /**
+   * @remarks
+   * The rule name.
+   * 
    * @example
    * daily-token-limit
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The rule status.
+   * 
    * @example
    * enabled
    */
   ruleStatus?: string;
   /**
+   * @remarks
+   * The time zone for the calendar period, in UTC+x format.
+   * 
    * @example
    * GMT+8
    */
   timezone?: string;
   /**
+   * @remarks
+   * The reset period type. Only calendar periods are supported, which means windowAlignment="calendar".
+   * 
    * @example
    * calendar
    */
@@ -80,21 +104,33 @@ export class ListGatewayQuotaRulesResponseBodyDataItems extends $dara.Model {
 
 export class ListGatewayQuotaRulesResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The list of rules.
+   * 
    * @example
    * [{"ruleId":"rule-001"}]
    */
   items?: ListGatewayQuotaRulesResponseBodyDataItems[];
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The current page size.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 100
    */
@@ -131,31 +167,49 @@ export class ListGatewayQuotaRulesResponseBodyData extends $dara.Model {
 
 export class ListGatewayQuotaRulesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * The response data.
+   * 
    * @example
    * {"totalSize":100}
    */
   data?: ListGatewayQuotaRulesResponseBodyData;
   /**
+   * @remarks
+   * The maximum number of records to retrieve in a single request. This parameter is not supported.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The pagination token. This parameter is not supported.
+   * 
    * @example
    * 762b1fa4e2434fd3959b1f66481979cf
    */
   nextToken?: string;
   /**
+   * @remarks
+   * Id of the request
+   * 
    * @example
    * 1234567890
    */

package/src/models/ListGatewaysRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListGatewaysRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The key of tag N.
+   * The tag key.
    * 
    * @example
    * owner
@@ -13,7 +13,7 @@ export class ListGatewaysRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The value of tag N.
+   * The tag value.
    * 
    * @example
    * zhangsan
@@ -45,7 +45,7 @@ export class ListGatewaysRequestTag extends $dara.Model {
 export class ListGatewaysRequest extends $dara.Model {
   /**
    * @remarks
-   * Retrieve the list of created cloud-native gateways
+   * The gateway ID for exact match query.
    * 
    * @example
    * gw-cpv4sqdl****
@@ -53,7 +53,7 @@ export class ListGatewaysRequest extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The search keyword. A full match is performed. The search is case-insensitive.
+   * The gateway type.
    * 
    * @example
    * API
@@ -61,7 +61,7 @@ export class ListGatewaysRequest extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * The instance name. If you specify a name, an exact search is performed.
+   * The keyword for full match search. Case-insensitive.
    * 
    * @example
    * dev
@@ -69,7 +69,7 @@ export class ListGatewaysRequest extends $dara.Model {
   keyword?: string;
   /**
    * @remarks
-   * The number of entries per page.
+   * The gateway name for exact match query.
    * 
    * @example
    * itemcenter-gateway
@@ -77,7 +77,7 @@ export class ListGatewaysRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The instance ID. If you specify an ID, an exact search is performed.
+   * The page number.
    * 
    * @example
    * 1
@@ -85,7 +85,7 @@ export class ListGatewaysRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of the page to return.
+   * The page size.
    * 
    * @example
    * 10
@@ -93,7 +93,7 @@ export class ListGatewaysRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * rg-aekz3wes3hnre5a
+   * The resource group ID.
    * 
    * @example
    * rg-aekzq6bzz5uyg2q
@@ -101,7 +101,7 @@ export class ListGatewaysRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The tags that you want to use for the search.
+   * The list of tags.
    */
   tag?: ListGatewaysRequestTag[];
   static names(): { [key: string]: string } {