kompendium-oas/io.bkbn.kompendium.oas.path/PathOperation

PathOperation

data class PathOperation( var tags: Set<String> = emptySet(), var summary: String? = null, var description: String? = null, var externalDocs: ExternalDocumentation? = null, var operationId: String? = null, var parameters: List<Parameter>? = null, var requestBody: Request? = null, var responses: Map<Int, Response>? = null, var callbacks: Map<String, PathOperation>? = null, var deprecated: Boolean = false, var security: List<Map<String, List<String>>>? = null, var servers: List<Server>? = null)

Describes a single API operation on a path.

https://spec.openapis.org/oas/v3.1.0#operation-object

Parameters

tags

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

summary

A short summary of what the operation does.

description

A verbose explanation of the operation behavior.

externalDocs

Additional external documentation for this operation.

operationId

Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.

parameters

A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters

requestBody

The request body applicable for this operation.

responses

The list of possible responses as they are returned from executing this operation.

callbacks

A map of possible out-of band callbacks related to the parent operation.

deprecated

Declares this operation to be deprecated.

security

A declaration of which security mechanisms can be used for this operation.

servers

An alternative server array to service this operation.

Constructors

fun PathOperation( tags: Set<String> = emptySet(), summary: String? = null, description: String? = null, externalDocs: ExternalDocumentation? = null, operationId: String? = null, parameters: List<Parameter>? = null, requestBody: Request? = null, responses: Map<Int, Response>? = null, callbacks: Map<String, PathOperation>? = null, deprecated: Boolean = false, security: List<Map<String, List<String>>>? = null, servers: List<Server>? = null)

Properties

var callbacks: Map<String, PathOperation>? = null

var deprecated: Boolean = false

var description: String? = null

var externalDocs: ExternalDocumentation? = null

var operationId: String? = null

var parameters: List<Parameter>? = null

var requestBody: Request? = null

var responses: Map<Int, Response>? = null

var security: List<Map<String, List<String>>>? = null

var servers: List<Server>? = null

var summary: String? = null

var tags: Set<String>