ExternalDoc

zio.http.endpoint.openapi.OpenAPI.ExternalDoc
final case class ExternalDoc(description: Option[Doc], url: URI)

Allows referencing an external resource for extended documentation.

Value parameters

description

A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.

url

The URL for the target documentation.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product