ktor-openapi-schema/io.ktor.openapi/PathItem

PathItem

@Serializable(with = PathItem.Companion.Serializer::class)

data class PathItem(val summary: String? = null, val description: String? = null, val put: Operation? = null, val post: Operation? = null, val delete: Operation? = null, val options: Operation? = null, val get: Operation? = null, val head: Operation? = null, val patch: Operation? = null, val trace: Operation? = null, val servers: List<Server>? = null, val parameters: List<ReferenceOr<Parameter>>? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Describes the operations, parameters, and servers available for a single API path, as defined by the OpenAPI Specification Path Item Object. This is a container that aggregates the HTTP operations (GET, PUT, POST, DELETE, OPTIONS, HEAD, PATCH, TRACE) and common metadata that apply to the path.

Report a problem

Constructors

PathItem

constructor(summary: String? = null, description: String? = null, put: Operation? = null, post: Operation? = null, delete: Operation? = null, options: Operation? = null, get: Operation? = null, head: Operation? = null, patch: Operation? = null, trace: Operation? = null, servers: List<Server>? = null, parameters: List<ReferenceOr<Parameter>>? = null, extensions: ExtensionProperties? = null)

Types

Builder

class Builder(schemaInference: JsonSchemaInference, defaultContentTypes: List<ContentType>)

Companion

object Companion

Properties

delete

val delete: Operation?

A definition of a DELETE operation on this path.

description

val description: String?

An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.

extensions

open override val extensions: ExtensionProperties?

Specification extensions for this Path Item (keys MUST start with "x-").

get

val get: Operation?

A definition of a GET operation on this path.

head

val head: Operation?

A definition of a HEAD operation on this path.

options

val options: Operation?

A definition of an OPTIONS operation on this path.

parameters

val parameters: List<ReferenceOr<Parameter>>?

A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.

patch

val patch: Operation?

A definition of a PATCH operation on this path.

post

val post: Operation?

A definition of a POST operation on this path.

put

val put: Operation?

A definition of a PUT operation on this path.

servers

val servers: List<Server>?

An alternative server array to service all operations in this path.