@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/GetResourceOverviewResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetResourceOverviewResponseBodyDataApi extends $dara.Model {
   /**
    * @remarks
-   * Number of published APIs.
+   * The number of published APIs.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class GetResourceOverviewResponseBodyDataApi extends $dara.Model {
   publishedCount?: number;
   /**
    * @remarks
-   * Number of APIs.
+   * The total number of APIs.
    * 
    * @example
    * 1
@@ -45,7 +45,7 @@ export class GetResourceOverviewResponseBodyDataApi extends $dara.Model {
 export class GetResourceOverviewResponseBodyDataGateway extends $dara.Model {
   /**
    * @remarks
-   * Number of running gateways.
+   * The number of running gateways.
    * 
    * @example
    * 1
@@ -53,7 +53,7 @@ export class GetResourceOverviewResponseBodyDataGateway extends $dara.Model {
   runningCount?: number;
   /**
    * @remarks
-   * Number of gateway instances.
+   * The total number of gateway instances.
    * 
    * @example
    * 1
@@ -109,7 +109,7 @@ export class GetResourceOverviewResponseBodyDataRiskOverviewRiskDetails extends
   riskLevel?: string;
   /**
    * @remarks
-   * The risk name list.
+   * The list of risk names.
    */
   riskNames?: string[];
   /**
@@ -155,7 +155,7 @@ export class GetResourceOverviewResponseBodyDataRiskOverviewRiskDetails extends
 export class GetResourceOverviewResponseBodyDataRiskOverview extends $dara.Model {
   /**
    * @remarks
-   * The number of instances at a risk level.
+   * The number of instances at this risk level.
    * 
    * @example
    * 1
@@ -163,7 +163,7 @@ export class GetResourceOverviewResponseBodyDataRiskOverview extends $dara.Model
   count?: string;
   /**
    * @remarks
-   * The risk details list.
+   * The list of risk details.
    */
   riskDetails?: GetResourceOverviewResponseBodyDataRiskOverviewRiskDetails[];
   /**
@@ -205,12 +205,12 @@ export class GetResourceOverviewResponseBodyDataRiskOverview extends $dara.Model
 export class GetResourceOverviewResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * API information.
+   * The API information.
    */
   api?: GetResourceOverviewResponseBodyDataApi;
   /**
    * @remarks
-   * Gateway information.
+   * The gateway information.
    */
   gateway?: GetResourceOverviewResponseBodyDataGateway;
   /**
@@ -255,7 +255,7 @@ export class GetResourceOverviewResponseBodyData extends $dara.Model {
 export class GetResourceOverviewResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -268,7 +268,7 @@ export class GetResourceOverviewResponseBody extends $dara.Model {
   data?: GetResourceOverviewResponseBodyData;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -276,7 +276,7 @@ export class GetResourceOverviewResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * DD19A442-93C5-5C97-AFA0-B9C57EBD781B

package/src/models/GetSecretResponseBody.ts

@@ -14,10 +14,9 @@ export class GetSecretResponseBodyData extends $dara.Model {
   createTimestamp?: number;
   /**
    * @remarks
-   * The type of the gateway. Valid values:
-   * 
-   * *   API
-   * *   AI
+   * The gateway type. Valid values:
+   * - API: API gateway.
+   * - AI: AI gateway.
    * 
    * @example
    * API
@@ -46,7 +45,7 @@ export class GetSecretResponseBodyData extends $dara.Model {
   referenceCount?: number;
   /**
    * @remarks
-   * The ID of the key.
+   * The key ID.
    * 
    * @example
    * sec-d5e6shmm1hkoxxxxxxxx
@@ -54,7 +53,7 @@ export class GetSecretResponseBodyData extends $dara.Model {
   secretId?: string;
   /**
    * @remarks
-   * The source of the key.
+   * The key source.
    * 
    * @example
    * KMS
@@ -62,11 +61,10 @@ export class GetSecretResponseBodyData extends $dara.Model {
   secretSource?: string;
   /**
    * @remarks
-   * The state of the key. Valid values:
-   * 
-   * *   ENALBE
-   * *   DISABLE
-   * *   DELETED
+   * The key status. Valid values:
+   * - ENALBE: Enabled.
+   * - DISABLE: Disabled.
+   * - DELETED: Deleted.
    * 
    * @example
    * ENALBE
@@ -123,7 +121,7 @@ export class GetSecretResponseBodyData extends $dara.Model {
 export class GetSecretResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -136,7 +134,7 @@ export class GetSecretResponseBody extends $dara.Model {
   data?: GetSecretResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/GetSecretValueResponseBody.ts

@@ -35,7 +35,7 @@ export class GetSecretValueResponseBodyData extends $dara.Model {
 export class GetSecretValueResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -43,12 +43,12 @@ export class GetSecretValueResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response payload.
+   * The response data.
    */
   data?: GetSecretValueResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success
@@ -56,7 +56,7 @@ export class GetSecretValueResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 479AE38F-A574-52F7-87EA-E91199999F9E

package/src/models/GetServiceResponseBody.ts

@@ -27,7 +27,7 @@ export class GetServiceResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 8FA9BB94-915B-5299-A694-49FCC7F5DD00

package/src/models/GetSourceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetSourceResponseBodyDataK8SSourceInfo extends $dara.Model {
   /**
    * @remarks
-   * The container service cluster ID.
+   * The Container Service cluster ID.
    * 
    * @example
    * c2d290b2d8b5d4935864cace5f0173f31
@@ -116,7 +116,7 @@ export class GetSourceResponseBodyData extends $dara.Model {
   k8SSourceInfo?: GetSourceResponseBodyDataK8SSourceInfo;
   /**
    * @remarks
-   * The Microservices Engine (MSE) Nacos source information.
+   * The MSE Nacos source information.
    */
   nacosSourceInfo?: GetSourceResponseBodyDataNacosSourceInfo;
   /**

package/src/models/HiMarketApiKeyConfig.ts

@@ -5,12 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketApiKeyConfigCredentials extends $dara.Model {
   /**
    * @remarks
-   * The value of the API key.
+   * The API key value.
+   * 
+   * @example
+   * my-api-key-123
    */
   apiKey?: string;
   /**
    * @remarks
-   * The operational mode for the key, such as `test` or `production`.
+   * The generation mode.
+   * 
+   * @example
+   * Custom
    */
   mode?: string;
   static names(): { [key: string]: string } {
@@ -39,17 +45,23 @@ export class HiMarketApiKeyConfigCredentials extends $dara.Model {
 export class HiMarketApiKeyConfig extends $dara.Model {
   /**
    * @remarks
-   * An array of objects, each containing a valid API key and its associated mode.
+   * The list of credentials.
    */
   credentials?: HiMarketApiKeyConfigCredentials[];
   /**
    * @remarks
-   * The name of the parameter that holds the API key. For example, if `source` is `HEADER`, this is the request header name, such as `X-API-Key`.
+   * The name of the location from which the API key is extracted.
+   * 
+   * @example
+   * Apikey
    */
   key?: string;
   /**
    * @remarks
-   * The location of the API key in the request. Valid values are `HEADER` and `QUERY`.
+   * The source type of the API key.
+   * 
+   * @example
+   * Header
    */
   source?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketAuthCodeConfig.ts

@@ -5,47 +5,74 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketAuthCodeConfig extends $dara.Model {
   /**
    * @remarks
-   * The URL of the identity provider\\"s authorization endpoint. Your application redirects users to this URL to sign in and grant consent.
+   * The OAuth2 authorization endpoint URL.
+   * 
+   * @example
+   * https://idp.example.com/oauth2/authorize
    */
   authorizationEndpoint?: string;
   /**
    * @remarks
-   * The unique identifier for your application. The identity provider assigns this ID when you register your application.
+   * The OAuth2 client ID.
+   * 
+   * @example
+   * my-client-id
    */
   clientId?: string;
   /**
    * @remarks
-   * The secret key for your application. This secret authenticates your application with the identity provider.
+   * The OAuth2 client secret. The secret is AES-encrypted when stored.
+   * 
+   * @example
+   * my-client-secret
    */
   clientSecret?: string;
   /**
    * @remarks
-   * The URL of the identity provider that issues the tokens. This URL uniquely identifies the provider.
+   * The OIDC issuer URL.
+   * 
+   * @example
+   * https://idp.example.com
    */
   issuer?: string;
   /**
    * @remarks
-   * The URL of the identity provider\\"s JSON Web Key Set (JWKS) document. This document contains the public signing keys for token validation.
+   * The JWKS public key set URI, used for token signature verification.
+   * 
+   * @example
+   * https://idp.example.com/.well-known/jwks.json
    */
   jwkSetUri?: string;
   /**
    * @remarks
-   * The URL where the identity provider redirects the user after authorizing your application. This URL must be registered in your application settings with the identity provider.
+   * The OAuth2 callback URL.
+   * 
+   * @example
+   * https://gateway.example.com/callback
    */
   redirectUri?: string;
   /**
    * @remarks
-   * A space-separated list of requested permissions. For example: `openid profile`.
+   * The OAuth2 authorization scopes, separated by spaces.
+   * 
+   * @example
+   * openid profile email
    */
   scopes?: string;
   /**
    * @remarks
-   * The URL of the identity provider\\"s token endpoint. Your application uses this endpoint to exchange an authorization code for an access token.
+   * The OAuth2 token endpoint URL.
+   * 
+   * @example
+   * https://idp.example.com/oauth2/token
    */
   tokenEndpoint?: string;
   /**
    * @remarks
-   * The URL of the identity provider\\"s user info endpoint. Your application can use this endpoint to retrieve the authenticated user\\"s profile information.
+   * The OIDC UserInfo endpoint URL.
+   * 
+   * @example
+   * https://idp.example.com/userinfo
    */
   userInfoEndpoint?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketProductCategory.ts

@@ -6,22 +6,31 @@ import { HiMarketIcon } from "./HiMarketIcon";
 export class HiMarketProductCategory extends $dara.Model {
   /**
    * @remarks
-   * The unique category ID.
+   * The categorization ID.
+   * 
+   * @example
+   * cat-xxx
    */
   categoryId?: string;
   /**
    * @remarks
-   * The category description.
+   * The categorization description.
+   * 
+   * @example
+   * AI网关相关产品分类
    */
   description?: string;
   /**
    * @remarks
-   * The category icon.
+   * The icon configuration.
    */
   icon?: HiMarketIcon;
   /**
    * @remarks
-   * The category name.
+   * The categorization name.
+   * 
+   * @example
+   * AI网关
    */
   name?: string;
   static names(): { [key: string]: string } {

package/src/models/ImportHttpApiRequest.ts

@@ -70,7 +70,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Specifies whether to perform a dry run. If enabled, only validation is performed without the actual import.
+   * Specifies whether to perform a dry run. If enabled, only validation is performed without importing.
    * 
    * @example
    * false
@@ -94,7 +94,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   mcpRouteId?: string;
   /**
    * @remarks
-   * The name of the imported API. If this parameter is not specified, the name is extracted from the API definition file. If an API with the same name and version configuration already exists, this import updates the existing API definition based on the strategy parameter.
+   * The name of the imported API. If this parameter is not specified, the name is extracted from the API definition file. If an API with the same name and version configuration already exists, the import updates the existing API definition based on the strategy parameter.
    * 
    * @example
    * import-test
@@ -110,7 +110,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The Base64-encoded API definition. OAS 2.0 and OAS 3.0 specifications are supported in YAML or JSON format. This parameter takes priority over the specFileUrl parameter. If the file size exceeds 10 MB, use the specFileUrl parameter instead.
+   * The Base64-encoded API definition. OAS 2.0 and OAS 3.0 specifications are supported in YAML and JSON formats. This parameter takes priority over the specFileUrl parameter. If the file size exceeds 10 MB, use the specFileUrl parameter instead.
    * 
    * @example
    * b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6CiAgICAgICAgICAgIHN1bW1hcnk6IOiOt+WPlueUqOaIt+S/oeaBrwogICAgICAgICAgICBkZXNjcmlwdGlvbjog6I635Y+W55So5oi35L+h5oGvCiAgICAgICAgICAgIG9wZXJhdGlvbklkOiBHZXRVc2VySW5mbwogICAgICAgICAgICByZXNwb25zZXM6CiAgICAgICAgICAgICAgICAiMjAwIjoKICAgICAgICAgICAgICAgICAgICBkZXNjcmlwdGlvbjog5oiQ5YqfCiAgICAgICAgICAgICAgICAgICAgY29udGVudDoKICAgICAgICAgICAgICAgICAgICAgICAgYXBwbGljYXRpb24vanNvbjtjaGFyc2V0PXV0Zi04OgogICAgICAgICAgICAgICAgICAgICAgICAgICAgc2NoZW1hOiBudWxsCnNlcnZlcnM6CiAgICAtIHVybDogaHR0cDovL2FwaS5leGFtcGxlLmNvbS92MQo=
@@ -118,7 +118,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   specContentBase64?: string;
   /**
    * @remarks
-   * The download URL of the API definition file. The URL must be accessible over the public network or be an internal network OSS download URL in the same region. The URL must have download permissions. For OSS files that are not publicly readable, see References [Download objects using presigned URLs](https://help.aliyun.com/document_detail/39607.html) and provide a URL with download permissions. Only API definition files stored in OSS are supported.
+   * The download URL of the API definition file. The URL must be accessible over the Internet or be an internal network OSS download URL in the same region. The URL must have download permissions. For OSS files that are not publicly readable, see References [Download objects using pre-signed URLs](https://help.aliyun.com/document_detail/39607.html) and provide a URL with download permissions. Only API definition files stored in OSS are supported.
    */
   specFileUrl?: string;
   /**
@@ -128,8 +128,8 @@ export class ImportHttpApiRequest extends $dara.Model {
   specOssConfig?: ImportHttpApiRequestSpecOssConfig;
   /**
    * @remarks
-   * The update strategy to use when the imported API has the same name and version management configuration as an existing API. Valid values:
-   * - SpecOnly: uses the imported file as the single source of truth.
+   * The update strategy to use when the imported API name and version management match an existing API. Valid values:
+   * - SpecOnly: uses the imported file as the sole source of truth.
    * - SpecFirst: prioritizes the imported file. New operations are added and existing operations are updated. Operations not mentioned in the file remain unchanged.
    * - ExistFirst: prioritizes the existing API. Only new operations are added. Existing operations are not updated.
    * 
@@ -141,7 +141,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   strategy?: string;
   /**
    * @remarks
-   * The ID of the target HTTP API. If this parameter is specified, this import updates the specified API instead of creating a new one or searching for an existing API by name and version management configuration. The target API must be of the REST type.
+   * If this parameter is specified, the import updates the specified API instead of importing a new one or searching for an existing API by name and version management configuration. The target API must be of the REST type.
    * 
    * @example
    * api-xxxx
@@ -149,7 +149,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   targetHttpApiId?: string;
   /**
    * @remarks
-   * The API version configuration. If version configuration is enabled and an API with the same version number and name already exists, this import is treated as an update. If version configuration is not enabled and an API with the same name already exists, this import is treated as an update.
+   * The API version configuration. If version configuration is enabled and the version number and API name match an existing API, the import is treated as an update. If version configuration is not enabled and the API name matches an existing API, the import is treated as an update.
    */
   versionConfig?: HttpApiVersionConfig;
   withGatewayExtension?: boolean;

package/src/models/ImportHttpApiResponseBody.ts

@@ -123,8 +123,8 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents extends $d
   /**
    * @remarks
    * The action to be performed after the dry run. Valid values:
-   * - Create: Create.
-   * - Update: Update.
+   * - Create: create.
+   * - Update: update.
    * 
    * @example
    * Create
@@ -165,8 +165,8 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $d
   /**
    * @remarks
    * The action to be performed after the dry run. Valid values:
-   * - Create: Create.
-   * - Update: Update.
+   * - Create: create.
+   * - Update: update.
    * 
    * @example
    * Create
@@ -252,7 +252,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessRoutes extends $dara.
 export class ImportHttpApiResponseBodyDataDryRunInfo extends $dara.Model {
   /**
    * @remarks
-   * The error messages. If error messages are not empty, the API cannot be imported.
+   * The error messages. If error messages are not empty, the API cannot be imported successfully.
    */
   errorMessages?: string[];
   /**
@@ -285,7 +285,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfo extends $dara.Model {
   successRoutes?: ImportHttpApiResponseBodyDataDryRunInfoSuccessRoutes[];
   /**
    * @remarks
-   * The warning messages. If warning messages are not empty, some operations or data structures may not be imported.
+   * The warning messages. If warning messages are not empty, some operations or data structures may not be imported successfully.
    */
   warningMessages?: string[];
   static names(): { [key: string]: string } {

package/src/models/InstallPluginResponseBody.ts

@@ -45,7 +45,7 @@ export class InstallPluginResponseBodyDataInstallPluginResults extends $dara.Mod
 export class InstallPluginResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The installation result.
+   * The installation results.
    */
   installPluginResults?: InstallPluginResponseBodyDataInstallPluginResults[];
   static names(): { [key: string]: string } {
@@ -75,7 +75,7 @@ export class InstallPluginResponseBodyData extends $dara.Model {
 export class InstallPluginResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -83,12 +83,12 @@ export class InstallPluginResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response payload.
+   * The response data.
    */
   data?: InstallPluginResponseBodyData;
   /**
    * @remarks
-   * The status message.
+   * The response message.
    * 
    * @example
    * Success
@@ -96,7 +96,7 @@ export class InstallPluginResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 201CFCA0-3AF5-52D0-A0F3-FBA697AF55CB

package/src/models/JwtIdentityConfig.ts

@@ -5,17 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class JwtIdentityConfigClaimsToHeadersConfigs extends $dara.Model {
   /**
    * @remarks
-   * The claim.
+   * The claim name in the JWT payload.
+   * 
+   * @example
+   * sub
    */
   claim?: string;
   /**
    * @remarks
-   * The header.
+   * The HTTP header name after conversion.
+   * 
+   * @example
+   * X-Consumer-Id
    */
   header?: string;
   /**
    * @remarks
-   * The override.
+   * Specifies whether to overwrite an existing header with the same name.
+   * 
+   * @example
+   * true
    */
   override?: boolean;
   static names(): { [key: string]: string } {
@@ -86,7 +95,7 @@ export class JwtIdentityConfigJwtPayloadConfig extends $dara.Model {
 export class JwtIdentityConfigJwtTokenConfig extends $dara.Model {
   /**
    * @remarks
-   * The JWT key configuration.
+   * The key configuration of the JWT.
    * 
    * @example
    * Authorization
@@ -94,7 +103,7 @@ export class JwtIdentityConfigJwtTokenConfig extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Specifies whether to pass through.
+   * Indicates whether the request is passed through.
    * 
    * @example
    * true
@@ -102,7 +111,7 @@ export class JwtIdentityConfigJwtTokenConfig extends $dara.Model {
   pass?: boolean;
   /**
    * @remarks
-   * The storage location of the JWT.
+   * The location where the JWT is stored.
    * 
    * @example
    * HEADER
@@ -146,7 +155,7 @@ export class JwtIdentityConfigJwtTokenConfig extends $dara.Model {
 export class JwtIdentityConfig extends $dara.Model {
   /**
    * @remarks
-   * The claims-to-headers configurations.
+   * The list of claim-to-header configurations.
    */
   claimsToHeadersConfigs?: JwtIdentityConfigClaimsToHeadersConfigs[];
   /**
@@ -169,7 +178,10 @@ export class JwtIdentityConfig extends $dara.Model {
   jwtTokenConfig?: JwtIdentityConfigJwtTokenConfig;
   /**
    * @remarks
-   * The remote JWKS.
+   * The remote JWKS configuration (JSON string).
+   * 
+   * @example
+   * {"uri":"https://example.com/.well-known/jwks.json"}
    */
   remoteJwks?: string;
   /**
@@ -182,7 +194,7 @@ export class JwtIdentityConfig extends $dara.Model {
   secretType?: string;
   /**
    * @remarks
-   * The type of authentication configuration.
+   * The authentication configuration type.
    * 
    * @example
    * Jwt