Reference

zio.blocks.openapi.Reference

See theReference companion object

final case class Reference($ref: String, summary: Option[Doc] = ..., description: Option[Doc] = ...)

A simple object to allow referencing other components in the OpenAPI document, internally and externally.

Value parameters

`$$ref`: REQUIRED. The reference identifier. This MUST be in the form of a URI.
description: A description which by default SHOULD override that of the referenced component.
summary: A short summary which by default SHOULD override that of the referenced component.

Attributes

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

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Members list

Value members

Inherited methods

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

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

Attributes

Inherited from:: Product
Source: Product.scala

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns: in the default implementation, an Iterator[Any]
Inherited from:: Product
Source: Product.scala

In this article