About the Operation Parameters

When you select the

Parameters for an operation, Designer displays a list of the input parameters in the REST resource service that corresponds to the operation. For each parameter, Designer displays the following information:

Name, which matches the name of the input parameter in the corresponding service.

Source, which indicates the source of the parameters in the incoming request. The source corresponds to the “in” field for a fixed field in a parameter object as defined by the Swagger specification. A parameter can have one of the following source values:

Designer assigns the parameter a Source value. If an input parameter for a service is a document or document reference, Designer assigns the parameter a source of BODY. You cannot change the source of a parameter set to BODY. For an operation parameter of a REST V2 resource, you cannot change the source if set to BODY or PATH.

Type, which specifies the data type of the parameter. For a mapping of Integration Server data types to Swagger data types, see Mapping Integration Server Data Types to Swagger Data Types.

Description, which provides a description of the parameter. Designer obtains the description from the Comments property for the parameter in the corresponding REST resource service.

Required, which indicates whether or not the parameter is required in the input. Designer obtains this value from the Required property for the parameter in the corresponding REST resource service.

Include in Swagger, which you can select to indicate whether or not to include a parameter in the Swagger document for the REST API descriptor. If you want to exclude an already selected parameter from the Swagger document, clear the checkbox for the parameter under the Include in Swagger column.

Note:
This option is available only for parameters of a REST V2 resource operation.

You can change the name, description, or required values for a parameter by modifying the parameter in the corresponding REST resource service. However, you can only make the following changes to a parameter in a REST API descriptor:

For a REST API descriptor containing REST V2 resource operations, specify whether to include a parameter in the Swagger definition.