Operation

zio.blocks.openapi.Operation

See theOperation companion object

final case class Operation(responses: Responses = ..., tags: Chunk[String] = ..., summary: Option[Doc] = ..., description: Option[Doc] = ..., externalDocs: Option[ExternalDocumentation] = ..., operationId: Option[String] = ..., parameters: Chunk[ReferenceOr[Parameter]] = ..., requestBody: Option[ReferenceOr[RequestBody]] = ..., callbacks: ChunkMap[String, ReferenceOr[Callback]] = ..., deprecated: Boolean = ..., security: Chunk[SecurityRequirement] = ..., servers: Chunk[Server] = ..., extensions: ChunkMap[String, Json] = ...)

Describes a single API operation on a path.

Value parameters

callbacks: A map of possible out-of band callbacks related to the parent operation.
deprecated: Declares this operation to be deprecated.
description: A verbose explanation of the operation behavior.
extensions: Extension fields starting with x-.
externalDocs: Additional external documentation for this operation.
operationId: Unique string used to identify the operation.
parameters: A list of parameters that are applicable for this operation.
requestBody: The request body applicable for this operation.
responses: REQUIRED. The list of possible responses as they are returned from executing this operation.
security: A declaration of which security mechanisms can be used for this operation.
servers: An alternative server array to service this operation.
summary: A short summary of what the operation does.
tags: A list of tags for API documentation control.

Companion: object
Source: OpenAPI.scala
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An iterator over the names of all the elements of this product.

An iterator over all the elements of this product.

In this article