wvlet.airframe.http.openapi.OpenAPI$
See theOpenAPI companion class
object OpenAPI
A subset of Open API objects necessary for describing Airframe RPC interfaces
Attributes
Members list
Concise view
Type members
Classlikes
case class Components(schemas: Option[Map[String, SchemaOrRef]], responses: Option[Map[String, Response]], parameters: Option[Map[String, ParameterOrRef]])
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
object In
case class Info(title: String, version: String, description: Option[String], termsOfService: Option[String])
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
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
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait Unionclass Objecttrait Matchableclass Any
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait Unionclass Objecttrait Matchableclass Any
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
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
case class RequestBody(description: Option[String], content: Map[String, MediaType], required: Boolean)
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
case class Response(description: String, headers: Option[Map[String, Header]], content: Map[String, MediaType]) extends Union2[Response, ResponseRef]
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait Unionclass Objecttrait Matchableclass Any
Attributes
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait Unionclass Objecttrait Matchableclass Any
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]
Types
Inherited types
The names of the product elements
The names of the product elements
Attributes
- Inherited from:
- Mirror
The name of the type
The name of the type
Attributes
- Inherited from:
- Mirror
Value members
Concrete methods
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