@alicloud/apig20240327 7.0.5 → 7.2.0

package/src/models/HiMarketIdentityMapping.ts

@@ -3,8 +3,20 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class HiMarketIdentityMapping extends $dara.Model {
+  /**
+   * @remarks
+   * The identity provider attribute that maps to the user\\"s email address.
+   */
   emailField?: string;
+  /**
+   * @remarks
+   * The identity provider attribute that maps to the user\\"s unique ID.
+   */
   userIdField?: string;
+  /**
+   * @remarks
+   * The identity provider attribute that maps to the username.
+   */
   userNameField?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketMcpConfig.ts

@@ -4,7 +4,15 @@ import { HiMarketDomain } from "./HiMarketDomain";
 
 
 export class HiMarketMcpConfigMcpServerConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The domains managed by the server.
+   */
   domains?: HiMarketDomain[];
+  /**
+   * @remarks
+   * The base path for the service endpoint.
+   */
   path?: string;
   static names(): { [key: string]: string } {
     return {
@@ -33,6 +41,10 @@ export class HiMarketMcpConfigMcpServerConfig extends $dara.Model {
 }
 
 export class HiMarketMcpConfigMeta extends $dara.Model {
+  /**
+   * @remarks
+   * The communication protocol. Can be `http` or `https`.
+   */
   protocol?: string;
   static names(): { [key: string]: string } {
     return {
@@ -56,9 +68,25 @@ export class HiMarketMcpConfigMeta extends $dara.Model {
 }
 
 export class HiMarketMcpConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Configuration for the MCP server.
+   */
   mcpServerConfig?: HiMarketMcpConfigMcpServerConfig;
+  /**
+   * @remarks
+   * A unique name for the MCP server.
+   */
   mcpServerName?: string;
+  /**
+   * @remarks
+   * Metadata for the configuration.
+   */
   meta?: HiMarketMcpConfigMeta;
+  /**
+   * @remarks
+   * The tools associated with this configuration, typically provided as a JSON-formatted string.
+   */
   tools?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketModelConfig.ts

@@ -4,8 +4,20 @@ import { HiMarketHttpRoute } from "./HiMarketHttpRoute";
 
 
 export class HiMarketModelConfigModelAPIConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The AI protocols supported by the model.
+   */
   aiProtocols?: string[];
+  /**
+   * @remarks
+   * The model category.
+   */
   modelCategory?: string;
+  /**
+   * @remarks
+   * Route configurations for the model API.
+   */
   routes?: HiMarketHttpRoute[];
   static names(): { [key: string]: string } {
     return {
@@ -39,6 +51,10 @@ export class HiMarketModelConfigModelAPIConfig extends $dara.Model {
 }
 
 export class HiMarketModelConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Configuration for the model API.
+   */
   modelAPIConfig?: HiMarketModelConfigModelAPIConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketModelFeature.ts

@@ -3,12 +3,40 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class HiMarketModelFeature extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether to enable multi-modal capabilities. If set to `true`, the model can process requests that include multiple data types, such as text and images.
+   */
   enableMultiModal?: boolean;
+  /**
+   * @remarks
+   * Indicates whether to include the model\\"s reasoning process in the response. If set to `true`, the output may contain intermediate steps that show how the model arrived at a conclusion.
+   */
   enableThinking?: boolean;
+  /**
+   * @remarks
+   * The maximum number of tokens to generate in the response. A token is a unit of text processed by the model.
+   */
   maxTokens?: number;
+  /**
+   * @remarks
+   * The identifier of the model to use for inference.
+   */
   model?: string;
+  /**
+   * @remarks
+   * Indicates whether to deliver the response as a continuous stream. If set to `true`, results are sent incrementally.
+   */
   streaming?: boolean;
+  /**
+   * @remarks
+   * Controls the randomness of the output. Valid values range from 0 to 1. Higher values, such as 0.8, make the output more random. Lower values, such as 0.2, make the output more deterministic.
+   */
   temperature?: number;
+  /**
+   * @remarks
+   * Indicates whether the model can search the web to provide more up-to-date responses.
+   */
   webSearch?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketOidcConfig.ts

@@ -3,14 +3,50 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class HiMarketOidcConfigAuthCodeConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The URL of the identity provider\\"s authorization endpoint.
+   */
   authorizationEndpoint?: string;
+  /**
+   * @remarks
+   * The client ID obtained from the identity provider after registering your application.
+   */
   clientId?: string;
+  /**
+   * @remarks
+   * The client secret obtained from the identity provider after registering your application.
+   */
   clientSecret?: string;
+  /**
+   * @remarks
+   * The identity provider\\"s unique issuer URL, used to validate ID tokens.
+   */
   issuer?: string;
+  /**
+   * @remarks
+   * The provider\\"s JWK Set URI. This URI provides the public keys needed to verify ID token signatures.
+   */
   jwkSetUri?: string;
+  /**
+   * @remarks
+   * The application\\"s redirect URI. The provider sends the authorization code to this URI after successful authentication. You must register this URI with the identity provider.
+   */
   redirectUri?: string;
+  /**
+   * @remarks
+   * A space-separated list of scopes to request from the provider. The `openid` scope is required for OIDC authentication. For example: `openid profile email`.
+   */
   scopes?: string;
+  /**
+   * @remarks
+   * The URL of the identity provider\\"s token endpoint.
+   */
   tokenEndpoint?: string;
+  /**
+   * @remarks
+   * The URL of the identity provider\\"s user info endpoint.
+   */
   userInfoEndpoint?: string;
   static names(): { [key: string]: string } {
     return {
@@ -50,9 +86,25 @@ export class HiMarketOidcConfigAuthCodeConfig extends $dara.Model {
 }
 
 export class HiMarketOidcConfigIdentityMapping extends $dara.Model {
+  /**
+   * @remarks
+   * Maps additional claims from the ID token to custom user attributes. For each mapping, the key is the target attribute in your system, and the value is the name of the claim from the ID token.
+   */
   customFields?: { [key: string]: string };
+  /**
+   * @remarks
+   * The ID token claim that maps to the user\\"s email address. The `email` claim is a common choice.
+   */
   emailField?: string;
+  /**
+   * @remarks
+   * The ID token claim that maps to the user\\"s unique ID. The `sub` claim is a common choice.
+   */
   userIdField?: string;
+  /**
+   * @remarks
+   * The ID token claim that maps to the user\\"s display name. Common choices include `name` and `preferred_username`.
+   */
   userNameField?: string;
   static names(): { [key: string]: string } {
     return {
@@ -85,12 +137,40 @@ export class HiMarketOidcConfigIdentityMapping extends $dara.Model {
 }
 
 export class HiMarketOidcConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Configuration settings for the authorization code grant type.
+   */
   authCodeConfig?: HiMarketOidcConfigAuthCodeConfig;
+  /**
+   * @remarks
+   * Enables or disables this identity provider. If set to `false`, users cannot sign in with this provider.
+   */
   enabled?: boolean;
+  /**
+   * @remarks
+   * The OAuth 2.0 grant type. For OIDC, this must be `authorization_code`.
+   */
   grantType?: string;
+  /**
+   * @remarks
+   * Specifies how to map claims from an ID token to user attributes in your system.
+   */
   identityMapping?: HiMarketOidcConfigIdentityMapping;
+  /**
+   * @remarks
+   * The URL for the provider\\"s logo. This logo appears on the sign-in page.
+   */
   logoUrl?: string;
+  /**
+   * @remarks
+   * The provider\\"s display name. This name appears on the sign-in page.
+   */
   name?: string;
+  /**
+   * @remarks
+   * The unique identifier for the identity provider.
+   */
   provider?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketPortalDeployConfig.ts

@@ -3,13 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class HiMarketPortalDeployConfigSaeConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the application in Serverless App Engine.
+   */
   appId?: string;
+  /**
+   * @remarks
+   * The ID of the namespace that logically isolates the application.
+   */
   namespaceId?: string;
+  /**
+   * @remarks
+   * The name of the OIDC role that grants permissions to the application.
+   */
   oidcRoleName?: string;
+  /**
+   * @remarks
+   * The ID of the region in which to deploy the application.
+   */
   regionId?: string;
+  /**
+   * @remarks
+   * The desired number of application replicas.
+   */
   replicas?: string;
+  /**
+   * @remarks
+   * The ID of the security group to apply to the application instances. A security group acts as a virtual firewall.
+   */
   securityGroupId?: string;
+  /**
+   * @remarks
+   * The ID of the vSwitch within the specified VPC. Serverless App Engine launches application instances in the vSwitch\\"s zone.
+   */
   vSwitchId?: string;
+  /**
+   * @remarks
+   * The ID of the VPC to connect the application to.
+   */
   vpcId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -47,9 +79,25 @@ export class HiMarketPortalDeployConfigSaeConfig extends $dara.Model {
 }
 
 export class HiMarketPortalDeployConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Additional information about the deployment status, such as error details.
+   */
   message?: string;
+  /**
+   * @remarks
+   * The target deployment platform. For example, set this to `SAE` to deploy on Serverless App Engine.
+   */
   platform?: string;
+  /**
+   * @remarks
+   * Configuration settings for deploying to Serverless App Engine (SAE). This object is required when the `platform` is `SAE`.
+   */
   saeConfig?: HiMarketPortalDeployConfigSaeConfig;
+  /**
+   * @remarks
+   * The current status of the deployment. Possible values include `succeeded`, `failed`, and `in_progress`.
+   */
   status?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketPortalDomainConfig.ts

@@ -3,8 +3,20 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class HiMarketPortalDomainConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The domain name.
+   */
   domain?: string;
+  /**
+   * @remarks
+   * The domain protocol.
+   */
   protocol?: string;
+  /**
+   * @remarks
+   * The domain type.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketPortalSettingConfig.ts

@@ -3,8 +3,29 @@ 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`.\\
+   * \\
+   */
   autoApproveDevelopers?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to automatically approve new API subscriptions. If set to `false`, you must manually approve each new subscription.\\
+   * \\
+   * **Default**: `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`.\\
+   * \\
+   */
   builtinAuthEnabled?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketProductCategory.ts

@@ -4,9 +4,25 @@ import { HiMarketIcon } from "./HiMarketIcon";
 
 
 export class HiMarketProductCategory extends $dara.Model {
+  /**
+   * @remarks
+   * The unique category ID.
+   */
   categoryId?: string;
+  /**
+   * @remarks
+   * The category description.
+   */
   description?: string;
+  /**
+   * @remarks
+   * The category icon.
+   */
   icon?: HiMarketIcon;
+  /**
+   * @remarks
+   * The category name.
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketProductFeature.ts

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

package/src/models/HiMarketProductPublicationConifg.ts

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

package/src/models/HiMarketProductPublicationDetail.ts

@@ -3,11 +3,35 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class HiMarketProductPublicationDetail extends $dara.Model {
+  /**
+   * @remarks
+   * The unique ID of the portal.
+   */
   portalId?: string;
+  /**
+   * @remarks
+   * The name of the portal.
+   */
   portalName?: string;
+  /**
+   * @remarks
+   * The unique ID of the product.
+   */
   productId?: string;
+  /**
+   * @remarks
+   * The name of the product.
+   */
   productName?: string;
+  /**
+   * @remarks
+   * The type of the product.
+   */
   productType?: string;
+  /**
+   * @remarks
+   * The unique ID of the product publication.
+   */
   publicationId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/HiMarketProductRefConfig.ts

@@ -3,12 +3,40 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class HiMarketProductRefConfigApigRefConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Unique identifier for the agent API.
+   */
   agentApiId?: string;
+  /**
+   * @remarks
+   * The name of the agent API.
+   */
   agentApiName?: string;
+  /**
+   * @remarks
+   * Unique identifier for the MCP route.
+   */
   mcpRouteId?: string;
+  /**
+   * @remarks
+   * Unique identifier for the MCP server.
+   */
   mcpServerId?: string;
+  /**
+   * @remarks
+   * The name of the MCP server.
+   */
   mcpServerName?: string;
+  /**
+   * @remarks
+   * Unique identifier for the model API.
+   */
   modelApiId?: string;
+  /**
+   * @remarks
+   * The name of the model API.
+   */
   modelApiName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -44,7 +72,15 @@ export class HiMarketProductRefConfigApigRefConfig extends $dara.Model {
 }
 
 export class HiMarketProductRefConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Reference settings for the API gateway.
+   */
   apigRefConfig?: HiMarketProductRefConfigApigRefConfig;
+  /**
+   * @remarks
+   * Unique identifier for the gateway.
+   */
   gatewayId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/HttpApiApiInfo.ts

@@ -522,12 +522,15 @@ export class HttpApiApiInfo extends $dara.Model {
    * The API description.
    * 
    * @example
-   * for test only
+   * 测试专用API
    */
   description?: string;
   /**
    * @remarks
    * Specifies whether to enable authentication.
+   * 
+   * @example
+   * true
    */
   enabelAuth?: boolean;
   /**