Packages

object OpenAPI extends Serializable

A subset of Open API objects necessary for describing Airframe RPC interfaces

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpenAPI
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class Components(schemas: Option[Map[String, SchemaOrRef]] = None, responses: Option[Map[String, Response]] = None, parameters: Option[Map[String, ParameterOrRef]] = None) extends Product with Serializable
  2. case class Encoding() extends Product with Serializable
  3. case class Header() extends Product with Serializable
  4. sealed trait In extends AnyRef
  5. case class Info(title: String, version: String, description: Option[String] = None, termsOfService: Option[String] = None) extends Product with Serializable
  6. case class License(name: String, url: Option[String] = None) extends Product with Serializable
  7. case class MediaType(schema: SchemaOrRef, encoding: Option[Map[String, Encoding]] = None) extends Product with Serializable
  8. case class OneOf(oneOf: Seq[SchemaOrRef]) extends Union3[Schema, SchemaRef, OneOf] with Product with Serializable
  9. case class Parameter(name: String, in: In, description: Option[String] = None, required: Boolean = false, schema: Option[SchemaOrRef] = None, deprecated: Option[Boolean] = None, allowEmptyValue: Option[Boolean] = None) extends Union2[Parameter, ParameterRef] with Product with Serializable
  10. type ParameterOrRef = Union2[Parameter, ParameterRef]
  11. case class ParameterRef($ref: String) extends Union2[Parameter, ParameterRef] with Product with Serializable
  12. case class PathItem(summary: String, description: String, operationId: String, parameters: Option[Seq[ParameterOrRef]] = None, requestBody: Option[RequestBody] = None, responses: Map[String, Union2[Response, ResponseRef]], tags: Option[Seq[String]] = None) extends Product with Serializable
  13. case class RequestBody(description: Option[String] = None, content: Map[String, MediaType], required: Boolean = false) extends Product with Serializable
  14. case class Response(description: String, headers: Option[Map[String, Header]] = None, content: Map[String, MediaType] = Map.empty) extends Union2[Response, ResponseRef] with Product with Serializable
  15. case class ResponseRef($ref: String) extends Union2[Response, ResponseRef] with Product with Serializable
  16. case class Schema(type: String, default: Option[String] = None, format: Option[String] = None, description: Option[String] = None, required: Option[Seq[String]] = None, properties: Option[Map[String, SchemaOrRef]] = None, additionalProperties: Option[SchemaOrRef] = None, items: Option[SchemaOrRef] = None, nullable: Option[Boolean] = None, enum: Option[Seq[String]] = None) extends Union3[Schema, SchemaRef, OneOf] with Product with Serializable
  17. type SchemaOrRef = Union3[Schema, SchemaRef, OneOf]
  18. case class SchemaRef($ref: String) extends Union3[Schema, SchemaRef, OneOf] with Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def APL2: License
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. def ofRouter(router: Router, config: OpenAPIGeneratorConfig = OpenAPIGeneratorConfig()): OpenAPI

    Generate Open API model class from Airframe HTTP/RPC Router definition

    Generate Open API model class from Airframe HTTP/RPC Router definition

    returns

    OpenAPI model class

  16. def parseJson(json: String): OpenAPI
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. object In

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped