@alicloud/apig20240327 9.2.0 → 10.0.0

package/src/models/HiMarketPortalDeployConfig.ts

@@ -5,42 +5,66 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketPortalDeployConfigSaeConfig extends $dara.Model {
   /**
    * @remarks
-   * The ID of the application in Serverless App Engine.
+   * The SAE application ID.
+   * 
+   * @example
+   * app-xxx
    */
   appId?: string;
   /**
    * @remarks
-   * The ID of the namespace that logically isolates the application.
+   * The SAE namespace ID.
+   * 
+   * @example
+   * cn-hangzhou:default
    */
   namespaceId?: string;
   /**
    * @remarks
-   * The name of the OIDC role that grants permissions to the application.
+   * The OIDC role name used for SAE to access other cloud resources.
+   * 
+   * @example
+   * apig-portal-oidc-role
    */
   oidcRoleName?: string;
   /**
    * @remarks
-   * The ID of the region in which to deploy the application.
+   * The region ID of SAE.
+   * 
+   * @example
+   * cn-hangzhou
    */
   regionId?: string;
   /**
    * @remarks
-   * The desired number of application replicas.
+   * The number of instance replicas.
+   * 
+   * @example
+   * 2
    */
   replicas?: string;
   /**
    * @remarks
-   * The ID of the security group to apply to the application instances. A security group acts as a virtual firewall.
+   * The security group ID.
+   * 
+   * @example
+   * sg-xxx
    */
   securityGroupId?: string;
   /**
    * @remarks
-   * The ID of the vSwitch within the specified VPC. Serverless App Engine launches application instances in the vSwitch\\"s zone.
+   * The vSwitch ID.
+   * 
+   * @example
+   * vsw-xxx
    */
   vSwitchId?: string;
   /**
    * @remarks
-   * The ID of the VPC to connect the application to.
+   * VPC ID
+   * 
+   * @example
+   * vpc-xxx
    */
   vpcId?: string;
   static names(): { [key: string]: string } {
@@ -81,22 +105,31 @@ export class HiMarketPortalDeployConfigSaeConfig extends $dara.Model {
 export class HiMarketPortalDeployConfig extends $dara.Model {
   /**
    * @remarks
-   * Additional information about the deployment status, such as error details.
+   * The deployment status message.
+   * 
+   * @example
+   * message
    */
   message?: string;
   /**
    * @remarks
-   * The target deployment platform. For example, set this to `SAE` to deploy on Serverless App Engine.
+   * The deployment platform type.
+   * 
+   * @example
+   * SAE
    */
   platform?: string;
   /**
    * @remarks
-   * Configuration settings for deploying to Serverless App Engine (SAE). This object is required when the `platform` is `SAE`.
+   * The SAE (Serverless App Engine) deployment configuration.
    */
   saeConfig?: HiMarketPortalDeployConfigSaeConfig;
   /**
    * @remarks
-   * The current status of the deployment. Possible values include `succeeded`, `failed`, and `in_progress`.
+   * The deployment status.
+   * 
+   * @example
+   * Running
    */
   status?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketPortalDomainConfig.ts

@@ -5,17 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketPortalDomainConfig extends $dara.Model {
   /**
    * @remarks
-   * The domain name.
+   * The domain name address.
+   * 
+   * @example
+   * portal.example.com
    */
   domain?: string;
   /**
    * @remarks
-   * The domain protocol.
+   * The request protocol.
+   * 
+   * @example
+   * HTTPS
    */
   protocol?: string;
   /**
    * @remarks
-   * The domain type.
+   * The domain name type.
+   * 
+   * @example
+   * custom
    */
   type?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketPortalSettingConfig.ts

@@ -5,26 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketPortalSettingConfig extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to automatically approve new developer registrations. If set to `false`, you must manually approve each new developer.\\
-   * \\
-   * **Default**: `false`.\\
-   * \\
+   * Specifies whether to automatically approve developer registration requests.
+   * 
+   * @example
+   * false
    */
   autoApproveDevelopers?: boolean;
   /**
    * @remarks
-   * Specifies whether to automatically approve new API subscriptions. If set to `false`, you must manually approve each new subscription.\\
-   * \\
-   * **Default**: `false`.\\
-   * \\
+   * Specifies whether to automatically approve API subscription requests.
+   * 
+   * @example
+   * false
    */
   autoApproveSubscriptions?: boolean;
   /**
    * @remarks
-   * Specifies whether to enable built-in authentication. If set to `true`, users must sign in to access the portal.\\
-   * \\
-   * **Default**: `false`.\\
-   * \\
+   * Specifies whether to enable username-password authentication (built-in authentication).
+   * 
+   * @example
+   * true
    */
   builtinAuthEnabled?: boolean;
   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/HiMarketProductFeature.ts

@@ -6,7 +6,7 @@ import { HiMarketModelFeature } from "./HiMarketModelFeature";
 export class HiMarketProductFeature extends $dara.Model {
   /**
    * @remarks
-   * Specifies the product\\"s model feature. For more information, see HiMarketModelFeature.
+   * The model feature.
    */
   modelFeature?: HiMarketModelFeature;
   static names(): { [key: string]: string } {

package/src/models/HiMarketProductPublicationConifg.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketProductPublicationConifg extends $dara.Model {
   /**
    * @remarks
-   * The unique identifier for the publication.
+   * The publication ID.
+   * 
+   * @example
+   * pub-xxx
    */
   publicationId?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketProductPublicationDetail.ts

@@ -5,32 +5,50 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketProductPublicationDetail extends $dara.Model {
   /**
    * @remarks
-   * The unique ID of the portal.
+   * The portal ID.
+   * 
+   * @example
+   * portal-xxx
    */
   portalId?: string;
   /**
    * @remarks
-   * The name of the portal.
+   * The portal name.
+   * 
+   * @example
+   * 开发者门户
    */
   portalName?: string;
   /**
    * @remarks
-   * The unique ID of the product.
+   * The product ID.
+   * 
+   * @example
+   * prod-xxx
    */
   productId?: string;
   /**
    * @remarks
-   * The name of the product.
+   * The product name.
+   * 
+   * @example
+   * AI网关API
    */
   productName?: string;
   /**
    * @remarks
-   * The type of the product.
+   * The product type.
+   * 
+   * @example
+   * ApiGateway
    */
   productType?: string;
   /**
    * @remarks
-   * The unique ID of the product publication.
+   * The product publish ID.
+   * 
+   * @example
+   * pub-xxx
    */
   publicationId?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketProductRefConfig.ts

@@ -5,37 +5,58 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketProductRefConfigApigRefConfig extends $dara.Model {
   /**
    * @remarks
-   * Unique identifier for the agent API.
+   * The associated Agent API ID.
+   * 
+   * @example
+   * api-xxx
    */
   agentApiId?: string;
   /**
    * @remarks
-   * The name of the agent API.
+   * The Agent API name.
+   * 
+   * @example
+   * my-agent-api
    */
   agentApiName?: string;
   /**
    * @remarks
-   * Unique identifier for the MCP route.
+   * The associated MCP route ID.
+   * 
+   * @example
+   * route-xxx
    */
   mcpRouteId?: string;
   /**
    * @remarks
-   * Unique identifier for the MCP server.
+   * The associated MCP Server ID.
+   * 
+   * @example
+   * mcp-xxx
    */
   mcpServerId?: string;
   /**
    * @remarks
-   * The name of the MCP server.
+   * The MCP Server name.
+   * 
+   * @example
+   * my-mcp-server
    */
   mcpServerName?: string;
   /**
    * @remarks
-   * Unique identifier for the model API.
+   * The associated Model API ID.
+   * 
+   * @example
+   * api-yyy
    */
   modelApiId?: string;
   /**
    * @remarks
-   * The name of the model API.
+   * The Model API name.
+   * 
+   * @example
+   * qwen-model-api
    */
   modelApiName?: string;
   static names(): { [key: string]: string } {
@@ -74,12 +95,15 @@ export class HiMarketProductRefConfigApigRefConfig extends $dara.Model {
 export class HiMarketProductRefConfig extends $dara.Model {
   /**
    * @remarks
-   * Reference settings for the API gateway.
+   * The APIG resource reference configuration.
    */
   apigRefConfig?: HiMarketProductRefConfigApigRefConfig;
   /**
    * @remarks
-   * Unique identifier for the gateway.
+   * The ID of the associated gateway.
+   * 
+   * @example
+   * gw-xxx
    */
   gatewayId?: string;
   static names(): { [key: string]: string } {

package/src/models/HttpApiDeployConfig.ts

@@ -213,7 +213,7 @@ export class HttpApiDeployConfigServiceConfigs extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The observability metric routing configuration.
+   * The observability-based routing configuration.
    * 
    * **if can be null:**
    * true
@@ -373,7 +373,7 @@ export class HttpApiDeployConfigSubDomains extends $dara.Model {
 export class HttpApiDeployConfig extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to automatically deploy.
+   * Indicates whether auto-deploy is enabled.
    * 
    * @example
    * true
@@ -399,17 +399,17 @@ export class HttpApiDeployConfig extends $dara.Model {
   customDomainIds?: string[];
   /**
    * @remarks
-   * The list of custom domain name details.
+   * The list of custom domain name information.
    */
   customDomainInfos?: HttpApiDeployConfigCustomDomainInfos[];
   /**
    * @remarks
-   * The list of environment domain name IDs. If this parameter is not specified, all environment domain names are associated. An empty array indicates that no environment domain names are associated.
+   * The list of environment domain name IDs. If this parameter is not specified, all environment domain names are bound. An empty array indicates that no environment domain names are bound.
    */
   envDomainIds?: string[];
   /**
    * @remarks
-   * The list of environment domain name details.
+   * The list of environment domain name information.
    */
   envDomainInfos?: HttpApiDeployConfigEnvDomainInfos[];
   /**
@@ -472,7 +472,7 @@ export class HttpApiDeployConfig extends $dara.Model {
   serviceConfigs?: HttpApiDeployConfigServiceConfigs[];
   /**
    * @remarks
-   * The list of subdomain details.
+   * The list of subdomain information.
    */
   subDomains?: HttpApiDeployConfigSubDomains[];
   static names(): { [key: string]: string } {

package/src/models/HttpApiVersionConfig.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class HttpApiVersionConfig extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable versioning.
+   * Indicates whether versioning control is enabled.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class HttpApiVersionConfig extends $dara.Model {
   enable?: boolean;
   /**
    * @remarks
-   * The key in the specified header when the header versioning solution is used.
+   * The key in the specified header parameter when the header-based versioning scheme is used.
    * 
    * @example
    * my-version
@@ -21,7 +21,7 @@ export class HttpApiVersionConfig extends $dara.Model {
   headerName?: string;
   /**
    * @remarks
-   * The key in the specified query parameter when the query versioning solution is used.
+   * The key in the specified query parameter when the query parameter-based versioning scheme is used.
    * 
    * @example
    * myVersion
@@ -29,13 +29,7 @@ export class HttpApiVersionConfig extends $dara.Model {
   queryName?: string;
   /**
    * @remarks
-   * The versioning solution.
-   * 
-   * Valid values:
-   * 
-   * *   Path
-   * *   Query
-   * *   Header
+   * The versioning scheme.
    * 
    * @example
    * Query

package/src/models/ImportHttpApiRequest.ts

@@ -62,7 +62,7 @@ export class ImportHttpApiRequest extends $dara.Model {
   deployConfigs?: HttpApiDeployConfig[];
   /**
    * @remarks
-   * The description of the imported API. If this parameter is not specified, the description is extracted from the API definition. Maximum length: 255 bytes.
+   * The description of the imported API. If not specified, the description is extracted from the API definition. Maximum length: 255 bytes.
    * 
    * @example
    * 测试专用API
@@ -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 enable dry run mode. If enabled, only validation is performed without performing the actual import.
    * 
    * @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 not specified, the name is extracted from the API definition file. If the API name and version configuration already exist, this import updates the existing API definition based on the strategy field.
    * 
    * @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 that supports OAS 2.0 and OAS 3.0 specifications 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.
    * 
    * @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 from 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. Currently, only API definition files stored on OSS are supported.
    */
   specFileUrl?: string;
   /**
@@ -128,10 +128,11 @@ 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.
-   * - 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.
+   * The update strategy to use when the imported API name and version management match an existing API. Valid values:
+   * 
+   * - SpecFirst: the imported file takes priority. New operations are added and existing operations are updated. Operations not mentioned in the file remain unchanged.
+   * - SpecOnly: the imported file is used as the sole source of truth.
+   * - ExistFirst: the existing API takes priority. Only new operations are added. Existing operations are not updated.
    * 
    * Default value: ExistFirst.
    * 
@@ -141,7 +142,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 field is specified, this import updates the specified API instead of importing a new one or searching for an existing API based on the API name and version management configuration. The target API must be of the REST type.
    * 
    * @example
    * api-xxxx
@@ -149,9 +150,16 @@ 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, this import is treated as an update. If version configuration is not enabled and the API name matches an existing API, this import is treated as an update.
    */
   versionConfig?: HttpApiVersionConfig;
+  /**
+   * @remarks
+   * Specifies whether to import gateway extension information.
+   * 
+   * @example
+   * false
+   */
   withGatewayExtension?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/ImportHttpApiResponseBody.ts

@@ -94,7 +94,21 @@ export class ImportHttpApiResponseBodyDataDryRunInfoFailureOperations extends $d
 }
 
 export class ImportHttpApiResponseBodyDataDryRunInfoFailureRoutes extends $dara.Model {
+  /**
+   * @remarks
+   * The error message.
+   * 
+   * @example
+   * conflict
+   */
   errorMessage?: string;
+  /**
+   * @remarks
+   * The parameter name.
+   * 
+   * @example
+   * admin-route
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {
@@ -123,6 +137,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessComponents extends $d
   /**
    * @remarks
    * The action to be performed after the dry run. Valid values:
+   * 
    * - Create: Create.
    * - Update: Update.
    * 
@@ -165,6 +180,7 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $d
   /**
    * @remarks
    * The action to be performed after the dry run. Valid values:
+   * 
    * - Create: Create.
    * - Update: Update.
    * 
@@ -224,7 +240,21 @@ export class ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations extends $d
 }
 
 export class ImportHttpApiResponseBodyDataDryRunInfoSuccessRoutes extends $dara.Model {
+  /**
+   * @remarks
+   * The action type.
+   * 
+   * @example
+   * Create
+   */
   action?: string;
+  /**
+   * @remarks
+   * The name.
+   * 
+   * @example
+   * user-route
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {
@@ -252,12 +282,12 @@ 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 successfully imported.
    */
   errorMessages?: string[];
   /**
    * @remarks
-   * The information about the existing API. If this field is not empty, the import updates this API.
+   * The information about the existing API. If this field is not empty, the import action updates this API.
    */
   existHttpApiInfo?: HttpApiApiInfo;
   /**
@@ -270,7 +300,18 @@ export class ImportHttpApiResponseBodyDataDryRunInfo extends $dara.Model {
    * The list of operations that failed the dry run.
    */
   failureOperations?: ImportHttpApiResponseBodyDataDryRunInfoFailureOperations[];
+  /**
+   * @remarks
+   * The list of routes that failed.
+   */
   failureRoutes?: ImportHttpApiResponseBodyDataDryRunInfoFailureRoutes[];
+  /**
+   * @remarks
+   * The MCP tool definition information.
+   * 
+   * @example
+   * ...
+   */
   mcpToolsDefinition?: string;
   /**
    * @remarks
@@ -282,10 +323,14 @@ export class ImportHttpApiResponseBodyDataDryRunInfo extends $dara.Model {
    * The list of operations that passed the dry run.
    */
   successOperations?: ImportHttpApiResponseBodyDataDryRunInfoSuccessOperations[];
+  /**
+   * @remarks
+   * The list of routes that were successfully imported.
+   */
   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 } {