Skip to content

OperationProps

Properties for defining a Operation.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-operation

Initializer

import { OperationProps } from '@alicloud/ros-cdk-apig'
const operationProps: OperationProps = { ... }

Properties

Name Type Description
httpApiId string | @alicloud/ros-cdk-core.IResolvable Property httpApiId: The HTTP API ID to which the interface belongs.
method string | @alicloud/ros-cdk-core.IResolvable Property method: The method of http protocol.
operationName string | @alicloud/ros-cdk-core.IResolvable Property operationName: The name of the operation.
path string | @alicloud/ros-cdk-core.IResolvable Property path: The interface path of the operation.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the operation.
mock @alicloud/ros-cdk-core.IResolvable | MockProperty Property mock: Mock configuration.

httpApiIdRequired

public readonly httpApiId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property httpApiId: The HTTP API ID to which the interface belongs.


methodRequired

public readonly method: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property method: The method of http protocol.


operationNameRequired

public readonly operationName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property operationName: The name of the operation.


pathRequired

public readonly path: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property path: The interface path of the operation.


descriptionOptional

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the operation.


mockOptional

public readonly mock: IResolvable | MockProperty;

Property mock: Mock configuration.