Info

zio.http.api.openapi.OpenAPI$.Info
final case class Info(title: String, description: Doc, termsOfService: URI, contact: Option[Contact], license: Option[License], version: String)

The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.

Attributes

contact

The contact information for the exposed API.

description

A short description of the API.

license

The license information for the exposed API.

termsOfService

A URL to the Terms of Service for the API.

title

The title of the API.

version

The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).

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

Members list

Concise view

Value members

Concrete methods

override def toJson: String

Attributes

Definition Classes
OpenAPIBase

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product