Operation
data class Operation(val id: String, val summary: String? = null, val description: String? = null, val tags: List<String> = emptyList(), val requestBody: OpenApi.Operation.RequestBody? = null, val parameters: List<OpenApi.Parameter> = emptyList(), val responses: Map<String, OpenApi.Operation.Response>, val security: List<Map<String, List<String>>> = emptyList(), val externalDocs: OpenApi.ExternalDocs? = null, val extensions: Map<String, JsonElement> = emptyMap(), val deprecated: Boolean = false, val servers: List<OpenApi.Server> = emptyList())(source)
Constructors
Link copied to clipboard
constructor(id: String, summary: String? = null, description: String? = null, tags: List<String> = emptyList(), requestBody: OpenApi.Operation.RequestBody? = null, parameters: List<OpenApi.Parameter> = emptyList(), responses: Map<String, OpenApi.Operation.Response>, security: List<Map<String, List<String>>> = emptyList(), externalDocs: OpenApi.ExternalDocs? = null, extensions: Map<String, JsonElement> = emptyMap(), deprecated: Boolean = false, servers: List<OpenApi.Server> = emptyList())
Types
Link copied to clipboard
data class Header(val ref: String? = null, val description: String? = null, val required: Boolean = false, val deprecated: Boolean = false, val allowEmptyValue: Boolean = false, val schema: OpenApi.Components.Schema? = null, val example: JsonElement? = null)
Link copied to clipboard
data class MediaType(val schema: OpenApi.Components.Schema? = null, val examples: JsonElement? = null)
Link copied to clipboard
data class RequestBody(val description: String? = null, val required: Boolean? = false, val content: Map<String, OpenApi.Operation.MediaType>)
Link copied to clipboard
data class Response(val description: String? = null, val headers: Map<String, OpenApi.Operation.Header> = emptyMap(), val content: Map<String, OpenApi.Operation.MediaType> = emptyMap(), val ref: String? = null)