final case class Info(title: String, description: Option[Doc], termsOfService: Option[URI], contact: Option[Contact], license: Option[License], version: String) extends Product with Serializable
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.
- title
The title of the API.
- description
A short description of the API.
- termsOfService
A URL to the Terms of Service for the API.
- contact
The contact information for the exposed API.
- license
The license information for the exposed API.
- version
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
- Alphabetic
- By Inheritance
- Info
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Info(title: String, description: Option[Doc], termsOfService: Option[URI], contact: Option[Contact], license: Option[License], version: String)
- title
The title of the API.
- description
A short description of the API.
- termsOfService
A URL to the Terms of Service for the API.
- contact
The contact information for the exposed API.
- license
The license information for the exposed API.
- version
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- val contact: Option[Contact]
- val description: Option[Doc]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val license: Option[License]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val termsOfService: Option[URI]
- val title: String
- val version: String
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])