case class RedocUIOptions(pathPrefix: List[String], specName: String, htmlName: String, contextPath: List[String], useRelativePaths: Boolean, redocVersion: String) extends Product with Serializable
- pathPrefix
The path prefix which will be added to the documentation endpoints, as a list of path segments. Defaults to
List("docs")
, so the address of the docs will be./docs
(relative to the context in which the interpreted docs endpoints are attached).- specName
The name of the file, through which the yaml documentation will be served. Defaults to
docs.yaml
.- htmlName
the name of the file, through which the html documentation will be served. Defaults to
index.html
.- contextPath
The context path in which the interpreted documentation endpoints are going to be attached. Only relevant when {{useRelativePaths == false}}. E.g. when context path is
List("api", "v1")
,useRelativePaths = false
, and other parameters are left with default values, the generated full path to the yaml will be/api/v1/docs/docs.yaml
, instead of./docs/docs.yaml
or./docs.yaml
(depending on the referrer's uri). Also used for creating redirects. Defaults toNil
.- useRelativePaths
Should relative paths be used for yaml references and redirects. Defaults to
true
.- redocVersion
Version of Redoc library
- Alphabetic
- By Inheritance
- RedocUIOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new RedocUIOptions(pathPrefix: List[String], specName: String, htmlName: String, contextPath: List[String], useRelativePaths: Boolean, redocVersion: String)
- pathPrefix
The path prefix which will be added to the documentation endpoints, as a list of path segments. Defaults to
List("docs")
, so the address of the docs will be./docs
(relative to the context in which the interpreted docs endpoints are attached).- specName
The name of the file, through which the yaml documentation will be served. Defaults to
docs.yaml
.- htmlName
the name of the file, through which the html documentation will be served. Defaults to
index.html
.- contextPath
The context path in which the interpreted documentation endpoints are going to be attached. Only relevant when {{useRelativePaths == false}}. E.g. when context path is
List("api", "v1")
,useRelativePaths = false
, and other parameters are left with default values, the generated full path to the yaml will be/api/v1/docs/docs.yaml
, instead of./docs/docs.yaml
or./docs.yaml
(depending on the referrer's uri). Also used for creating redirects. Defaults toNil
.- useRelativePaths
Should relative paths be used for yaml references and redirects. Defaults to
true
.- redocVersion
Version of Redoc library
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() @HotSpotIntrinsicCandidate()
- def contextPath(contextPath: List[String]): RedocUIOptions
- val contextPath: List[String]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def htmlName(htmlName: String): RedocUIOptions
- val htmlName: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def pathPrefix(pathPrefix: List[String]): RedocUIOptions
- val pathPrefix: List[String]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def redocVersion(redocVersion: String): RedocUIOptions
- val redocVersion: String
- def specName(specName: String): RedocUIOptions
- val specName: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val useRelativePaths: Boolean
- 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])
- def withAbsolutePaths: RedocUIOptions
- def withRelativePaths: RedocUIOptions
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated