Describes an API endpoint operation.
| Property | Type | Description |
|---|---|---|
| arguments | All arguments provided to this operation. Each argument maps to an HTTP request location (e.g., path, query, header, or body). | |
| authorization | Boolean | Indicates whether this operation requires authorization. If set to false, the client will omit authorization headers. Defaults to true. |
| description | String | A short description of this operation. Used in generated code docstrings; plain text without line breaks is recommended. |
| method | String | The HTTP method associated with this operation (e.g., GET, POST, PUT, DELETE). |
| path | String | The HTTP path associated with this operation. May contain path variables (e.g., /my/path/:year) which map to operation arguments. |
| return | Response | The return type of this operation, which defaults to an HTTP status code of 200. |
| security | An array of OAuth scopes required to access this specific operation. | |
| stability | Integer | Indicates the stability level of this operation: 0 (Deprecated), 1 (Experimental), 2 (Stable), or 3 (Legacy). Defaults to 1 (Experimental). |
| throws | All exceptional states that can occur if the operation fails. Each exception is assigned an HTTP error status code. |