@alicloud/apig20240327 9.2.0 → 10.0.0

package/src/models/CreateEnvironmentRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateEnvironmentRequest extends $dara.Model {
   /**
    * @remarks
-   * The request body.
+   * The environment alias.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateEnvironmentRequest extends $dara.Model {
   alias?: string;
   /**
    * @remarks
-   * The environment alias.
+   * The description of the environment. You can specify information such as the purpose and owner of the environment.
    * 
    * @example
    * 这是xxx的xx项目测试环境
@@ -23,7 +23,7 @@ export class CreateEnvironmentRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The environment description, such as its purpose and owner.
+   * The gateway ID.
    * 
    * This parameter is required.
    * 
@@ -33,7 +33,7 @@ export class CreateEnvironmentRequest extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * Create environment.
+   * The environment name.
    * 
    * This parameter is required.
    * 
@@ -43,7 +43,7 @@ export class CreateEnvironmentRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Testing environment for xx project of xxx
+   * The resource group ID.
    * 
    * @example
    * rg-ahr5uil8raz0rq3b

package/src/models/CreateEnvironmentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateEnvironmentResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The request ID, which is used to trace the call link.
+   * The environment ID.
    * 
    * @example
    * env-cq7l5s5lhtgi6qasrdc0
@@ -35,7 +35,7 @@ export class CreateEnvironmentResponseBodyData extends $dara.Model {
 export class CreateEnvironmentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The resource group ID.
+   * The response code.
    * 
    * @example
    * Ok
@@ -43,12 +43,12 @@ export class CreateEnvironmentResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Schema of Response
+   * The response data.
    */
   data?: CreateEnvironmentResponseBodyData;
   /**
    * @remarks
-   * rg-acfmycs5expl7oq
+   * The response message.
    * 
    * @example
    * success
@@ -56,7 +56,7 @@ export class CreateEnvironmentResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The instance ID.
+   * The request ID, which is used to trace the API call chain.
    * 
    * @example
    * 3C3B9A12-3868-5EB9-8BEA-F99E03DD125C

package/src/models/CreateGatewayRequest.ts

@@ -65,7 +65,10 @@ export class CreateGatewayRequestLogConfig extends $dara.Model {
 export class CreateGatewayRequestNetworkAccessConfig extends $dara.Model {
   /**
    * @remarks
-   * The network access type.
+   * The network access type. Valid values:
+   * - InternetAndIntranet: public and internal network.
+   * - Intranet: internal network.
+   * - Internet: public network.
    * 
    * @example
    * Internet
@@ -175,7 +178,9 @@ export class CreateGatewayRequestZoneConfigZones extends $dara.Model {
 export class CreateGatewayRequestZoneConfig extends $dara.Model {
   /**
    * @remarks
-   * The zone selection option.
+   * The zone selection option. Valid values:
+   * - Auto: automatic.
+   * - Manual: manual.
    * 
    * @example
    * Manual
@@ -225,7 +230,9 @@ export class CreateGatewayRequestZoneConfig extends $dara.Model {
 export class CreateGatewayRequest extends $dara.Model {
   /**
    * @remarks
-   * The billing method.
+   * The billing method. Valid values:
+   * - POSTPAY: subscription.
+   * - PREPAY: pay-as-you-go.
    * 
    * @example
    * POSTPAY
@@ -235,13 +242,13 @@ export class CreateGatewayRequest extends $dara.Model {
    * @remarks
    * The gateway instance edition. Valid values:
    * 
-   * - Professional: Standard instance.
+   * - Professional: standard instance.
    * 
    * - Serverless: Serverless instance.
    * 
-   * - MultiTenantServerless: Multi-tenant Serverless instance.
+   * - MultiTenantServerless: multi-tenant Serverless instance.
    * 
-   * - Unknown: Unknown.
+   * - Unknown: unknown.
    * 
    * @example
    * Professional
@@ -249,7 +256,9 @@ export class CreateGatewayRequest extends $dara.Model {
   gatewayEdition?: string;
   /**
    * @remarks
-   * The gateway type.
+   * The gateway type. Valid values:
+   * - AI: AI gateway.
+   * - API: cloud-native API gateway.
    * 
    * @example
    * API

package/src/models/CreateHttpApiOperationRequest.ts

@@ -6,7 +6,7 @@ import { HttpApiOperation } from "./HttpApiOperation";
 export class CreateHttpApiOperationRequest extends $dara.Model {
   /**
    * @remarks
-   * The operation definitions.
+   * The list of operation definitions.
    */
   operations?: HttpApiOperation[];
   static names(): { [key: string]: string } {

package/src/models/CreateHttpApiOperationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpApiOperationResponseBodyDataOperations extends $dara.Model {
   /**
    * @remarks
-   * Operation ID.
+   * The operation ID.
    * 
    * @example
    * op-xxx
@@ -35,7 +35,7 @@ export class CreateHttpApiOperationResponseBodyDataOperations extends $dara.Mode
 export class CreateHttpApiOperationResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * Operation information.
+   * The operation information.
    */
   operations?: CreateHttpApiOperationResponseBodyDataOperations[];
   static names(): { [key: string]: string } {
@@ -65,7 +65,7 @@ export class CreateHttpApiOperationResponseBodyData extends $dara.Model {
 export class CreateHttpApiOperationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -73,12 +73,12 @@ export class CreateHttpApiOperationResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Operation information.
+   * The operation information.
    */
   data?: CreateHttpApiOperationResponseBodyData;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -86,7 +86,7 @@ export class CreateHttpApiOperationResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 393E2630-DBE7-5221-AB35-9E740675491A

package/src/models/CreateHttpApiRequest.ts

@@ -24,7 +24,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * The Ingress class to listen on.
+   * The Ingress Class to listen on.
    * 
    * @example
    * mse
@@ -32,7 +32,7 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
   ingressClass?: string;
   /**
    * @remarks
-   * Specifies whether to update the address in the Ingress status.
+   * Specifies whether to update the address in the Ingress Status.
    * 
    * @example
    * false
@@ -90,23 +90,22 @@ export class CreateHttpApiRequestIngressConfig extends $dara.Model {
 export class CreateHttpApiRequest extends $dara.Model {
   /**
    * @remarks
-   * The list of protocols supported by the agent.
+   * The list of protocols supported by the agent. This parameter is required when type is set to Agent. This parameter is not required for other types.
    */
   agentProtocols?: string[];
   /**
    * @remarks
-   * The AI API protocols. The following protocols are supported:
-   * - OpenAI/v1.
+   * The AI API protocols. This parameter is required when type is set to LLM, and only one protocol can be specified. This parameter is required when type is set to Ai, and multiple protocols can be specified. This parameter is not required for other types.
    */
   aiProtocols?: string[];
   /**
    * @remarks
-   * The authentication configuration.
+   * The authentication configuration. This parameter is required when enableAuth is set to true.
    */
   authConfig?: AuthConfig;
   /**
    * @remarks
-   * The base path of the API. The value must start with a forward slash (/).
+   * The API base path. The path must start with a forward slash (/), cannot exceed 256 bytes in length, and cannot contain spaces. This parameter is required when type is set to Rest. When type is set to LLM, Ai, or Agent, this parameter is optional and defaults to /.
    * 
    * @example
    * /v1
@@ -122,7 +121,7 @@ export class CreateHttpApiRequest extends $dara.Model {
   belongGatewayId?: string;
   /**
    * @remarks
-   * The API deployment configurations. Currently, only AI APIs support deployment configurations, and only a single deployment configuration can be specified.
+   * The API deployment configurations. This parameter is required when type is set to LLM or Ai, and only one deployment configuration can be specified. This parameter is not validated at the request level for other types.
    */
   deployConfigs?: HttpApiDeployConfig[];
   /**
@@ -130,7 +129,7 @@ export class CreateHttpApiRequest extends $dara.Model {
    * The API description.
    * 
    * @example
-   * 测试专用API。
+   * Test API for integration
    */
   description?: string;
   /**
@@ -145,7 +144,7 @@ export class CreateHttpApiRequest extends $dara.Model {
   dryRun?: boolean;
   /**
    * @remarks
-   * Specifies whether to enable authentication.
+   * Specifies whether to enable authentication. This parameter is validated when type is set to LLM, Ai, or Agent. This parameter is not validated at the request level when type is set to Rest.
    * 
    * @example
    * true
@@ -161,15 +160,15 @@ export class CreateHttpApiRequest extends $dara.Model {
   firstByteTimeout?: number;
   /**
    * @remarks
-   * The HTTP Ingress API configuration.
+   * The HTTP Ingress API configuration. This parameter is required and cannot be nil when type is set to HttpIngress. This parameter is not required for other types.
    */
   ingressConfig?: CreateHttpApiRequestIngressConfig;
   /**
    * @remarks
-   * The model category.
+   * The model category. This parameter is optional when type is set to LLM or Ai. This parameter is not required for other types.
    * 
    * @example
-   * llm/text-to-image
+   * Text
    */
   modelCategory?: string;
   /**
@@ -205,7 +204,7 @@ export class CreateHttpApiRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The conflict merge strategy for the import.
+   * The conflict merge strategy for import.
    * 
    * @example
    * ExistFirst
@@ -219,7 +218,9 @@ export class CreateHttpApiRequest extends $dara.Model {
    * - WebSocket
    * - HttpIngress
    * - LLM
-   * - Agent.
+   * - Agent
+   * 
+   * This parameter is required.
    * 
    * @example
    * Http

package/src/models/CreateHttpApiRouteRequest.ts

@@ -81,10 +81,10 @@ export class CreateHttpApiRouteRequestBackendConfig extends $dara.Model {
   /**
    * @remarks
    * The backend service scenario. Valid values:
-   * - SingleService: Single service.
-   * - MultiServiceByRatio: Multiple services with ratio-based canary release.
-   * - Mock: Mock service.
-   * - Redirect: Redirect service.
+   * - SingleService: single service.
+   * - MultiServiceByRatio: multiple services with ratio-based canary release.
+   * - Mock: mock service.
+   * - Redirect: redirect service.
    * 
    * @example
    * SingleService

package/src/models/CreateMcpServerRequest.ts

@@ -65,8 +65,8 @@ export class CreateMcpServerRequestBackendConfigServices extends $dara.Model {
   /**
    * @remarks
    * The service protocol. Valid values:
-   * - HTTP.
-   * - HTTPS.
+   * - HTTP
+   * - HTTPS
    * 
    * @example
    * HTTP
@@ -368,7 +368,7 @@ export class CreateMcpServerRequestMcpServerConfig extends $dara.Model {
 export class CreateMcpServerRequest extends $dara.Model {
   /**
    * @remarks
-   * The list of assembled sources. This parameter is required when type is set to AssemblyMCP.
+   * The list of assembly sources. This parameter is required when type is set to AssemblyMCP.
    */
   assembledSources?: CreateMcpServerRequestAssembledSources[];
   /**
@@ -380,11 +380,11 @@ export class CreateMcpServerRequest extends $dara.Model {
    * @remarks
    * The creation source type. Valid values:
    * 
-   * ApiGatewayHttpToMCP: gateway-managed HTTP-to-MCP conversion.
-   * ApiGatewayProxyMcpHosting: gateway-managed direct MCP proxy.
-   * ApiGatewayAssembly: gateway MCP assembly.
-   * NacosHttpToMCP: gateway-managed Nacos-synced HTTP-to-MCP conversion.
-   * NacosMcpHosting: gateway-managed Nacos-synced direct MCP proxy.
+   * - ApiGatewayHttpToMCP: gateway-managed HTTP-to-MCP conversion
+   * - ApiGatewayProxyMcpHosting: gateway-managed direct MCP proxy
+   * - ApiGatewayAssembly: gateway MCP assembly
+   * - NacosHttpToMCP: gateway-managed Nacos-synced HTTP-to-MCP conversion
+   * - NacosMcpHosting: gateway-managed Nacos-synced direct MCP proxy
    * 
    * @example
    * ApiGatewayMcpHosting
@@ -423,7 +423,7 @@ export class CreateMcpServerRequest extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The canary release route configurations.
+   * The canary release routing configurations.
    */
   grayMcpServerConfigs?: CreateMcpServerRequestGrayMcpServerConfigs[];
   /**
@@ -466,7 +466,7 @@ export class CreateMcpServerRequest extends $dara.Model {
    * @remarks
    * The type. Valid values:
    * 
-   * RealMCP: standard MCP service.
+   * - RealMCP: standard MCP service
    * 
    * This parameter is required.
    * 

package/src/models/CreatePluginAttachmentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePluginAttachmentResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The plug-in attachment ID.
+   * The plug-in mount ID.
    * 
    * @example
    * pa-cvs7jpmm1hkgihaqv4a0

package/src/models/CreatePluginClassRequest.ts

@@ -0,0 +1,138 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreatePluginClassRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The alias of the plugin.
+   * 
+   * @example
+   * My Wasm Plugin
+   */
+  alias?: string;
+  /**
+   * @remarks
+   * The description of the plugin.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Custom authentication plugin for validating tokens in request headers
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The execution priority of the plugin.
+   * 
+   * @example
+   * 100
+   */
+  executePriority?: number;
+  /**
+   * @remarks
+   * The execution stage of the plugin.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * AUTHN
+   */
+  executeStage?: string;
+  /**
+   * @remarks
+   * The name of the plugin class.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * my-wasm-plugin
+   */
+  name?: string;
+  /**
+   * @remarks
+   * The minimum gateway version that the plugin is compatible with.
+   * 
+   * @example
+   * 2.0.0
+   */
+  supportedMinGatewayVersion?: string;
+  /**
+   * @remarks
+   * The version number of the plugin.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1.0.0
+   */
+  version?: string;
+  /**
+   * @remarks
+   * The description of the current version.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Initial version with basic token validation
+   */
+  versionDescription?: string;
+  /**
+   * @remarks
+   * The programming language used to develop the WASM plugin.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Rust
+   */
+  wasmLanguage?: string;
+  /**
+   * @remarks
+   * The download URL of the WASM plugin binary file.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * https://example.com/plugins/my-plugin.wasm
+   */
+  wasmUrl?: string;
+  static names(): { [key: string]: string } {
+    return {
+      alias: 'alias',
+      description: 'description',
+      executePriority: 'executePriority',
+      executeStage: 'executeStage',
+      name: 'name',
+      supportedMinGatewayVersion: 'supportedMinGatewayVersion',
+      version: 'version',
+      versionDescription: 'versionDescription',
+      wasmLanguage: 'wasmLanguage',
+      wasmUrl: 'wasmUrl',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      alias: 'string',
+      description: 'string',
+      executePriority: 'number',
+      executeStage: 'string',
+      name: 'string',
+      supportedMinGatewayVersion: 'string',
+      version: 'string',
+      versionDescription: 'string',
+      wasmLanguage: 'string',
+      wasmUrl: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreatePluginClassResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreatePluginClassResponseBody } from "./CreatePluginClassResponseBody";
+
+
+export class CreatePluginClassResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreatePluginClassResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreatePluginClassResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreatePluginClassResponseBody.ts

@@ -0,0 +1,94 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreatePluginClassResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The plugin class ID.
+   * 
+   * @example
+   * pls-csqmjxxxxxxx
+   */
+  pluginClassId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      pluginClassId: 'pluginClassId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      pluginClassId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreatePluginClassResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response status code.
+   * 
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The response data.
+   */
+  data?: CreatePluginClassResponseBodyData;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * 880F8DC9-1CD9-5A83-AA54-AD2D3B7D2466
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      message: 'message',
+      requestId: 'requestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: CreatePluginClassResponseBodyData,
+      message: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+