Interface IOperation

Flag for indicating this operation is deprecated.

A verbose explanation of the operation behavior.

Unique string used to identify the operation.

List of parameters that are applicable for this operation.

The request body applicable for this operation.

The list of possible responses as they are returned from executing this operation. Its key is the HTTP status code, and the value is the metadata of the response in the HTTP status code.

List of securities and their scopes that are required for execution.

When this property be configured, the Restful API operation requires the matched security value for execution. Its key means security key matched with OpenApi.IDocument.security.

The value means scopes required for the security key when the security type is OpenApi.ISecurityScheme.IOAuth2. Otherwise the target security type is not OpenApi.ISecurityScheme.IOAuth2, the value would be empty array.

A list of servers providing this API operation.

A short summary of what the operation does.

Tags for API documentation control.

Accessor of the operation.

If you configure this property, the assigned value would be used as IHttpMigrateRoute.accessor. Also, it also can be used as the IHttpLlmFunction.name by joininig with . character in the LLM function calling application.

Note that, the x-samchon-accessor value must be unique in the entire OpenAPI document operations. If there're duplicated x-samchon-accessor values, IHttpMigrateRoute.accessor will ignore every duplicated x-samchon-accessor values and generate the IHttpMigrateRoute.accessor by itself.

Controller of the operation.

If you configure this property, the assigned value would be utilized as the controller name in the OpenAPI generator library like @nestia/editor and @nestia/migrate.

Also, if x-samchon-accessor has been configured, its last element would be used as the controller method (function) name. Of course, the OpenAPI document generator @nestia/sdk fills both of them.

Flag for indicating this operation is human-only.

If this property value is true, HttpLlm.application function will not convert this operation schema into the LLM function calling schema that is represented by the IHttpLlmFunction interface.