airframe-http-codegen
API
Generated with
airframe-http-codegen/wvlet.airframe.http/wvlet.airframe.http.openapi/OpenAPI

OpenAPI

wvlet.airframe.http.openapi.OpenAPI$
See theOpenAPI companion class
object OpenAPI

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

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
OpenAPI.type

Members list

Type members

Classlikes

case class Components(schemas: Option[Map[String, SchemaOrRef]], responses: Option[Map[String, Response]], parameters: Option[Map[String, ParameterOrRef]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Encoding()

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Header()

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object In

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
In.type
sealed trait In

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object cookie.type
object header.type
object path.type
object query.type
case class Info(title: String, version: String, description: Option[String], termsOfService: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class License(name: String, url: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MediaType(schema: SchemaOrRef, encoding: Option[Map[String, Encoding]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class OneOf(oneOf: Seq[SchemaOrRef]) extends Union3[Schema, SchemaRef, OneOf]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Union3[Schema, SchemaRef, OneOf]
trait Union
class Object
trait Matchable
class Any
Show all
case class Parameter(name: String, in: In, description: Option[String], required: Boolean, schema: Option[SchemaOrRef], deprecated: Option[Boolean], allowEmptyValue: Option[Boolean]) extends Union2[Parameter, ParameterRef]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Union2[Parameter, ParameterRef]
trait Union
class Object
trait Matchable
class Any
Show all
case class ParameterRef($ref: String) extends Union2[Parameter, ParameterRef]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Union2[Parameter, ParameterRef]
trait Union
class Object
trait Matchable
class Any
Show all
case class PathItem(summary: String, description: String, operationId: String, parameters: Option[Seq[ParameterOrRef]], requestBody: Option[RequestBody], responses: Map[String, Union2[Response, ResponseRef]], tags: Option[Seq[String]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RequestBody(description: Option[String], content: Map[String, MediaType], required: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Response(description: String, headers: Option[Map[String, Header]], content: Map[String, MediaType]) extends Union2[Response, ResponseRef]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Union2[Response, ResponseRef]
trait Union
class Object
trait Matchable
class Any
Show all
case class ResponseRef($ref: String) extends Union2[Response, ResponseRef]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Union2[Response, ResponseRef]
trait Union
class Object
trait Matchable
class Any
Show all
case class Schema(`type`: String, default: Option[String], format: Option[String], description: Option[String], required: Option[Seq[String]], properties: Option[Map[String, SchemaOrRef]], additionalProperties: Option[SchemaOrRef], items: Option[SchemaOrRef], nullable: Option[Boolean], enum: Option[Seq[String]]) extends Union3[Schema, SchemaRef, OneOf]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Union3[Schema, SchemaRef, OneOf]
trait Union
class Object
trait Matchable
class Any
Show all
case class SchemaRef($ref: String) extends Union3[Schema, SchemaRef, OneOf]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Union3[Schema, SchemaRef, OneOf]
trait Union
class Object
trait Matchable
class Any
Show all

Types

type SchemaOrRef = Union3[Schema, SchemaRef, OneOf]

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def APL2: License
def ofRouter(router: Router, config: OpenAPIGeneratorConfig): OpenAPI

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

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

Attributes

Returns

OpenAPI model class

def parseJson(json: String): OpenAPI
Generated with