automorph.schema.OpenApi$
See theOpenApi companion class
object OpenApi
Attributes
Members list
Type members
Inherited types
The names of the product elements
The name of the type
Value members
Concrete methods
def [Response]({ valcontent$2:Some[Map[String,MediaType]]=Some.apply[Map[String,MediaType]](Map.apply[String,MediaType](ArrowAssoc[String](contentType).->[MediaType](errorMediaType))) valheaders$1:Option[Map[String,Header]]@uncheckedVariance=Response.$lessinit$greater$default$2 vallinks$1:Option[Map[String,Link]]@uncheckedVariance=Response.$lessinit$greater$default$4 val$2$:Option[String]@uncheckedVariance=Response.$lessinit$greater$default$5 Response.apply(description="Failedfunctioncallerrordetails",headers$1,content=content$2,links$1,$2$) }),ArrowAssoc[String](httpStatusCodeOk).->[Response]({ valcontent$3:Some[Map[String,MediaType]]=Some.apply[Map[String,MediaType]](Map.apply[String,MediaType](ArrowAssoc[String](contentType).->[MediaType](resultMediaType))) valheaders$2:Option[Map[String,Header]]@uncheckedVariance=Response.$lessinit$greater$default$2 vallinks$2:Option[Map[String,Link]]@uncheckedVariance=Response.$lessinit$greater$default$4 val$3$:Option[String]@uncheckedVariance=Response.$lessinit$greater$default$5 Response.apply(description="Succesfulfunctioncallresultvalue",headers$2,content=content$3,links$2,$3$) })) valoperation:Operation={ valrequestBody$1:Some[RequestBody]=Some.apply[RequestBody](requestBody) valtags$1:Option[List[String]]@uncheckedVariance=Operation.$lessinit$greater$default$1 valsummary$1:Option[String]@uncheckedVariance=Operation.$lessinit$greater$default$2 valdescription$2:Option[String]@uncheckedVariance=Operation.$lessinit$greater$default$3 valexternalDocs$1:Option[ExternalDocumentation]@uncheckedVariance=Operation.$lessinit$greater$default$4 valoperationId$1:Option[String]@uncheckedVariance=Operation.$lessinit$greater$default$5 valparameters$1:Option[List[Parameter]]@uncheckedVariance=Operation.$lessinit$greater$default$6 valcallbacks$1:Option[Map[String,Callback]]@uncheckedVariance=Operation.$lessinit$greater$default$9 valdeprecated$1:Option[Boolean]@uncheckedVariance=Operation.$lessinit$greater$default$10 valsecurity$1:Option[List[SecurityRequirement]]@uncheckedVariance=Operation.$lessinit$greater$default$11 valservers$1:Option[List[Server]]@uncheckedVariance=Operation.$lessinit$greater$default$12 Operation.apply(tags$1,summary$1,description$2,externalDocs$1,operationId$1,parameters$1,requestBody=requestBody$1,responses=responses,callbacks$1,deprecated$1,security$1,servers$1) } valsummary:Option[String]=function.documentation.flatMap[String](((_$1:String)=>refArrayOps[String](augmentString(_$1).split('\n')).find(((`x$1₂`:String)=>`x$1₂`match{ casescaladocMarkup(_:_*)=> true case_=> false })).map[String](((_$2:String)=>_$2.trim())))) valpathItem:PathItem={ valpost$1:Some[Operation]=Some.apply[Operation](operation) val$4$:Option[String]@uncheckedVariance=PathItem.$lessinit$greater$default$1 valget$1:Option[Operation]@uncheckedVariance=PathItem.$lessinit$greater$default$4 valput$1:Option[Operation]@uncheckedVariance=PathItem.$lessinit$greater$default$5 valdelete$1:Option[Operation]@uncheckedVariance=PathItem.$lessinit$greater$default$7 valoptions$1:Option[Operation]@uncheckedVariance=PathItem.$lessinit$greater$default$8 valhead$1:Option[Operation]@uncheckedVariance=PathItem.$lessinit$greater$default$9 valpatch$1:Option[Operation]@uncheckedVariance=PathItem.$lessinit$greater$default$10 valtrace$1:Option[Operation]@uncheckedVariance=PathItem.$lessinit$greater$default$11 valservers$2:Option[List[Server]]@uncheckedVariance=PathItem.$lessinit$greater$default$12 valparameters$2:Option[List[Parameter]]@uncheckedVariance=PathItem.$lessinit$greater$default$13 PathItem.apply($4$,summary=summary,description=function.documentation,get$1,put$1,post=post$1,delete$1,options$1,head$1,patch$1,trace$1,servers$2,parameters$2) } ArrowAssoc[String](function.name).->[PathItem](pathItem) })).toMap[String,PathItem](refl[Tuple2[String,PathItem]]) valinfo:Info=Info.apply(title=defaultTitle,Info.$lessinit$greater$default$2,Info.$lessinit$greater$default$3,Info.$lessinit$greater$default$4,Info.$lessinit$greater$default$5,Info.$lessinit$greater$default$6,version=defaultVersion) valpaths$1:Some[Map[String,PathItem]]=Some.apply[Map[String,PathItem]](paths) valopenapi$1:String@uncheckedVariance=OpenApi.$lessinit$greater$default$1 valjsonSchemaDialect$1:Option[String]@uncheckedVariance=OpenApi.$lessinit$greater$default$3 valservers$3:Option[List[Server]]@uncheckedVariance=OpenApi.$lessinit$greater$default$4 valwebhooks$1:Option[Map[String,PathItem]]@uncheckedVariance=OpenApi.$lessinit$greater$default$6 valcomponents$1:Option[Components]@uncheckedVariance=OpenApi.$lessinit$greater$default$7 valsecurity$2:Option[List[SecurityRequirement]]@uncheckedVariance=OpenApi.$lessinit$greater$default$8 valtags$2:Option[List[Tag]]@uncheckedVariance=OpenApi.$lessinit$greater$default$9 valexternalDocs$2:Option[ExternalDocumentation]@uncheckedVariance=OpenApi.$lessinit$greater$default$10 OpenApi.apply(openapi$1,info=info,jsonSchemaDialect$1,servers$3,paths=paths$1,webhooks$1,components$1,security$2,tags$2,externalDocs$2) }" t="n"class="documentableName ">apply(functionSchemas: Iterable[(RpcFunction, RpcSchema)]): OpenApi
Generates OpenAPI schema for given RPC functions.
Generates OpenAPI schema for given RPC functions.
Value parameters
- functionSchemas
-
RPC function schemas
Attributes
- Returns
-
OpenAPI schema
Concrete fields
Result value name.
Result value name.
Attributes
In this article