OperationAttribute¶

1 min read

Import: import system.webapi;

Read the usage guide for examples and common tasks. This reference lists the public declarations for this part of the library. See Reading API signatures for parameter and result notation.

`OperationAttribute`¶

Describes a route operation in OpenAPI.

public struct OperationAttribute

`summary`¶

Short summary displayed in the API documentation.

public summary: Option<string>

`description`¶

Description displayed in the API documentation.

public description: Option<string>

`tags`¶

Optional tags grouping the operation in the API documentation.

public tags: Option<string>

`status`¶

HTTP response status code.

public status: Option<int>

`deprecated`¶

Whether the operation is marked deprecated in the API description.

public deprecated: Option<bool>

OperationAttribute¶