Operation
data class Operation(val operationId: String? = null, val tags: List<String>? = null, val summary: String? = null, val description: String? = null, val externalDocs: ExternalDocs? = null, val parameters: List<ReferenceOr<Parameter>>? = null, val requestBody: ReferenceOr<RequestBody>? = null, val callbacks: Map<String, ReferenceOr<Callback>>? = null, val responses: Responses? = null, val deprecated: Boolean? = null, val security: List<Map<String, List<String>>>? = null, val servers: List<Server>? = null, val extensions: ExtensionProperties? = null) : Extensible(source)
Describes a single API operation on a path item as defined by the OpenAPI Specification. Use Operation.Builder or Operation.build to create instances in a type-safe DSL.
Properties correspond to the OpenAPI Operation object.
Constructors
Link copied to clipboard
constructor(operationId: String? = null, tags: List<String>? = null, summary: String? = null, description: String? = null, externalDocs: ExternalDocs? = null, parameters: List<ReferenceOr<Parameter>>? = null, requestBody: ReferenceOr<RequestBody>? = null, callbacks: Map<String, ReferenceOr<Callback>>? = null, responses: Responses? = null, deprecated: Boolean? = null, security: List<Map<String, List<String>>>? = null, servers: List<Server>? = null, extensions: ExtensionProperties? = null)
Types
Link copied to clipboard
class Builder(schemaInference: JsonSchemaInference, defaultContentTypes: List<ContentType>) : JsonSchemaInference
Builder for OpenAPI Operation object
Properties
Link copied to clipboard
Marks the operation as deprecated if true.
Link copied to clipboard
A verbose explanation of the operation behavior.
Link copied to clipboard
Specification-extensions for this operation (keys must start with x-).
Link copied to clipboard
Contains a description and URL to reference external documentation
Link copied to clipboard
Unique string used to identify the operation.
Link copied to clipboard
List of parameters that are applicable for this operation.
Link copied to clipboard
The request body applicable for this operation.