final case class OpenAPI(openapi: String, info: Info, servers: List[Server], paths: Paths, components: Option[Components], security: List[SecurityRequirement], tags: List[Tag], externalDocs: Option[ExternalDoc]) extends OpenAPIBase with Product with Serializable
This is the root document object of the OpenAPI document.
- openapi
This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.
- info
Provides metadata about the API. The metadata MAY be used by tooling as required.
- servers
A List of Server Objects, which provide connectivity information to a target server. If the servers property is empty, the default value would be a Server Object with a url value of /.
- paths
The available paths and operations for the API.
- components
An element to hold various schemas for the specification.
- security
A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ({}) can be included in the List.
- tags
A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools’ logic. Each tag name in the list MUST be unique.
- externalDocs
Additional external documentation.
- Alphabetic
- By Inheritance
- OpenAPI
- Serializable
- Product
- Equals
- OpenAPIBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new OpenAPI(openapi: String, info: Info, servers: List[Server], paths: Paths, components: Option[Components], security: List[SecurityRequirement], tags: List[Tag], externalDocs: Option[ExternalDoc])
- openapi
This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.
- info
Provides metadata about the API. The metadata MAY be used by tooling as required.
- servers
A List of Server Objects, which provide connectivity information to a target server. If the servers property is empty, the default value would be a Server Object with a url value of /.
- paths
The available paths and operations for the API.
- components
An element to hold various schemas for the specification.
- security
A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ({}) can be included in the List.
- tags
A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools’ logic. Each tag name in the list MUST be unique.
- externalDocs
Additional external documentation.
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()
- val components: Option[Components]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val externalDocs: Option[ExternalDoc]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val info: Info
- 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()
- val openapi: String
- val paths: Paths
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val security: List[SecurityRequirement]
- val servers: List[Server]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val tags: List[Tag]
- def toJson: String
- Definition Classes
- OpenAPI → OpenAPIBase
- 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])